Completed
Push — update/json-endpoints-class ( a5fa74 )
by
unknown
18:11 queued 04:35
created

class.json-api-endpoints.php (39 issues)

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

1
<?php
2
3
require_once( dirname( __FILE__ ) . '/json-api-config.php' );
4
require_once( dirname( __FILE__ ) . '/sal/class.json-api-links.php' );
5
require_once( dirname( __FILE__ ) . '/sal/class.json-api-metadata.php' );
6
require_once( dirname( __FILE__ ) . '/sal/class.json-api-date.php' );
7
8
// Endpoint
9
abstract class WPCOM_JSON_API_Endpoint {
10
	// The API Object
11
	public $api;
12
13
	// The link-generating utility class
14
	public $links;
15
16
	public $pass_wpcom_user_details = false;
17
18
	// One liner.
19
	public $description;
20
21
	// Object Grouping For Documentation (Users, Posts, Comments)
22
	public $group;
23
24
	// Stats extra value to bump
25
	public $stat;
26
27
	// HTTP Method
28
	public $method = 'GET';
29
30
	// Minimum version of the api for which to serve this endpoint
31
	public $min_version = '0';
32
33
	// Maximum version of the api for which to serve this endpoint
34
	public $max_version = WPCOM_JSON_API__CURRENT_VERSION;
35
36
	// Path at which to serve this endpoint: sprintf() format.
37
	public $path = '';
38
39
	// Identifiers to fill sprintf() formatted $path
40
	public $path_labels = array();
41
42
	// Accepted query parameters
43
	public $query = array(
44
		// Parameter name
45
		'context' => array(
46
			// Default value => description
47
			'display' => 'Formats the output as HTML for display.  Shortcodes are parsed, paragraph tags are added, etc..',
48
			// Other possible values => description
49
			'edit'    => 'Formats the output for editing.  Shortcodes are left unparsed, significant whitespace is kept, etc..',
50
		),
51
		'http_envelope' => array(
52
			'false' => '',
53
			'true'  => 'Some environments (like in-browser JavaScript or Flash) block or divert responses with a non-200 HTTP status code.  Setting this parameter will force the HTTP status code to always be 200.  The JSON response is wrapped in an "envelope" containing the "real" HTTP status code and headers.',
54
		),
55
		'pretty' => array(
56
			'false' => '',
57
			'true'  => 'Output pretty JSON',
58
		),
59
		'meta' => "(string) Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes",
60
		'fields' => '(string) Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title',
61
		// Parameter name => description (default value is empty)
62
		'callback' => '(string) An optional JSONP callback function.',
63
	);
64
65
	// Response format
66
	public $response_format = array();
67
68
	// Request format
69
	public $request_format = array();
70
71
	// Is this endpoint still in testing phase?  If so, not available to the public.
72
	public $in_testing = false;
73
74
	// Is this endpoint still allowed if the site in question is flagged?
75
	public $allowed_if_flagged = false;
76
77
	// Is this endpoint allowed if the site is red flagged?
78
	public $allowed_if_red_flagged = false;
79
80
	// Is this endpoint allowed if the site is deleted?
81
	public $allowed_if_deleted = false;
82
83
	/**
84
	 * @var string Version of the API
85
	 */
86
	public $version = '';
87
88
	/**
89
	 * @var string Example request to make
90
	 */
91
	public $example_request = '';
92
93
	/**
94
	 * @var string Example request data (for POST methods)
95
	 */
96
	public $example_request_data = '';
97
98
	/**
99
	 * @var string Example response from $example_request
100
	 */
101
	public $example_response = '';
102
103
	/**
104
	 * @var bool Set to true if the endpoint implements its own filtering instead of the standard `fields` query method
105
	 */
106
	public $custom_fields_filtering = false;
107
108
	/**
109
	 * @var bool Set to true if the endpoint accepts all cross origin requests. You probably should not set this flag.
110
	 */
111
	public $allow_cross_origin_request = false;
112
113
	/**
114
	 * @var bool Set to true if the endpoint can recieve unauthorized POST requests.
115
	 */
116
	public $allow_unauthorized_request = false;
117
118
	/**
119
	 * @var bool Set to true if the endpoint should accept site based (not user based) authentication.
120
	 */
121
	public $allow_jetpack_site_auth = false;
122
123
	/**
124
	 * @var bool Set to true if the endpoint should accept auth from an upload token.
125
	 */
126
	public $allow_upload_token_auth = false;
127
128
	function __construct( $args ) {
129
		$defaults = array(
130
			'in_testing'           => false,
131
			'allowed_if_flagged'   => false,
132
			'allowed_if_red_flagged' => false,
133
			'allowed_if_deleted'	=> false,
134
			'description'          => '',
135
			'group'	               => '',
136
			'method'               => 'GET',
137
			'path'                 => '/',
138
			'min_version'          => '0',
139
			'max_version'          => WPCOM_JSON_API__CURRENT_VERSION,
140
			'force'	               => '',
141
			'deprecated'           => false,
142
			'new_version'          => WPCOM_JSON_API__CURRENT_VERSION,
143
			'jp_disabled'          => false,
144
			'path_labels'          => array(),
145
			'request_format'       => array(),
146
			'response_format'      => array(),
147
			'query_parameters'     => array(),
148
			'version'              => 'v1',
149
			'example_request'      => '',
150
			'example_request_data' => '',
151
			'example_response'     => '',
152
			'required_scope'       => '',
153
			'pass_wpcom_user_details' => false,
154
			'custom_fields_filtering' => false,
155
			'allow_cross_origin_request' => false,
156
			'allow_unauthorized_request' => false,
157
			'allow_jetpack_site_auth'    => false,
158
			'allow_upload_token_auth'    => false,
159
		);
160
161
		$args = wp_parse_args( $args, $defaults );
162
163
		$this->in_testing  = $args['in_testing'];
0 ignored issues
show
Equals sign not aligned correctly; expected 1 space but found 2 spaces

This check looks for improperly formatted assignments.

Every assignment must have exactly one space before and one space after the equals operator.

To illustrate:

$a = "a";
$ab = "ab";
$abc = "abc";

will have no issues, while

$a   = "a";
$ab  = "ab";
$abc = "abc";

will report issues in lines 1 and 2.

Loading history...
164
165
		$this->allowed_if_flagged = $args['allowed_if_flagged'];
166
		$this->allowed_if_red_flagged = $args['allowed_if_red_flagged'];
167
		$this->allowed_if_deleted = $args['allowed_if_deleted'];
168
169
		$this->description = $args['description'];
170
		$this->group       = $args['group'];
171
		$this->stat        = $args['stat'];
172
		$this->force	   = $args['force'];
0 ignored issues
show
The property force does not exist. Did you maybe forget to declare it?

In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code:

class MyClass { }

$x = new MyClass();
$x->foo = true;

Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion:

class MyClass {
    public $foo;
}

$x = new MyClass();
$x->foo = true;
Loading history...
173
		$this->jp_disabled = $args['jp_disabled'];
0 ignored issues
show
The property jp_disabled does not exist. Did you maybe forget to declare it?

In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code:

class MyClass { }

$x = new MyClass();
$x->foo = true;

Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion:

class MyClass {
    public $foo;
}

$x = new MyClass();
$x->foo = true;
Loading history...
174
175
		$this->method      = $args['method'];
176
		$this->path        = $args['path'];
177
		$this->path_labels = $args['path_labels'];
178
		$this->min_version = $args['min_version'];
179
		$this->max_version = $args['max_version'];
180
		$this->deprecated  = $args['deprecated'];
0 ignored issues
show
The property deprecated does not exist. Did you maybe forget to declare it?

In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code:

class MyClass { }

$x = new MyClass();
$x->foo = true;

Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion:

class MyClass {
    public $foo;
}

$x = new MyClass();
$x->foo = true;
Loading history...
181
		$this->new_version = $args['new_version'];
0 ignored issues
show
The property new_version does not seem to exist. Did you mean version?

An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name.

If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading.

Loading history...
182
183
		// Ensure max version is not less than min version
184
		if ( version_compare( $this->min_version, $this->max_version, '>' ) ) {
185
			$this->max_version = $this->min_version;
186
		}
187
188
		$this->pass_wpcom_user_details = $args['pass_wpcom_user_details'];
189
		$this->custom_fields_filtering = (bool) $args['custom_fields_filtering'];
190
191
		$this->allow_cross_origin_request = (bool) $args['allow_cross_origin_request'];
192
		$this->allow_unauthorized_request = (bool) $args['allow_unauthorized_request'];
193
		$this->allow_jetpack_site_auth    = (bool) $args['allow_jetpack_site_auth'];
194
		$this->allow_upload_token_auth    = (bool) $args['allow_upload_token_auth'];
195
196
		$this->version     = $args['version'];
0 ignored issues
show
Equals sign not aligned correctly; expected 1 space but found 5 spaces

This check looks for improperly formatted assignments.

Every assignment must have exactly one space before and one space after the equals operator.

To illustrate:

$a = "a";
$ab = "ab";
$abc = "abc";

will have no issues, while

$a   = "a";
$ab  = "ab";
$abc = "abc";

will report issues in lines 1 and 2.

Loading history...
197
198
		$this->required_scope = $args['required_scope'];
0 ignored issues
show
The property required_scope does not exist. Did you maybe forget to declare it?

In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code:

class MyClass { }

$x = new MyClass();
$x->foo = true;

Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion:

class MyClass {
    public $foo;
}

$x = new MyClass();
$x->foo = true;
Loading history...
199
200 View Code Duplication
		if ( $this->request_format ) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $this->request_format of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent.

Consider making the comparison explicit by using empty(..) or ! empty(...) instead.

Loading history...
201
			$this->request_format = array_filter( array_merge( $this->request_format, $args['request_format'] ) );
202
		} else {
203
			$this->request_format = $args['request_format'];
204
		}
205
206 View Code Duplication
		if ( $this->response_format ) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $this->response_format of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent.

Consider making the comparison explicit by using empty(..) or ! empty(...) instead.

Loading history...
207
			$this->response_format = array_filter( array_merge( $this->response_format, $args['response_format'] ) );
208
		} else {
209
			$this->response_format = $args['response_format'];
210
		}
211
212
		if ( false === $args['query_parameters'] ) {
213
			$this->query = array();
214
		} elseif ( is_array( $args['query_parameters'] ) ) {
215
			$this->query = array_filter( array_merge( $this->query, $args['query_parameters'] ) );
216
		}
217
218
		$this->api = WPCOM_JSON_API::init(); // Auto-add to WPCOM_JSON_API
219
		$this->links = WPCOM_JSON_API_Links::getInstance();
220
221
		/** Example Request/Response ******************************************/
222
223
		// Examples for endpoint documentation request
224
		$this->example_request      = $args['example_request'];
225
		$this->example_request_data = $args['example_request_data'];
226
		$this->example_response     = $args['example_response'];
227
228
		$this->api->add( $this );
229
	}
230
231
	// Get all query args.  Prefill with defaults
232
	function query_args( $return_default_values = true, $cast_and_filter = true ) {
233
		$args = array_intersect_key( $this->api->query, $this->query );
234
235
		if ( !$cast_and_filter ) {
236
			return $args;
237
		}
238
239
		return $this->cast_and_filter( $args, $this->query, $return_default_values );
240
	}
241
242
	// Get POST body data
243
	function input( $return_default_values = true, $cast_and_filter = true ) {
244
		$input = trim( $this->api->post_body );
245
		$content_type = $this->api->content_type;
246
		if ( $content_type ) {
247
			list ( $content_type ) = explode( ';', $content_type );
248
		}
249
		$content_type = trim( $content_type );
250
		switch ( $content_type ) {
251
		case 'application/json' :
252
		case 'application/x-javascript' :
253
		case 'text/javascript' :
254
		case 'text/x-javascript' :
255
		case 'text/x-json' :
256
		case 'text/json' :
257
			$return = json_decode( $input, true );
258
259
			if ( function_exists( 'json_last_error' ) ) {
260
				if ( JSON_ERROR_NONE !== json_last_error() ) {
261
					return null;
262
				}
263
			} else {
264
				if ( is_null( $return ) && json_encode( null ) !== $input ) {
265
					return null;
266
				}
267
			}
268
269
			break;
270
		case 'multipart/form-data' :
271
			$return = array_merge( stripslashes_deep( $_POST ), $_FILES );
272
			break;
273
		case 'application/x-www-form-urlencoded' :
274
			//attempt JSON first, since probably a curl command
275
			$return = json_decode( $input, true );
276
277
			if ( is_null( $return ) ) {
278
				wp_parse_str( $input, $return );
279
			}
280
281
			break;
282
		default :
0 ignored issues
show
There must be no space before the colon in a DEFAULT statement

As per the PSR-2 coding standard, there must not be a space in front of the colon in the default statement.

switch ($expr) {
    default : //wrong
        doSomething();
        break;
}

switch ($expr) {
    default: //right
        doSomething();
        break;
}

To learn more about the PSR-2 coding standard, please refer to the PHP-Fig.

Loading history...
283
			wp_parse_str( $input, $return );
0 ignored issues
show
The variable $return seems only to be defined at a later point. Did you maybe move this code here without moving the variable definition?

This error can happen if you refactor code and forget to move the variable initialization.

Let’s take a look at a simple example:

function someFunction() {
    $x = 5;
    echo $x;
}

The above code is perfectly fine. Now imagine that we re-order the statements:

function someFunction() {
    echo $x;
    $x = 5;
}

In that case, $x would be read before it is initialized. This was a very basic example, however the principle is the same for the found issue.

Loading history...
284
			break;
285
		}
286
287
		if ( isset( $this->api->query['force'] )
288
		    && 'secure' === $this->api->query['force']
289
		    && isset( $return['secure_key'] ) ) {
290
			$this->api->post_body = $this->get_secure_body( $return['secure_key'] );
291
			$this->api->query['force'] = false;
292
			return $this->input( $return_default_values, $cast_and_filter );
293
		}
294
295
		if ( $cast_and_filter ) {
296
			$return = $this->cast_and_filter( $return, $this->request_format, $return_default_values );
0 ignored issues
show
The variable $return does not seem to be defined for all execution paths leading up to this point.

If you define a variable conditionally, it can happen that it is not defined for all execution paths.

Let’s take a look at an example:

function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}

In the above example, the variable $x is defined if you pass “foo” or “bar” as argument for $a. However, since the switch statement has no default case statement, if you pass any other value, the variable $x would be undefined.

Available Fixes

  1. Check for existence of the variable explicitly:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        if (isset($x)) { // Make sure it's always set.
            echo $x;
        }
    }
    
  2. Define a default value for the variable:

    function myFunction($a) {
        $x = ''; // Set a default which gets overridden for certain paths.
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        echo $x;
    }
    
  3. Add a value for the missing path:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
    
            // We add support for the missing case.
            default:
                $x = '';
                break;
        }
    
        echo $x;
    }
    
Loading history...
297
		}
298
		return $return;
299
	}
300
301
302
	protected function get_secure_body( $secure_key ) {
303
		$response =  Jetpack_Client::wpcom_json_api_request_as_blog(
304
			sprintf( '/sites/%d/secure-request', Jetpack_Options::get_option('id' ) ),
305
			'1.1',
306
			array( 'method' => 'POST' ),
307
			array( 'secure_key' => $secure_key )
0 ignored issues
show
array('secure_key' => $secure_key) is of type array<string,?,{"secure_key":"?"}>, but the function expects a string|null.

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...
308
		);
309
		if ( 200 !== $response['response']['code'] ) {
310
			return null;
311
		}
312
		return json_decode( $response['body'], true );
313
	}
314
315
	function cast_and_filter( $data, $documentation, $return_default_values = false, $for_output = false ) {
316
		$return_as_object = false;
317
		if ( is_object( $data ) ) {
318
			// @todo this should probably be a deep copy if $data can ever have nested objects
0 ignored issues
show
Coding Style Best Practice introduced by
Comments for TODO tasks are often forgotten in the code; it might be better to use a dedicated issue tracker.
Loading history...
319
			$data = (array) $data;
320
			$return_as_object = true;
321
		} elseif ( !is_array( $data ) ) {
322
			return $data;
323
		}
324
325
		$boolean_arg = array( 'false', 'true' );
326
		$naeloob_arg = array( 'true', 'false' );
327
328
		$return = array();
329
330
		foreach ( $documentation as $key => $description ) {
331
			if ( is_array( $description ) ) {
332
				// String or boolean array keys only
333
				$whitelist = array_keys( $description );
334
335
				if ( $whitelist === $boolean_arg || $whitelist === $naeloob_arg ) {
336
					// Truthiness
337
					if ( isset( $data[$key] ) ) {
338
						$return[$key] = (bool) WPCOM_JSON_API::is_truthy( $data[$key] );
339
					} elseif ( $return_default_values ) {
340
						$return[$key] = $whitelist === $naeloob_arg; // Default to true for naeloob_arg and false for boolean_arg.
341
					}
342
				} elseif ( isset( $data[$key] ) && isset( $description[$data[$key]] ) ) {
343
					// String Key
344
					$return[$key] = (string) $data[$key];
345
				} elseif ( $return_default_values ) {
346
					// Default value
347
					$return[$key] = (string) current( $whitelist );
348
				}
349
350
				continue;
351
			}
352
353
			$types = $this->parse_types( $description );
354
			$type = array_shift( $types );
355
356
			// Explicit default - string and int only for now.  Always set these reguardless of $return_default_values
357
			if ( isset( $type['default'] ) ) {
358
				if ( !isset( $data[$key] ) ) {
359
					$data[$key] = $type['default'];
360
				}
361
			}
362
363
			if ( !isset( $data[$key] ) ) {
364
				continue;
365
			}
366
367
			$this->cast_and_filter_item( $return, $type, $key, $data[$key], $types, $for_output );
368
		}
369
370
		if ( $return_as_object ) {
371
			return (object) $return;
372
		}
373
374
		return $return;
375
	}
376
377
	/**
378
	 * Casts $value according to $type.
379
	 * Handles fallbacks for certain values of $type when $value is not that $type
380
	 * Currently, only handles fallback between string <-> array (two way), from string -> false (one way), and from object -> false (one way),
381
	 * and string -> object (one way)
382
	 *
383
	 * Handles "child types" - array:URL, object:category
384
	 * array:URL means an array of URLs
385
	 * object:category means a hash of categories
386
	 *
387
	 * Handles object typing - object>post means an object of type post
388
	 */
389
	function cast_and_filter_item( &$return, $type, $key, $value, $types = array(), $for_output = false ) {
390
		if ( is_string( $type ) ) {
391
			$type = compact( 'type' );
392
		}
393
394
		switch ( $type['type'] ) {
395
		case 'false' :
396
			$return[$key] = false;
397
			break;
398
		case 'url' :
399
			$return[$key] = (string) esc_url_raw( $value );
400
			break;
401
		case 'string' :
402
			// Fallback string -> array, or for string -> object
403
			if ( is_array( $value ) || is_object( $value ) ) {
404
				if ( !empty( $types[0] ) ) {
405
					$next_type = array_shift( $types );
406
					return $this->cast_and_filter_item( $return, $next_type, $key, $value, $types, $for_output );
407
				}
408
			}
409
410
			// Fallback string -> false
411 View Code Duplication
			if ( !is_string( $value ) ) {
412
				if ( !empty( $types[0] ) && 'false' === $types[0]['type'] ) {
413
					$next_type = array_shift( $types );
414
					return $this->cast_and_filter_item( $return, $next_type, $key, $value, $types, $for_output );
415
				}
416
			}
417
			$return[$key] = (string) $value;
418
			break;
419
		case 'html' :
420
			$return[$key] = (string) $value;
421
			break;
422
		case 'safehtml' :
423
			$return[$key] = wp_kses( (string) $value, wp_kses_allowed_html() );
424
			break;
425
		case 'zip' :
426
		case 'media' :
427
			if ( is_array( $value ) ) {
428
				if ( isset( $value['name'] ) && is_array( $value['name'] ) ) {
429
					// It's a $_FILES array
430
					// Reformat into array of $_FILES items
431
					$files = array();
432
433
					foreach ( $value['name'] as $k => $v ) {
434
						$files[$k] = array();
435
						foreach ( array_keys( $value ) as $file_key ) {
436
							$files[$k][$file_key] = $value[$file_key][$k];
437
						}
438
					}
439
440
					$return[$key] = $files;
441
					break;
442
				}
443
			} else {
0 ignored issues
show
This else statement is empty and can be removed.

This check looks for the else branches of if statements that have no statements or where all statements have been commented out. This may be the result of changes for debugging or the code may simply be obsolete.

These else branches can be removed.

if (rand(1, 6) > 3) {
print "Check failed";
} else {
    //print "Check succeeded";
}

could be turned into

if (rand(1, 6) > 3) {
    print "Check failed";
}

This is much more concise to read.

Loading history...
444
				// no break - treat as 'array'
445
			}
446
			// nobreak
447
		case 'array' :
448
			// Fallback array -> string
449
			if ( is_string( $value ) ) {
450
				if ( !empty( $types[0] ) ) {
451
					$next_type = array_shift( $types );
452
					return $this->cast_and_filter_item( $return, $next_type, $key, $value, $types, $for_output );
453
				}
454
			}
455
456 View Code Duplication
			if ( isset( $type['children'] ) ) {
457
				$children = array();
458
				foreach ( (array) $value as $k => $child ) {
459
					$this->cast_and_filter_item( $children, $type['children'], $k, $child, array(), $for_output );
460
				}
461
				$return[$key] = (array) $children;
462
				break;
463
			}
464
465
			$return[$key] = (array) $value;
466
			break;
467
		case 'iso 8601 datetime' :
468
		case 'datetime' :
469
			// (string)s
470
			$dates = $this->parse_date( (string) $value );
471
			if ( $for_output ) {
472
				$return[$key] = $this->format_date( $dates[1], $dates[0] );
473
			} else {
474
				list( $return[$key], $return["{$key}_gmt"] ) = $dates;
475
			}
476
			break;
477
		case 'float' :
478
			$return[$key] = (float) $value;
479
			break;
480
		case 'int' :
481
		case 'integer' :
482
			$return[$key] = (int) $value;
483
			break;
484
		case 'bool' :
485
		case 'boolean' :
486
			$return[$key] = (bool) WPCOM_JSON_API::is_truthy( $value );
487
			break;
488
		case 'object' :
489
			// Fallback object -> false
490 View Code Duplication
			if ( is_scalar( $value ) || is_null( $value ) ) {
491
				if ( !empty( $types[0] ) && 'false' === $types[0]['type'] ) {
492
					return $this->cast_and_filter_item( $return, 'false', $key, $value, $types, $for_output );
493
				}
494
			}
495
496 View Code Duplication
			if ( isset( $type['children'] ) ) {
497
				$children = array();
498
				foreach ( (array) $value as $k => $child ) {
499
					$this->cast_and_filter_item( $children, $type['children'], $k, $child, array(), $for_output );
500
				}
501
				$return[$key] = (object) $children;
502
				break;
503
			}
504
505
			if ( isset( $type['subtype'] ) ) {
506
				return $this->cast_and_filter_item( $return, $type['subtype'], $key, $value, $types, $for_output );
507
			}
508
509
			$return[$key] = (object) $value;
510
			break;
511
		case 'post' :
512
			$return[$key] = (object) $this->cast_and_filter( $value, $this->post_object_format, false, $for_output );
513
			break;
514
		case 'comment' :
515
			$return[$key] = (object) $this->cast_and_filter( $value, $this->comment_object_format, false, $for_output );
516
			break;
517
		case 'tag' :
518
		case 'category' :
519
			$docs = array(
520
				'ID'          => '(int)',
521
				'name'        => '(string)',
522
				'slug'        => '(string)',
523
				'description' => '(HTML)',
524
				'post_count'  => '(int)',
525
				'meta'        => '(object)',
526
			);
527
			if ( 'category' === $type['type'] ) {
528
				$docs['parent'] = '(int)';
529
			}
530
			$return[$key] = (object) $this->cast_and_filter( $value, $docs, false, $for_output );
531
			break;
532
		case 'post_reference' :
533 View Code Duplication
		case 'comment_reference' :
534
			$docs = array(
535
				'ID'    => '(int)',
536
				'type'  => '(string)',
537
				'title' => '(string)',
538
				'link'  => '(URL)',
539
			);
540
			$return[$key] = (object) $this->cast_and_filter( $value, $docs, false, $for_output );
541
			break;
542 View Code Duplication
		case 'geo' :
543
			$docs = array(
544
				'latitude'  => '(float)',
545
				'longitude' => '(float)',
546
				'address'   => '(string)',
547
			);
548
			$return[$key] = (object) $this->cast_and_filter( $value, $docs, false, $for_output );
549
			break;
550
		case 'author' :
551
			$docs = array(
552
				'ID'             => '(int)',
553
				'user_login'     => '(string)',
554
				'login'          => '(string)',
555
				'email'          => '(string|false)',
556
				'name'           => '(string)',
557
				'first_name'     => '(string)',
558
				'last_name'      => '(string)',
559
				'nice_name'      => '(string)',
560
				'URL'            => '(URL)',
561
				'avatar_URL'     => '(URL)',
562
				'profile_URL'    => '(URL)',
563
				'is_super_admin' => '(bool)',
564
				'roles'          => '(array:string)',
565
				'ip_address'     => '(string|false)',
566
			);
567
			$return[$key] = (object) $this->cast_and_filter( $value, $docs, false, $for_output );
568
			break;
569 View Code Duplication
		case 'role' :
570
			$docs = array(
571
				'name'         => '(string)',
572
				'display_name' => '(string)',
573
				'capabilities' => '(object:boolean)',
574
			);
575
			$return[$key] = (object) $this->cast_and_filter( $value, $docs, false, $for_output );
576
			break;
577
		case 'attachment' :
578
			$docs = array(
579
				'ID'        => '(int)',
580
				'URL'       => '(URL)',
581
				'guid'      => '(string)',
582
				'mime_type' => '(string)',
583
				'width'     => '(int)',
584
				'height'    => '(int)',
585
				'duration'  => '(int)',
586
			);
587
			$return[$key] = (object) $this->cast_and_filter(
588
				$value,
589
				/**
590
				 * Filter the documentation returned for a post attachment.
591
				 *
592
				 * @module json-api
593
				 *
594
				 * @since 1.9.0
595
				 *
596
				 * @param array $docs Array of documentation about a post attachment.
597
				 */
598
				apply_filters( 'wpcom_json_api_attachment_cast_and_filter', $docs ),
599
				false,
600
				$for_output
601
			);
602
			break;
603
		case 'metadata' :
604
			$docs = array(
605
				'id'       => '(int)',
606
				'key'       => '(string)',
607
				'value'     => '(string|false|float|int|array|object)',
608
				'previous_value' => '(string)',
609
				'operation'  => '(string)',
610
			);
611
			$return[$key] = (object) $this->cast_and_filter(
612
				$value,
613
				/** This filter is documented in class.json-api-endpoints.php */
614
				apply_filters( 'wpcom_json_api_attachment_cast_and_filter', $docs ),
615
				false,
616
				$for_output
617
			);
618
			break;
619
		case 'plugin' :
620
			$docs = array(
621
				'id'            => '(safehtml) The plugin\'s ID',
622
				'slug'          => '(safehtml) The plugin\'s Slug',
623
				'active'        => '(boolean)  The plugin status.',
624
				'update'        => '(object)   The plugin update info.',
625
				'name'          => '(safehtml) The name of the plugin.',
626
				'plugin_url'    => '(url)      Link to the plugin\'s web site.',
627
				'version'       => '(safehtml) The plugin version number.',
628
				'description'   => '(safehtml) Description of what the plugin does and/or notes from the author',
629
				'author'        => '(safehtml) The plugin author\'s name',
630
				'author_url'    => '(url)      The plugin author web site address',
631
				'network'       => '(boolean)  Whether the plugin can only be activated network wide.',
632
				'autoupdate'    => '(boolean)  Whether the plugin is auto updated',
633
				'log'           => '(array:safehtml) An array of update log strings.',
634
				'action_links'  => '(array) An array of action links that the plugin uses.',
635
			);
636
			$return[$key] = (object) $this->cast_and_filter(
637
				$value,
638
				/**
639
				 * Filter the documentation returned for a plugin.
640
				 *
641
				 * @module json-api
642
				 *
643
				 * @since 3.1.0
644
				 *
645
				 * @param array $docs Array of documentation about a plugin.
646
				 */
647
				apply_filters( 'wpcom_json_api_plugin_cast_and_filter', $docs ),
648
				false,
649
				$for_output
650
			);
651
			break;
652
		case 'plugin_v1_2' :
653
			$docs = class_exists( 'Jetpack_JSON_API_Get_Plugins_v1_2_Endpoint' )
654
				? Jetpack_JSON_API_Get_Plugins_v1_2_Endpoint::$_response_format
655
				: Jetpack_JSON_API_Plugins_Endpoint::$_response_format_v1_2;
0 ignored issues
show
The property _response_format_v1_2 cannot be accessed from this context as it is declared private in class Jetpack_JSON_API_Plugins_Endpoint.

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...
656
			$return[$key] = (object) $this->cast_and_filter(
657
				$value,
658
				/**
659
				 * Filter the documentation returned for a plugin.
660
				 *
661
				 * @module json-api
662
				 *
663
				 * @since 3.1.0
664
				 *
665
				 * @param array $docs Array of documentation about a plugin.
666
				 */
667
				apply_filters( 'wpcom_json_api_plugin_cast_and_filter', $docs ),
668
				false,
669
				$for_output
670
			);
671
			break;
672
		case 'file_mod_capabilities':
673
			$docs           = array(
674
				'reasons_modify_files_unavailable' => '(array) The reasons why files can\'t be modified',
675
				'reasons_autoupdate_unavailable'   => '(array) The reasons why autoupdates aren\'t allowed',
676
				'modify_files'                     => '(boolean) true if files can be modified',
677
				'autoupdate_files'                 => '(boolean) true if autoupdates are allowed',
678
			);
679
			$return[ $key ] = (array) $this->cast_and_filter( $value, $docs, false, $for_output );
680
			break;
681
		case 'jetpackmodule' :
682
			$docs = array(
683
				'id'          => '(string)   The module\'s ID',
684
				'active'      => '(boolean)  The module\'s status.',
685
				'name'        => '(string)   The module\'s name.',
686
				'description' => '(safehtml) The module\'s description.',
687
				'sort'        => '(int)      The module\'s display order.',
688
				'introduced'  => '(string)   The Jetpack version when the module was introduced.',
689
				'changed'     => '(string)   The Jetpack version when the module was changed.',
690
				'free'        => '(boolean)  The module\'s Free or Paid status.',
691
				'module_tags' => '(array)    The module\'s tags.',
692
				'override'    => '(string)   The module\'s override. Empty if no override, otherwise \'active\' or \'inactive\'',
693
			);
694
			$return[$key] = (object) $this->cast_and_filter(
695
				$value,
696
				/** This filter is documented in class.json-api-endpoints.php */
697
				apply_filters( 'wpcom_json_api_plugin_cast_and_filter', $docs ),
698
				false,
699
				$for_output
700
			);
701
			break;
702
		case 'sharing_button' :
703
			$docs = array(
704
				'ID'         => '(string)',
705
				'name'       => '(string)',
706
				'URL'        => '(string)',
707
				'icon'       => '(string)',
708
				'enabled'    => '(bool)',
709
				'visibility' => '(string)',
710
			);
711
			$return[$key] = (array) $this->cast_and_filter( $value, $docs, false, $for_output );
712
			break;
713
		case 'sharing_button_service':
714
			$docs = array(
715
				'ID'               => '(string) The service identifier',
716
				'name'             => '(string) The service name',
717
				'class_name'       => '(string) Class name for custom style sharing button elements',
718
				'genericon'        => '(string) The Genericon unicode character for the custom style sharing button icon',
719
				'preview_smart'    => '(string) An HTML snippet of a rendered sharing button smart preview',
720
				'preview_smart_js' => '(string) An HTML snippet of the page-wide initialization scripts used for rendering the sharing button smart preview'
721
			);
722
			$return[$key] = (array) $this->cast_and_filter( $value, $docs, false, $for_output );
723
			break;
724
		case 'taxonomy':
725
			$docs = array(
726
				'name'         => '(string) The taxonomy slug',
727
				'label'        => '(string) The taxonomy human-readable name',
728
				'labels'       => '(object) Mapping of labels for the taxonomy',
729
				'description'  => '(string) The taxonomy description',
730
				'hierarchical' => '(bool) Whether the taxonomy is hierarchical',
731
				'public'       => '(bool) Whether the taxonomy is public',
732
				'capabilities' => '(object) Mapping of current user capabilities for the taxonomy',
733
			);
734
			$return[$key] = (array) $this->cast_and_filter( $value, $docs, false, $for_output );
735
			break;
736
737
		default :
0 ignored issues
show
There must be no space before the colon in a DEFAULT statement

As per the PSR-2 coding standard, there must not be a space in front of the colon in the default statement.

switch ($expr) {
    default : //wrong
        doSomething();
        break;
}

switch ($expr) {
    default: //right
        doSomething();
        break;
}

To learn more about the PSR-2 coding standard, please refer to the PHP-Fig.

Loading history...
738
			$method_name = $type['type'] . '_docs';
739
			if ( method_exists( 'WPCOM_JSON_API_Jetpack_Overrides', $method_name ) ) {
740
				$docs = WPCOM_JSON_API_Jetpack_Overrides::$method_name();
741
			}
742
743
			if ( ! empty( $docs ) ) {
744
				$return[$key] = (object) $this->cast_and_filter(
745
					$value,
746
					/** This filter is documented in class.json-api-endpoints.php */
747
					apply_filters( 'wpcom_json_api_plugin_cast_and_filter', $docs ),
748
					false,
749
					$for_output
750
				);
751
			} else {
752
				trigger_error( "Unknown API casting type {$type['type']}", E_USER_WARNING );
753
			}
754
		}
755
	}
756
757
	function parse_types( $text ) {
758
		if ( !preg_match( '#^\(([^)]+)\)#', ltrim( $text ), $matches ) ) {
759
			return 'none';
760
		}
761
762
		$types = explode( '|', strtolower( $matches[1] ) );
763
		$return = array();
764
		foreach ( $types as $type ) {
765
			foreach ( array( ':' => 'children', '>' => 'subtype', '=' => 'default' ) as $operator => $meaning ) {
766
				if ( false !== strpos( $type, $operator ) ) {
767
					$item = explode( $operator, $type, 2 );
768
					$return[] = array( 'type' => $item[0], $meaning => $item[1] );
769
					continue 2;
770
				}
771
			}
772
			$return[] = compact( 'type' );
773
		}
774
775
		return $return;
776
	}
777
778
	/**
779
	 * Checks if the endpoint is publicly displayable
780
	 */
781
	function is_publicly_documentable() {
782
		return '__do_not_document' !== $this->group && true !== $this->in_testing;
783
	}
784
785
	/**
786
	 * Auto generates documentation based on description, method, path, path_labels, and query parameters.
787
	 * Echoes HTML.
788
	 */
789
	function document( $show_description = true ) {
790
		global $wpdb;
791
		$original_post = isset( $GLOBALS['post'] ) ? $GLOBALS['post'] : 'unset';
792
		unset( $GLOBALS['post'] );
793
794
		$doc = $this->generate_documentation();
795
796
		if ( $show_description ) :
797
?>
798
<caption>
799
	<h1><?php echo wp_kses_post( $doc['method'] ); ?> <?php echo wp_kses_post( $doc['path_labeled'] ); ?></h1>
800
	<p><?php echo wp_kses_post( $doc['description'] ); ?></p>
801
</caption>
802
803
<?php endif; ?>
804
805
<?php if ( true === $this->deprecated ) { ?>
806
<p><strong>This endpoint is deprecated in favor of version <?php echo floatval( $this->new_version ); ?></strong></p>
0 ignored issues
show
The property new_version does not seem to exist. Did you mean version?

An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name.

If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading.

Loading history...
807
<?php } ?>
808
809
<section class="resource-info">
810
	<h2 id="apidoc-resource-info">Resource Information</h2>
811
812
	<table class="api-doc api-doc-resource-parameters api-doc-resource">
813
814
	<thead>
815
		<tr>
816
			<th class="api-index-title" scope="column">&nbsp;</th>
817
			<th class="api-index-title" scope="column">&nbsp;</th>
818
		</tr>
819
	</thead>
820
	<tbody>
821
822
		<tr class="api-index-item">
823
			<th scope="row" class="parameter api-index-item-title">Method</th>
824
			<td class="type api-index-item-title"><?php echo wp_kses_post( $doc['method'] ); ?></td>
825
		</tr>
826
827
		<tr class="api-index-item">
828
			<th scope="row" class="parameter api-index-item-title">URL</th>
829
			<?php
830
			$version = WPCOM_JSON_API__CURRENT_VERSION;
831
			if ( !empty( $this->max_version ) ) {
832
				$version = $this->max_version;
833
			}
834
			?>
835
			<td class="type api-index-item-title">https://public-api.wordpress.com/rest/v<?php echo floatval( $version ); ?><?php echo wp_kses_post( $doc['path_labeled'] ); ?></td>
836
		</tr>
837
838
		<tr class="api-index-item">
839
			<th scope="row" class="parameter api-index-item-title">Requires authentication?</th>
840
			<?php
841
			$requires_auth = $wpdb->get_row( $wpdb->prepare( "SELECT requires_authentication FROM rest_api_documentation WHERE `version` = %s AND `path` = %s AND `method` = %s LIMIT 1", $version, untrailingslashit( $doc['path_labeled'] ), $doc['method'] ) );
842
			?>
843
			<td class="type api-index-item-title"><?php echo ( true === (bool) $requires_auth->requires_authentication ? 'Yes' : 'No' ); ?></td>
844
		</tr>
845
846
	</tbody>
847
	</table>
848
849
</section>
850
851
<?php
852
853
		foreach ( array(
854
			'path'     => 'Method Parameters',
855
			'query'    => 'Query Parameters',
856
			'body'     => 'Request Parameters',
857
			'response' => 'Response Parameters',
858
		) as $doc_section_key => $label ) :
859
			$doc_section = 'response' === $doc_section_key ? $doc['response']['body'] : $doc['request'][$doc_section_key];
860
			if ( !$doc_section ) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $doc_section of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using empty($expr) instead to make it clear that you intend to check for an array without elements.

This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent.

Consider making the comparison explicit by using empty(..) or ! empty(...) instead.

Loading history...
861
				continue;
862
			}
863
864
			$param_label = strtolower( str_replace( ' ', '-', $label ) );
865
?>
866
867
<section class="<?php echo $param_label; ?>">
868
869
<h2 id="apidoc-<?php echo esc_attr( $doc_section_key ); ?>"><?php echo wp_kses_post( $label ); ?></h2>
870
871
<table class="api-doc api-doc-<?php echo $param_label; ?>-parameters api-doc-<?php echo strtolower( str_replace( ' ', '-', $doc['group'] ) ); ?>">
872
873
<thead>
874
	<tr>
875
		<th class="api-index-title" scope="column">Parameter</th>
876
		<th class="api-index-title" scope="column">Type</th>
877
		<th class="api-index-title" scope="column">Description</th>
878
	</tr>
879
</thead>
880
<tbody>
881
882
<?php foreach ( $doc_section as $key => $item ) : ?>
883
884
	<tr class="api-index-item">
885
		<th scope="row" class="parameter api-index-item-title"><?php echo wp_kses_post( $key ); ?></th>
886
		<td class="type api-index-item-title"><?php echo wp_kses_post( $item['type'] ); // @todo auto-link? ?></td>
0 ignored issues
show
Coding Style Best Practice introduced by
Comments for TODO tasks are often forgotten in the code; it might be better to use a dedicated issue tracker.
Loading history...
887
		<td class="description api-index-item-body"><?php
888
889
		$this->generate_doc_description( $item['description'] );
890
891
		?></td>
892
	</tr>
893
894
<?php endforeach; ?>
895
</tbody>
896
</table>
897
</section>
898
<?php endforeach; ?>
899
900
<?php
901
		if ( 'unset' !== $original_post ) {
902
			$GLOBALS['post'] = $original_post;
903
		}
904
	}
905
906
	function add_http_build_query_to_php_content_example( $matches ) {
907
		$trimmed_match = ltrim( $matches[0] );
908
		$pad = substr( $matches[0], 0, -1 * strlen( $trimmed_match ) );
909
		$pad = ltrim( $pad, ' ' );
910
		$return = '  ' . str_replace( "\n", "\n  ", $matches[0] );
911
		return " http_build_query({$return}{$pad})";
912
	}
913
914
	/**
915
	 * Recursively generates the <dl>'s to document item descriptions.
916
	 * Echoes HTML.
917
	 */
918
	function generate_doc_description( $item ) {
919
		if ( is_array( $item ) ) : ?>
920
921
		<dl>
922
<?php			foreach ( $item as $description_key => $description_value ) : ?>
923
924
			<dt><?php echo wp_kses_post( $description_key . ':' ); ?></dt>
925
			<dd><?php $this->generate_doc_description( $description_value ); ?></dd>
926
927
<?php			endforeach; ?>
928
929
		</dl>
930
931
<?php
932
		else :
933
			echo wp_kses_post( $item );
934
		endif;
935
	}
936
937
	/**
938
	 * Auto generates documentation based on description, method, path, path_labels, and query parameters.
939
	 * Echoes HTML.
940
	 */
941
	function generate_documentation() {
942
		$format       = str_replace( '%d', '%s', $this->path );
943
		$path_labeled = $format;
944
		if ( ! empty( $this->path_labels ) ) {
945
			$path_labeled = vsprintf( $format, array_keys( $this->path_labels ) );
946
		}
947
		$boolean_arg  = array( 'false', 'true' );
948
		$naeloob_arg  = array( 'true', 'false' );
949
950
		$doc = array(
951
			'description'  => $this->description,
952
			'method'       => $this->method,
953
			'path_format'  => $this->path,
954
			'path_labeled' => $path_labeled,
955
			'group'        => $this->group,
956
			'request' => array(
957
				'path'  => array(),
958
				'query' => array(),
959
				'body'  => array(),
960
			),
961
			'response' => array(
962
				'body' => array(),
963
			)
964
		);
965
966
		foreach ( array( 'path_labels' => 'path', 'query' => 'query', 'request_format' => 'body', 'response_format' => 'body' ) as $_property => $doc_item ) {
967
			foreach ( (array) $this->$_property as $key => $description ) {
968
				if ( is_array( $description ) ) {
969
					$description_keys = array_keys( $description );
970
					if ( $boolean_arg === $description_keys || $naeloob_arg === $description_keys ) {
971
						$type = '(bool)';
972
					} else {
973
						$type = '(string)';
974
					}
975
976
					if ( 'response_format' !== $_property ) {
977
						// hack - don't show "(default)" in response format
978
						reset( $description );
979
						$description_key = key( $description );
980
						$description[$description_key] = "(default) {$description[$description_key]}";
981
					}
982
				} else {
983
					$types   = $this->parse_types( $description );
984
					$type    = array();
985
					$default = '';
986
987
					if ( 'none' == $types ) {
988
						$types = array();
989
						$types[]['type'] = 'none';
990
					}
991
992
					foreach ( $types as $type_array ) {
0 ignored issues
show
The expression $types of type string|array is not guaranteed to be traversable. How about adding an additional type check?

There are different options of fixing this problem.

  1. If you want to be on the safe side, you can add an additional type-check:

    $collection = json_decode($data, true);
    if ( ! is_array($collection)) {
        throw new \RuntimeException('$collection must be an array.');
    }
    
    foreach ($collection as $item) { /** ... */ }
    
  2. If you are sure that the expression is traversable, you might want to add a doc comment cast to improve IDE auto-completion and static analysis:

    /** @var array $collection */
    $collection = json_decode($data, true);
    
    foreach ($collection as $item) { /** .. */ }
    
  3. Mark the issue as a false-positive: Just hover the remove button, in the top-right corner of this issue for more options.

Loading history...
993
						$type[] = $type_array['type'];
994
						if ( isset( $type_array['default'] ) ) {
995
							$default = $type_array['default'];
996
							if ( 'string' === $type_array['type'] ) {
997
								$default = "'$default'";
998
							}
999
						}
1000
					}
1001
					$type = '(' . join( '|', $type ) . ')';
1002
					$noop = ''; // skip an index in list below
0 ignored issues
show
$noop 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...
1003
					list( $noop, $description ) = explode( ')', $description, 2 );
0 ignored issues
show
The assignment to $noop is unused. Consider omitting it like so list($first,,$third).

This checks looks for assignemnts to variables using the list(...) function, where not all assigned variables are subsequently used.

Consider the following code example.

<?php

function returnThreeValues() {
    return array('a', 'b', 'c');
}

list($a, $b, $c) = returnThreeValues();

print $a . " - " . $c;

Only the variables $a and $c are used. There was no need to assign $b.

Instead, the list call could have been.

list($a,, $c) = returnThreeValues();
Loading history...
1004
					$description = trim( $description );
1005
					if ( $default ) {
1006
						$description .= " Default: $default.";
1007
					}
1008
				}
1009
1010
				$item = compact( 'type', 'description' );
1011
1012
				if ( 'response_format' === $_property ) {
1013
					$doc['response'][$doc_item][$key] = $item;
1014
				} else {
1015
					$doc['request'][$doc_item][$key] = $item;
1016
				}
1017
			}
1018
		}
1019
1020
		return $doc;
1021
	}
1022
1023
	function user_can_view_post( $post_id ) {
1024
		$post = get_post( $post_id );
1025
		if ( !$post || is_wp_error( $post ) ) {
1026
			return false;
1027
		}
1028
1029 View Code Duplication
		if ( 'inherit' === $post->post_status ) {
1030
			$parent_post = get_post( $post->post_parent );
1031
			$post_status_obj = get_post_status_object( $parent_post->post_status );
1032
		} else {
1033
			$post_status_obj = get_post_status_object( $post->post_status );
1034
		}
1035
1036
		if ( !$post_status_obj->public ) {
1037
			if ( is_user_logged_in() ) {
1038
				if ( $post_status_obj->protected ) {
1039
					if ( !current_user_can( 'edit_post', $post->ID ) ) {
1040
						return new WP_Error( 'unauthorized', 'User cannot view post', 403 );
1041
					}
1042
				} elseif ( $post_status_obj->private ) {
1043
					if ( !current_user_can( 'read_post', $post->ID ) ) {
1044
						return new WP_Error( 'unauthorized', 'User cannot view post', 403 );
1045
					}
1046
				} elseif ( in_array( $post->post_status, array( 'inherit', 'trash' ) ) ) {
1047
					if ( !current_user_can( 'edit_post', $post->ID ) ) {
1048
						return new WP_Error( 'unauthorized', 'User cannot view post', 403 );
1049
					}
1050
				} elseif ( 'auto-draft' === $post->post_status ) {
0 ignored issues
show
This elseif statement is empty, and could be removed.

This check looks for the bodies of elseif statements that have no statements or where all statements have been commented out. This may be the result of changes for debugging or the code may simply be obsolete.

These elseif bodies can be removed. If you have an empty elseif but statements in the else branch, consider inverting the condition.

Loading history...
1051
					//allow auto-drafts
1052
				} else {
1053
					return new WP_Error( 'unauthorized', 'User cannot view post', 403 );
1054
				}
1055
			} else {
1056
				return new WP_Error( 'unauthorized', 'User cannot view post', 403 );
1057
			}
1058
		}
1059
1060 View Code Duplication
		if (
1061
			-1 == get_option( 'blog_public' ) &&
1062
			/**
1063
			 * Filter access to a specific post.
1064
			 *
1065
			 * @module json-api
1066
			 *
1067
			 * @since 3.4.0
1068
			 *
1069
			 * @param bool current_user_can( 'read_post', $post->ID ) Can the current user access the post.
1070
			 * @param WP_Post $post Post data.
1071
			 */
1072
			! apply_filters(
1073
				'wpcom_json_api_user_can_view_post',
1074
				current_user_can( 'read_post', $post->ID ),
1075
				$post
1076
			)
1077
		) {
1078
			return new WP_Error( 'unauthorized', 'User cannot view post', array( 'status_code' => 403, 'error' => 'private_blog' ) );
1079
		}
1080
1081 View Code Duplication
		if ( strlen( $post->post_password ) && !current_user_can( 'edit_post', $post->ID ) ) {
1082
			return new WP_Error( 'unauthorized', 'User cannot view password protected post', array( 'status_code' => 403, 'error' => 'password_protected' ) );
1083
		}
1084
1085
		return true;
1086
	}
1087
1088
	/**
1089
	 * Returns author object.
1090
	 *
1091
	 * @param object $author user ID, user row, WP_User object, comment row, post row
1092
	 * @param bool $show_email_and_ip output the author's email address and IP address?
1093
	 *
1094
	 * @return object
1095
	 */
1096
	function get_author( $author, $show_email_and_ip = false ) {
1097
		$ip_address = isset( $author->comment_author_IP ) ? $author->comment_author_IP : '';
1098
1099
		if ( isset( $author->comment_author_email ) ) {
1100
			$ID          = 0;
1101
			$login       = '';
1102
			$email       = $author->comment_author_email;
1103
			$name        = $author->comment_author;
1104
			$first_name  = '';
1105
			$last_name   = '';
1106
			$URL         = $author->comment_author_url;
1107
			$avatar_URL  = $this->api->get_avatar_url( $author );
1108
			$profile_URL = 'https://en.gravatar.com/' . md5( strtolower( trim( $email ) ) );
1109
			$nice        = '';
1110
			$site_id     = -1;
1111
1112
			// Comment author URLs and Emails are sent through wp_kses() on save, which replaces "&" with "&amp;"
1113
			// "&" is the only email/URL character altered by wp_kses()
1114
			foreach ( array( 'email', 'URL' ) as $field ) {
1115
				$$field = str_replace( '&amp;', '&', $$field );
1116
			}
1117
		} else {
1118
			if ( isset( $author->user_id ) && $author->user_id ) {
1119
				$author = $author->user_id;
1120
			} elseif ( isset( $author->user_email ) ) {
1121
				$author = $author->ID;
1122
			} elseif ( isset( $author->post_author ) ) {
1123
				// then $author is a Post Object.
1124
				if ( 0 == $author->post_author )
1125
					return null;
1126
				/**
1127
				 * Filter whether the current site is a Jetpack site.
1128
				 *
1129
				 * @module json-api
1130
				 *
1131
				 * @since 3.3.0
1132
				 *
1133
				 * @param bool false Is the current site a Jetpack site. Default to false.
1134
				 * @param int get_current_blog_id() Blog ID.
1135
				 */
1136
				$is_jetpack = true === apply_filters( 'is_jetpack_site', false, get_current_blog_id() );
1137
				$post_id = $author->ID;
1138
				if ( $is_jetpack && ( defined( 'IS_WPCOM' ) && IS_WPCOM ) ) {
1139
					$ID         = get_post_meta( $post_id, '_jetpack_post_author_external_id', true );
1140
					$email      = get_post_meta( $post_id, '_jetpack_author_email', true );
1141
					$login      = '';
1142
					$name       = get_post_meta( $post_id, '_jetpack_author', true );
1143
					$first_name = '';
1144
					$last_name  = '';
1145
					$URL        = '';
1146
					$nice       = '';
1147
				} else {
1148
					$author = $author->post_author;
1149
				}
1150
			}
1151
1152
			if ( ! isset( $ID ) ) {
1153
				$user = get_user_by( 'id', $author );
1154
				if ( ! $user || is_wp_error( $user ) ) {
1155
					trigger_error( 'Unknown user', E_USER_WARNING );
1156
1157
					return null;
1158
				}
1159
				$ID         = $user->ID;
1160
				$email      = $user->user_email;
1161
				$login      = $user->user_login;
1162
				$name       = $user->display_name;
1163
				$first_name = $user->first_name;
1164
				$last_name  = $user->last_name;
1165
				$URL        = $user->user_url;
1166
				$nice       = $user->user_nicename;
1167
			}
1168
			if ( defined( 'IS_WPCOM' ) && IS_WPCOM && ! $is_jetpack ) {
0 ignored issues
show
The variable $is_jetpack does not seem to be defined for all execution paths leading up to this point.

If you define a variable conditionally, it can happen that it is not defined for all execution paths.

Let’s take a look at an example:

function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}

In the above example, the variable $x is defined if you pass “foo” or “bar” as argument for $a. However, since the switch statement has no default case statement, if you pass any other value, the variable $x would be undefined.

Available Fixes

  1. Check for existence of the variable explicitly:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        if (isset($x)) { // Make sure it's always set.
            echo $x;
        }
    }
    
  2. Define a default value for the variable:

    function myFunction($a) {
        $x = ''; // Set a default which gets overridden for certain paths.
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        echo $x;
    }
    
  3. Add a value for the missing path:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
    
            // We add support for the missing case.
            default:
                $x = '';
                break;
        }
    
        echo $x;
    }
    
Loading history...
1169
				$active_blog = get_active_blog_for_user( $ID );
1170
				$site_id     = $active_blog->blog_id;
1171
				if ( $site_id > -1 ) {
1172
					$site_visible = (
1173
						-1 != $active_blog->public ||
1174
						is_private_blog_user( $site_id, get_current_user_id() )
1175
					);
1176
				}
1177
				$profile_URL = "https://en.gravatar.com/{$login}";
0 ignored issues
show
The variable $login does not seem to be defined for all execution paths leading up to this point.

If you define a variable conditionally, it can happen that it is not defined for all execution paths.

Let’s take a look at an example:

function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}

In the above example, the variable $x is defined if you pass “foo” or “bar” as argument for $a. However, since the switch statement has no default case statement, if you pass any other value, the variable $x would be undefined.

Available Fixes

  1. Check for existence of the variable explicitly:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        if (isset($x)) { // Make sure it's always set.
            echo $x;
        }
    }
    
  2. Define a default value for the variable:

    function myFunction($a) {
        $x = ''; // Set a default which gets overridden for certain paths.
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        echo $x;
    }
    
  3. Add a value for the missing path:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
    
            // We add support for the missing case.
            default:
                $x = '';
                break;
        }
    
        echo $x;
    }
    
Loading history...
1178
			} else {
1179
				$profile_URL = 'https://en.gravatar.com/' . md5( strtolower( trim( $email ) ) );
0 ignored issues
show
The variable $email does not seem to be defined for all execution paths leading up to this point.

If you define a variable conditionally, it can happen that it is not defined for all execution paths.

Let’s take a look at an example:

function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}

In the above example, the variable $x is defined if you pass “foo” or “bar” as argument for $a. However, since the switch statement has no default case statement, if you pass any other value, the variable $x would be undefined.

Available Fixes

  1. Check for existence of the variable explicitly:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        if (isset($x)) { // Make sure it's always set.
            echo $x;
        }
    }
    
  2. Define a default value for the variable:

    function myFunction($a) {
        $x = ''; // Set a default which gets overridden for certain paths.
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        echo $x;
    }
    
  3. Add a value for the missing path:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
    
            // We add support for the missing case.
            default:
                $x = '';
                break;
        }
    
        echo $x;
    }
    
Loading history...
1180
				$site_id     = -1;
1181
			}
1182
1183
			$avatar_URL = $this->api->get_avatar_url( $email );
1184
		}
1185
1186
		if ( $show_email_and_ip ) {
1187
			$email = (string) $email;
1188
			$ip_address = (string) $ip_address;
1189
		} else {
1190
			$email = false;
1191
			$ip_address = false;
1192
		}
1193
1194
		$author = array(
1195
			'ID'          => (int) $ID,
1196
			'login'       => (string) $login,
1197
			'email'       => $email, // (string|bool)
1198
			'name'        => (string) $name,
0 ignored issues
show
The variable $name does not seem to be defined for all execution paths leading up to this point.

If you define a variable conditionally, it can happen that it is not defined for all execution paths.

Let’s take a look at an example:

function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}

In the above example, the variable $x is defined if you pass “foo” or “bar” as argument for $a. However, since the switch statement has no default case statement, if you pass any other value, the variable $x would be undefined.

Available Fixes

  1. Check for existence of the variable explicitly:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        if (isset($x)) { // Make sure it's always set.
            echo $x;
        }
    }
    
  2. Define a default value for the variable:

    function myFunction($a) {
        $x = ''; // Set a default which gets overridden for certain paths.
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        echo $x;
    }
    
  3. Add a value for the missing path:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
    
            // We add support for the missing case.
            default:
                $x = '';
                break;
        }
    
        echo $x;
    }
    
Loading history...
1199
			'first_name'  => (string) $first_name,
0 ignored issues
show
The variable $first_name does not seem to be defined for all execution paths leading up to this point.

If you define a variable conditionally, it can happen that it is not defined for all execution paths.

Let’s take a look at an example:

function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}

In the above example, the variable $x is defined if you pass “foo” or “bar” as argument for $a. However, since the switch statement has no default case statement, if you pass any other value, the variable $x would be undefined.

Available Fixes

  1. Check for existence of the variable explicitly:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        if (isset($x)) { // Make sure it's always set.
            echo $x;
        }
    }
    
  2. Define a default value for the variable:

    function myFunction($a) {
        $x = ''; // Set a default which gets overridden for certain paths.
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        echo $x;
    }
    
  3. Add a value for the missing path:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
    
            // We add support for the missing case.
            default:
                $x = '';
                break;
        }
    
        echo $x;
    }
    
Loading history...
1200
			'last_name'   => (string) $last_name,
0 ignored issues
show
The variable $last_name does not seem to be defined for all execution paths leading up to this point.

If you define a variable conditionally, it can happen that it is not defined for all execution paths.

Let’s take a look at an example:

function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}

In the above example, the variable $x is defined if you pass “foo” or “bar” as argument for $a. However, since the switch statement has no default case statement, if you pass any other value, the variable $x would be undefined.

Available Fixes

  1. Check for existence of the variable explicitly:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        if (isset($x)) { // Make sure it's always set.
            echo $x;
        }
    }
    
  2. Define a default value for the variable:

    function myFunction($a) {
        $x = ''; // Set a default which gets overridden for certain paths.
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        echo $x;
    }
    
  3. Add a value for the missing path:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
    
            // We add support for the missing case.
            default:
                $x = '';
                break;
        }
    
        echo $x;
    }
    
Loading history...
1201
			'nice_name'   => (string) $nice,
0 ignored issues
show
The variable $nice does not seem to be defined for all execution paths leading up to this point.

If you define a variable conditionally, it can happen that it is not defined for all execution paths.

Let’s take a look at an example:

function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}

In the above example, the variable $x is defined if you pass “foo” or “bar” as argument for $a. However, since the switch statement has no default case statement, if you pass any other value, the variable $x would be undefined.

Available Fixes

  1. Check for existence of the variable explicitly:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        if (isset($x)) { // Make sure it's always set.
            echo $x;
        }
    }
    
  2. Define a default value for the variable:

    function myFunction($a) {
        $x = ''; // Set a default which gets overridden for certain paths.
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        echo $x;
    }
    
  3. Add a value for the missing path:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
    
            // We add support for the missing case.
            default:
                $x = '';
                break;
        }
    
        echo $x;
    }
    
Loading history...
1202
			'URL'         => (string) esc_url_raw( $URL ),
0 ignored issues
show
The variable $URL does not seem to be defined for all execution paths leading up to this point.

If you define a variable conditionally, it can happen that it is not defined for all execution paths.

Let’s take a look at an example:

function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}

In the above example, the variable $x is defined if you pass “foo” or “bar” as argument for $a. However, since the switch statement has no default case statement, if you pass any other value, the variable $x would be undefined.

Available Fixes

  1. Check for existence of the variable explicitly:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        if (isset($x)) { // Make sure it's always set.
            echo $x;
        }
    }
    
  2. Define a default value for the variable:

    function myFunction($a) {
        $x = ''; // Set a default which gets overridden for certain paths.
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        echo $x;
    }
    
  3. Add a value for the missing path:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
    
            // We add support for the missing case.
            default:
                $x = '';
                break;
        }
    
        echo $x;
    }
    
Loading history...
1203
			'avatar_URL'  => (string) esc_url_raw( $avatar_URL ),
1204
			'profile_URL' => (string) esc_url_raw( $profile_URL ),
1205
			'ip_address'  => $ip_address, // (string|bool)
1206
		);
1207
1208
		if ( $site_id > -1 ) {
1209
			$author['site_ID']      = (int) $site_id;
1210
			$author['site_visible'] = $site_visible;
0 ignored issues
show
The variable $site_visible does not seem to be defined for all execution paths leading up to this point.

If you define a variable conditionally, it can happen that it is not defined for all execution paths.

Let’s take a look at an example:

function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}

In the above example, the variable $x is defined if you pass “foo” or “bar” as argument for $a. However, since the switch statement has no default case statement, if you pass any other value, the variable $x would be undefined.

Available Fixes

  1. Check for existence of the variable explicitly:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        if (isset($x)) { // Make sure it's always set.
            echo $x;
        }
    }
    
  2. Define a default value for the variable:

    function myFunction($a) {
        $x = ''; // Set a default which gets overridden for certain paths.
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        echo $x;
    }
    
  3. Add a value for the missing path:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
    
            // We add support for the missing case.
            default:
                $x = '';
                break;
        }
    
        echo $x;
    }
    
Loading history...
1211
		}
1212
1213
		return (object) $author;
1214
	}
1215
1216
	function get_media_item( $media_id ) {
1217
		$media_item = get_post( $media_id );
1218
1219
		if ( !$media_item || is_wp_error( $media_item ) )
1220
			return new WP_Error( 'unknown_media', 'Unknown Media', 404 );
1221
1222
		$response = array(
1223
			'id'    => strval( $media_item->ID ),
1224
			'date' =>  (string) $this->format_date( $media_item->post_date_gmt, $media_item->post_date ),
1225
			'parent'           => $media_item->post_parent,
1226
			'link'             => wp_get_attachment_url( $media_item->ID ),
1227
			'title'            => $media_item->post_title,
1228
			'caption'          => $media_item->post_excerpt,
1229
			'description'      => $media_item->post_content,
1230
			'metadata'         => wp_get_attachment_metadata( $media_item->ID ),
1231
		);
1232
1233
		if ( defined( 'IS_WPCOM' ) && IS_WPCOM && is_array( $response['metadata'] ) && ! empty( $response['metadata']['file'] ) ) {
1234
			remove_filter( '_wp_relative_upload_path', 'wpcom_wp_relative_upload_path', 10 );
1235
			$response['metadata']['file'] = _wp_relative_upload_path( $response['metadata']['file'] );
1236
			add_filter( '_wp_relative_upload_path', 'wpcom_wp_relative_upload_path', 10, 2 );
1237
		}
1238
1239
		$response['meta'] = (object) array(
1240
			'links' => (object) array(
1241
				'self' => (string) $this->links->get_media_link( $this->api->get_blog_id_for_output(), $media_id ),
1242
				'help' => (string) $this->links->get_media_link( $this->api->get_blog_id_for_output(), $media_id, 'help' ),
1243
				'site' => (string) $this->links->get_site_link( $this->api->get_blog_id_for_output() ),
1244
			),
1245
		);
1246
1247
		return (object) $response;
1248
	}
1249
1250
	function get_media_item_v1_1( $media_id, $media_item = null, $file = null ) {
1251
1252
		if ( ! $media_item ) {
1253
			$media_item = get_post( $media_id );
1254
		}
1255
1256
		if ( ! $media_item || is_wp_error( $media_item ) ) {
1257
			return new WP_Error( 'unknown_media', 'Unknown Media', 404 );
1258
		}
1259
1260
		$attachment_file = get_attached_file( $media_item->ID );
1261
1262
		$file = basename( $attachment_file ? $attachment_file : $file );
1263
		$file_info = pathinfo( $file );
1264
		$ext  = isset( $file_info['extension'] ) ? $file_info['extension'] : null;
1265
1266
		$response = array(
1267
			'ID'           => $media_item->ID,
1268
			'URL'          => wp_get_attachment_url( $media_item->ID ),
1269
			'guid'         => $media_item->guid,
1270
			'date'         => (string) $this->format_date( $media_item->post_date_gmt, $media_item->post_date ),
1271
			'post_ID'      => $media_item->post_parent,
1272
			'author_ID'    => (int) $media_item->post_author,
1273
			'file'         => $file,
1274
			'mime_type'    => $media_item->post_mime_type,
1275
			'extension'    => $ext,
1276
			'title'        => $media_item->post_title,
1277
			'caption'      => $media_item->post_excerpt,
1278
			'description'  => $media_item->post_content,
1279
			'alt'          => get_post_meta( $media_item->ID, '_wp_attachment_image_alt', true ),
1280
			'icon'         => wp_mime_type_icon( $media_item->ID ),
1281
			'thumbnails'   => array()
1282
		);
1283
1284 View Code Duplication
		if ( in_array( $ext, array( 'jpg', 'jpeg', 'png', 'gif' ) ) ) {
1285
			$metadata = wp_get_attachment_metadata( $media_item->ID );
1286
			if ( isset( $metadata['height'], $metadata['width'] ) ) {
1287
				$response['height'] = $metadata['height'];
1288
				$response['width'] = $metadata['width'];
1289
			}
1290
1291
			if ( isset( $metadata['sizes'] ) ) {
1292
				/**
1293
				 * Filter the thumbnail sizes available for each attachment ID.
1294
				 *
1295
				 * @module json-api
1296
				 *
1297
				 * @since 3.9.0
1298
				 *
1299
				 * @param array $metadata['sizes'] Array of thumbnail sizes available for a given attachment ID.
1300
				 * @param string $media_id Attachment ID.
1301
				 */
1302
				$sizes = apply_filters( 'rest_api_thumbnail_sizes', $metadata['sizes'], $media_item->ID );
1303
				if ( is_array( $sizes ) ) {
1304
					foreach ( $sizes as $size => $size_details ) {
1305
						$response['thumbnails'][ $size ] = dirname( $response['URL'] ) . '/' . $size_details['file'];
1306
					}
1307
				}
1308
			}
1309
1310
			if ( isset( $metadata['image_meta'] ) ) {
1311
				$response['exif'] = $metadata['image_meta'];
1312
			}
1313
		}
1314
1315
		if ( in_array( $ext, array( 'mp3', 'm4a', 'wav', 'ogg' ) ) ) {
1316
			$metadata = wp_get_attachment_metadata( $media_item->ID );
1317
			$response['length'] = $metadata['length'];
1318
			$response['exif']   = $metadata;
1319
		}
1320
1321
		$is_video = false;
1322
1323
		if (
1324
			in_array( $ext, array( 'ogv', 'mp4', 'mov', 'wmv', 'avi', 'mpg', '3gp', '3g2', 'm4v' ) )
1325
			||
1326
			$response['mime_type'] === 'video/videopress'
1327
		) {
1328
			$is_video = true;
1329
		}
1330
1331
1332
		if ( $is_video ) {
1333
			$metadata = wp_get_attachment_metadata( $media_item->ID );
1334
1335
			if ( isset( $metadata['height'], $metadata['width'] ) ) {
1336
				$response['height'] = $metadata['height'];
1337
				$response['width']  = $metadata['width'];
1338
			}
1339
1340
			if ( isset( $metadata['length'] ) ) {
1341
				$response['length'] = $metadata['length'];
1342
			}
1343
1344
			// add VideoPress info
1345
			if ( function_exists( 'video_get_info_by_blogpostid' ) ) {
1346
				$info = video_get_info_by_blogpostid( $this->api->get_blog_id_for_output(), $media_item->ID );
1347
1348
				// If we failed to get VideoPress info, but it exists in the meta data (for some reason)
1349
				// then let's use that.
1350
				if ( false === $info && isset( $metadata['videopress'] ) ) {
1351
				    $info = (object) $metadata['videopress'];
1352
				}
1353
1354
				// Thumbnails
1355
				if ( function_exists( 'video_format_done' ) && function_exists( 'video_image_url_by_guid' ) ) {
1356
					$response['thumbnails'] = array( 'fmt_hd' => '', 'fmt_dvd' => '', 'fmt_std' => '' );
1357
					foreach ( $response['thumbnails'] as $size => $thumbnail_url ) {
1358
						if ( video_format_done( $info, $size ) ) {
1359
							$response['thumbnails'][ $size ] = video_image_url_by_guid( $info->guid, $size );
1360
						} else {
1361
							unset( $response['thumbnails'][ $size ] );
1362
						}
1363
					}
1364
				}
1365
1366
				// If we didn't get VideoPress information (for some reason) then let's
1367
				// not try and include it in the response.
1368
				if ( isset( $info->guid ) ) {
1369
					$response['videopress_guid']            = $info->guid;
1370
					$response['videopress_processing_done'] = true;
1371
					if ( '0000-00-00 00:00:00' === $info->finish_date_gmt ) {
1372
						$response['videopress_processing_done'] = false;
1373
					}
1374
				}
1375
			}
1376
		}
1377
1378
		$response['thumbnails'] = (object) $response['thumbnails'];
1379
1380
		$response['meta'] = (object) array(
1381
			'links' => (object) array(
1382
				'self' => (string) $this->links->get_media_link( $this->api->get_blog_id_for_output(), $media_item->ID ),
1383
				'help' => (string) $this->links->get_media_link( $this->api->get_blog_id_for_output(), $media_item->ID, 'help' ),
1384
				'site' => (string) $this->links->get_site_link( $this->api->get_blog_id_for_output() ),
1385
			),
1386
		);
1387
1388
		// add VideoPress link to the meta
1389
		if ( isset ( $response['videopress_guid'] ) ) {
1390
			if ( function_exists( 'video_get_info_by_blogpostid' ) ) {
1391
				$response['meta']->links->videopress = (string) $this->links->get_link( '/videos/%s', $response['videopress_guid'], '' );
1392
			}
1393
		}
1394
1395
		if ( $media_item->post_parent > 0 ) {
1396
			$response['meta']->links->parent = (string) $this->links->get_post_link( $this->api->get_blog_id_for_output(), $media_item->post_parent );
1397
		}
1398
1399
		return (object) $response;
1400
	}
1401
1402
	function get_taxonomy( $taxonomy_id, $taxonomy_type, $context ) {
1403
1404
		$taxonomy = get_term_by( 'slug', $taxonomy_id, $taxonomy_type );
1405
		/// keep updating this function
1406
		if ( !$taxonomy || is_wp_error( $taxonomy ) ) {
1407
			return new WP_Error( 'unknown_taxonomy', 'Unknown taxonomy', 404 );
1408
		}
1409
1410
		return $this->format_taxonomy( $taxonomy, $taxonomy_type, $context );
1411
	}
1412
1413
	function format_taxonomy( $taxonomy, $taxonomy_type, $context ) {
1414
		// Permissions
1415
		switch ( $context ) {
1416
		case 'edit' :
1417
			$tax = get_taxonomy( $taxonomy_type );
1418
			if ( !current_user_can( $tax->cap->edit_terms ) )
1419
				return new WP_Error( 'unauthorized', 'User cannot edit taxonomy', 403 );
1420
			break;
1421
		case 'display' :
1422
			if ( -1 == get_option( 'blog_public' ) && ! current_user_can( 'read' ) ) {
1423
				return new WP_Error( 'unauthorized', 'User cannot view taxonomy', 403 );
1424
			}
1425
			break;
1426
		default :
0 ignored issues
show
There must be no space before the colon in a DEFAULT statement

As per the PSR-2 coding standard, there must not be a space in front of the colon in the default statement.

switch ($expr) {
    default : //wrong
        doSomething();
        break;
}

switch ($expr) {
    default: //right
        doSomething();
        break;
}

To learn more about the PSR-2 coding standard, please refer to the PHP-Fig.

Loading history...
1427
			return new WP_Error( 'invalid_context', 'Invalid API CONTEXT', 400 );
1428
		}
1429
1430
		$response                = array();
1431
		$response['ID']          = (int) $taxonomy->term_id;
1432
		$response['name']        = (string) $taxonomy->name;
1433
		$response['slug']        = (string) $taxonomy->slug;
1434
		$response['description'] = (string) $taxonomy->description;
1435
		$response['post_count']  = (int) $taxonomy->count;
1436
1437
		if ( is_taxonomy_hierarchical( $taxonomy_type ) ) {
1438
			$response['parent'] = (int) $taxonomy->parent;
1439
		}
1440
1441
		$response['meta'] = (object) array(
1442
			'links' => (object) array(
1443
				'self' => (string) $this->links->get_taxonomy_link( $this->api->get_blog_id_for_output(), $taxonomy->slug, $taxonomy_type ),
1444
				'help' => (string) $this->links->get_taxonomy_link( $this->api->get_blog_id_for_output(), $taxonomy->slug, $taxonomy_type, 'help' ),
1445
				'site' => (string) $this->links->get_site_link( $this->api->get_blog_id_for_output() ),
1446
			),
1447
		);
1448
1449
		return (object) $response;
1450
	}
1451
1452
	/**
1453
	 * Returns ISO 8601 formatted datetime: 2011-12-08T01:15:36-08:00
1454
	 *
1455
	 * @param $date_gmt (string) GMT datetime string.
1456
	 * @param $date (string) Optional.  Used to calculate the offset from GMT.
1457
	 *
1458
	 * @return string
1459
	 */
1460
	function format_date( $date_gmt, $date = null ) {
1461
		return WPCOM_JSON_API_Date::format_date( $date_gmt, $date );
1462
	}
1463
1464
	/**
1465
	 * Parses a date string and returns the local and GMT representations
1466
	 * of that date & time in 'YYYY-MM-DD HH:MM:SS' format without
1467
	 * timezones or offsets. If the parsed datetime was not localized to a
1468
	 * particular timezone or offset we will assume it was given in GMT
1469
	 * relative to now and will convert it to local time using either the
1470
	 * timezone set in the options table for the blog or the GMT offset.
1471
	 *
1472
	 * @param datetime string
1473
	 *
1474
	 * @return array( $local_time_string, $gmt_time_string )
0 ignored issues
show
The doc-type array( could not be parsed: Expected "|" or "end of type", but got "(" at position 5. (view supported doc-types)

This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types.

Loading history...
1475
	 */
1476
	function parse_date( $date_string ) {
1477
		$date_string_info = date_parse( $date_string );
1478
		if ( is_array( $date_string_info ) && 0 === $date_string_info['error_count'] ) {
1479
			// Check if it's already localized. Can't just check is_localtime because date_parse('oppossum') returns true; WTF, PHP.
1480
			if ( isset( $date_string_info['zone'] ) && true === $date_string_info['is_localtime'] ) {
1481
				$dt_local = clone $dt_utc = new DateTime( $date_string );
1482
				$dt_utc->setTimezone( new DateTimeZone( 'UTC' ) );
1483
				return array(
1484
					(string) $dt_local->format( 'Y-m-d H:i:s' ),
1485
					(string) $dt_utc->format( 'Y-m-d H:i:s' ),
1486
				);
1487
			}
1488
1489
			// It's parseable but no TZ info so assume UTC
1490
			$dt_local = clone $dt_utc = new DateTime( $date_string, new DateTimeZone( 'UTC' ) );
1491
		} else {
1492
			// Could not parse time, use now in UTC
1493
			$dt_local = clone $dt_utc = new DateTime( 'now', new DateTimeZone( 'UTC' ) );
1494
		}
1495
1496
		// First try to use timezone as it's daylight savings aware.
1497
		$timezone_string = get_option( 'timezone_string' );
1498
		if ( $timezone_string ) {
1499
			$tz = timezone_open( $timezone_string );
1500
			if ( $tz ) {
1501
				$dt_local->setTimezone( $tz );
1502
				return array(
1503
					(string) $dt_local->format( 'Y-m-d H:i:s' ),
1504
					(string) $dt_utc->format( 'Y-m-d H:i:s' ),
1505
				);
1506
			}
1507
		}
1508
1509
		// Fallback to GMT offset (in hours)
1510
		// NOTE: TZ of $dt_local is still UTC, we simply modified the timestamp with an offset.
1511
		$gmt_offset_seconds = intval( get_option( 'gmt_offset' ) * 3600 );
1512
		$dt_local->modify("+{$gmt_offset_seconds} seconds");
1513
		return array(
1514
			(string) $dt_local->format( 'Y-m-d H:i:s' ),
1515
			(string) $dt_utc->format( 'Y-m-d H:i:s' ),
1516
		);
1517
	}
1518
1519
	// Load the functions.php file for the current theme to get its post formats, CPTs, etc.
1520
	function load_theme_functions() {
1521
		// bail if we've done this already (can happen when calling /batch endpoint)
1522
		if ( defined( 'REST_API_THEME_FUNCTIONS_LOADED' ) )
1523
			return;
1524
1525
		// VIP context loading is handled elsewhere, so bail to prevent
1526
		// duplicate loading. See `switch_to_blog_and_validate_user()`
1527
		if ( function_exists( 'wpcom_is_vip' ) && wpcom_is_vip() ) {
1528
			return;
1529
		}
1530
1531
		define( 'REST_API_THEME_FUNCTIONS_LOADED', true );
1532
1533
		// the theme info we care about is found either within functions.php or one of the jetpack files.
1534
		$function_files = array( '/functions.php', '/inc/jetpack.compat.php', '/inc/jetpack.php', '/includes/jetpack.compat.php' );
1535
1536
		$copy_dirs = array( get_template_directory() );
1537
1538
		// Is this a child theme? Load the child theme's functions file.
1539
		if ( get_stylesheet_directory() !== get_template_directory() && wpcom_is_child_theme() ) {
1540
			foreach ( $function_files as $function_file ) {
1541
				if ( file_exists( get_stylesheet_directory() . $function_file ) ) {
1542
					require_once(  get_stylesheet_directory() . $function_file );
1543
				}
1544
			}
1545
			$copy_dirs[] = get_stylesheet_directory();
1546
		}
1547
1548
		foreach ( $function_files as $function_file ) {
1549
			if ( file_exists( get_template_directory() . $function_file ) ) {
1550
				require_once(  get_template_directory() . $function_file );
1551
			}
1552
		}
1553
1554
		// add inc/wpcom.php and/or includes/wpcom.php
1555
		wpcom_load_theme_compat_file();
1556
1557
		// Enable including additional directories or files in actions to be copied
1558
		$copy_dirs = apply_filters( 'restapi_theme_action_copy_dirs', $copy_dirs );
1559
1560
		// since the stuff we care about (CPTS, post formats, are usually on setup or init hooks, we want to load those)
1561
		$this->copy_hooks( 'after_setup_theme', 'restapi_theme_after_setup_theme', $copy_dirs );
1562
1563
		/**
1564
		 * Fires functions hooked onto `after_setup_theme` by the theme for the purpose of the REST API.
1565
		 *
1566
		 * The REST API does not load the theme when processing requests.
1567
		 * To enable theme-based functionality, the API will load the '/functions.php',
1568
		 * '/inc/jetpack.compat.php', '/inc/jetpack.php', '/includes/jetpack.compat.php files
1569
		 * of the theme (parent and child) and copy functions hooked onto 'after_setup_theme' within those files.
1570
		 *
1571
		 * @module json-api
1572
		 *
1573
		 * @since 3.2.0
1574
		 */
1575
		do_action( 'restapi_theme_after_setup_theme' );
1576
		$this->copy_hooks( 'init', 'restapi_theme_init', $copy_dirs );
1577
1578
		/**
1579
		 * Fires functions hooked onto `init` by the theme for the purpose of the REST API.
1580
		 *
1581
		 * The REST API does not load the theme when processing requests.
1582
		 * To enable theme-based functionality, the API will load the '/functions.php',
1583
		 * '/inc/jetpack.compat.php', '/inc/jetpack.php', '/includes/jetpack.compat.php files
1584
		 * of the theme (parent and child) and copy functions hooked onto 'init' within those files.
1585
		 *
1586
		 * @module json-api
1587
		 *
1588
		 * @since 3.2.0
1589
		 */
1590
		do_action( 'restapi_theme_init' );
1591
	}
1592
1593
	function copy_hooks( $from_hook, $to_hook, $base_paths ) {
1594
		global $wp_filter;
1595
		foreach ( $wp_filter as $hook => $actions ) {
1596
1597
			if ( $from_hook != $hook ) {
1598
				continue;
1599
			}
1600
			if ( ! has_action( $hook ) ) {
1601
				continue;
1602
			}
1603
1604
			foreach ( $actions as $priority => $callbacks ) {
1605
				foreach( $callbacks as $callback_key => $callback_data ) {
1606
					$callback = $callback_data['function'];
1607
1608
					// use reflection api to determine filename where function is defined
1609
					$reflection = $this->get_reflection( $callback );
1610
1611
					if ( false !== $reflection ) {
1612
						$file_name = $reflection->getFileName();
1613
						foreach( $base_paths as $base_path ) {
1614
1615
							// only copy hooks with functions which are part of the specified files
1616
							if ( 0 === strpos( $file_name, $base_path ) ) {
1617
								add_action(
1618
									$to_hook,
1619
									$callback_data['function'],
1620
									$priority,
1621
									$callback_data['accepted_args']
1622
								);
1623
							}
1624
						}
1625
					}
1626
				}
1627
			}
1628
		}
1629
	}
1630
1631
	function get_reflection( $callback ) {
1632
		if ( is_array( $callback ) ) {
1633
			list( $class, $method ) = $callback;
1634
			return new ReflectionMethod( $class, $method );
1635
		}
1636
1637
		if ( is_string( $callback ) && strpos( $callback, "::" ) !== false ) {
1638
			list( $class, $method ) = explode( "::", $callback );
1639
			return new ReflectionMethod( $class, $method );
1640
		}
1641
1642
		if ( version_compare( PHP_VERSION, "5.3.0", ">=" ) && method_exists( $callback, "__invoke" ) ) {
1643
			return new ReflectionMethod( $callback, "__invoke" );
1644
		}
1645
1646
		if ( is_string( $callback ) && strpos( $callback, "::" ) == false && function_exists( $callback ) ) {
0 ignored issues
show
Bug Best Practice introduced by
It seems like you are loosely comparing strpos($callback, '::') of type integer to the boolean false. If you are specifically checking for 0, consider using something more explicit like === 0 instead.
Loading history...
1647
			return new ReflectionFunction( $callback );
1648
		}
1649
1650
		return false;
1651
	}
1652
1653
	/**
1654
	* Check whether a user can view or edit a post type
1655
	* @param string $post_type              post type to check
1656
	* @param string $context                'display' or 'edit'
1657
	* @return bool
1658
	*/
1659 View Code Duplication
	function current_user_can_access_post_type( $post_type, $context='display' ) {
1660
		$post_type_object = get_post_type_object( $post_type );
1661
		if ( ! $post_type_object ) {
1662
			return false;
1663
		}
1664
1665
		switch( $context ) {
1666
			case 'edit':
1667
				return current_user_can( $post_type_object->cap->edit_posts );
1668
			case 'display':
1669
				return $post_type_object->public || current_user_can( $post_type_object->cap->read_private_posts );
1670
			default:
1671
				return false;
1672
		}
1673
	}
1674
1675 View Code Duplication
	function is_post_type_allowed( $post_type ) {
1676
		// if the post type is empty, that's fine, WordPress will default to post
1677
		if ( empty( $post_type ) ) {
1678
			return true;
1679
		}
1680
1681
		// allow special 'any' type
1682
		if ( 'any' == $post_type ) {
1683
			return true;
1684
		}
1685
1686
		// check for allowed types
1687
		if ( in_array( $post_type, $this->_get_whitelisted_post_types() ) ) {
1688
			return true;
1689
		}
1690
1691
		if ( $post_type_object = get_post_type_object( $post_type ) ) {
1692
			if ( ! empty( $post_type_object->show_in_rest ) ) {
1693
				return $post_type_object->show_in_rest;
1694
			}
1695
			if ( ! empty( $post_type_object->publicly_queryable ) ) {
1696
				return $post_type_object->publicly_queryable;
1697
			}
1698
		}
1699
1700
		return ! empty( $post_type_object->public );
1701
	}
1702
1703
	/**
1704
	 * Gets the whitelisted post types that JP should allow access to.
1705
	 *
1706
	 * @return array Whitelisted post types.
1707
	 */
1708 View Code Duplication
	protected function _get_whitelisted_post_types() {
1709
		$allowed_types = array( 'post', 'page', 'revision' );
1710
1711
		/**
1712
		 * Filter the post types Jetpack has access to, and can synchronize with WordPress.com.
1713
		 *
1714
		 * @module json-api
1715
		 *
1716
		 * @since 2.2.3
1717
		 *
1718
		 * @param array $allowed_types Array of whitelisted post types. Default to `array( 'post', 'page', 'revision' )`.
1719
		 */
1720
		$allowed_types = apply_filters( 'rest_api_allowed_post_types', $allowed_types );
1721
1722
		return array_unique( $allowed_types );
1723
	}
1724
1725
	function handle_media_creation_v1_1( $media_files, $media_urls, $media_attrs = array(), $force_parent_id = false ) {
1726
1727
		add_filter( 'upload_mimes', array( $this, 'allow_video_uploads' ) );
1728
1729
		$media_ids = $errors = array();
1730
		$user_can_upload_files = current_user_can( 'upload_files' ) || $this->api->is_authorized_with_upload_token();
0 ignored issues
show
The method is_authorized_with_upload_token() does not seem to exist on object<WPCOM_JSON_API>.

This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces.

This is most likely a typographical error or the method has been renamed.

Loading history...
1731
		$media_attrs = array_values( $media_attrs ); // reset the keys
1732
		$i = 0;
1733
1734
		if ( ! empty( $media_files ) ) {
1735
			$this->api->trap_wp_die( 'upload_error' );
1736
			foreach ( $media_files as $media_item ) {
1737
				$_FILES['.api.media.item.'] = $media_item;
1738 View Code Duplication
				if ( ! $user_can_upload_files ) {
1739
					$media_id = new WP_Error( 'unauthorized', 'User cannot upload media.', 403 );
1740
				} else {
1741
					if ( $force_parent_id ) {
1742
						$parent_id = absint( $force_parent_id );
1743
					} elseif ( ! empty( $media_attrs[$i] ) && ! empty( $media_attrs[$i]['parent_id'] ) ) {
1744
						$parent_id = absint( $media_attrs[$i]['parent_id'] );
1745
					} else {
1746
						$parent_id = 0;
1747
					}
1748
					$media_id = media_handle_upload( '.api.media.item.', $parent_id );
1749
				}
1750
				if ( is_wp_error( $media_id ) ) {
1751
					$errors[$i]['file']   = $media_item['name'];
1752
					$errors[$i]['error']   = $media_id->get_error_code();
1753
					$errors[$i]['message'] = $media_id->get_error_message();
1754
				} else {
1755
					$media_ids[$i] = $media_id;
1756
				}
1757
1758
				$i++;
1759
			}
1760
			$this->api->trap_wp_die( null );
1761
			unset( $_FILES['.api.media.item.'] );
1762
		}
1763
1764
		if ( ! empty( $media_urls ) ) {
1765
			foreach ( $media_urls as $url ) {
1766 View Code Duplication
				if ( ! $user_can_upload_files ) {
1767
					$media_id = new WP_Error( 'unauthorized', 'User cannot upload media.', 403 );
1768
				} else {
1769
					if ( $force_parent_id ) {
1770
						$parent_id = absint( $force_parent_id );
1771
					} else if ( ! empty( $media_attrs[$i] ) && ! empty( $media_attrs[$i]['parent_id'] ) ) {
1772
						$parent_id = absint( $media_attrs[$i]['parent_id'] );
1773
					} else {
1774
						$parent_id = 0;
1775
					}
1776
					$media_id = $this->handle_media_sideload( $url, $parent_id );
1777
				}
1778
				if ( is_wp_error( $media_id ) ) {
1779
					$errors[$i] = array(
1780
						'file'    => $url,
1781
						'error'   => $media_id->get_error_code(),
1782
						'message' => $media_id->get_error_message(),
1783
					);
1784
				} elseif ( ! empty( $media_id ) ) {
1785
					$media_ids[$i] = $media_id;
1786
				}
1787
1788
				$i++;
1789
			}
1790
		}
1791
1792
		if ( ! empty( $media_attrs ) ) {
1793
			foreach ( $media_ids as $index => $media_id ) {
1794
				if ( empty( $media_attrs[$index] ) )
1795
					continue;
1796
1797
				$attrs = $media_attrs[$index];
1798
				$insert = array();
1799
1800
				// Attributes: Title, Caption, Description
1801
1802
				if ( isset( $attrs['title'] ) ) {
1803
					$insert['post_title'] = $attrs['title'];
1804
				}
1805
1806
				if ( isset( $attrs['caption'] ) ) {
1807
					$insert['post_excerpt'] = $attrs['caption'];
1808
				}
1809
1810
				if ( isset( $attrs['description'] ) ) {
1811
					$insert['post_content'] = $attrs['description'];
1812
				}
1813
1814
				if ( ! empty( $insert ) ) {
1815
					$insert['ID'] = $media_id;
1816
					wp_update_post( (object) $insert );
1817
				}
1818
1819
				// Attributes: Alt
1820
1821 View Code Duplication
				if ( isset( $attrs['alt'] ) ) {
1822
					$alt = wp_strip_all_tags( $attrs['alt'], true );
1823
					update_post_meta( $media_id, '_wp_attachment_image_alt', $alt );
1824
				}
1825
1826
				// Attributes: Artist, Album
1827
1828
				$id3_meta = array();
1829
1830 View Code Duplication
				foreach ( array( 'artist', 'album' ) as $key ) {
1831
					if ( isset( $attrs[ $key ] ) ) {
1832
						$id3_meta[ $key ] = wp_strip_all_tags( $attrs[ $key ], true );
1833
					}
1834
				}
1835
1836 View Code Duplication
				if ( ! empty( $id3_meta ) ) {
1837
					// Before updating metadata, ensure that the item is audio
1838
					$item = $this->get_media_item_v1_1( $media_id );
1839
					if ( 0 === strpos( $item->mime_type, 'audio/' ) ) {
1840
						wp_update_attachment_metadata( $media_id, $id3_meta );
1841
					}
1842
				}
1843
			}
1844
		}
1845
1846
		return array( 'media_ids' => $media_ids, 'errors' => $errors );
1847
1848
	}
1849
1850
	function handle_media_sideload( $url, $parent_post_id = 0, $type = 'any' ) {
1851
		if ( ! function_exists( 'download_url' ) || ! function_exists( 'media_handle_sideload' ) )
1852
			return false;
1853
1854
		// if we didn't get a URL, let's bail
1855
		$parsed = @parse_url( $url );
1856
		if ( empty( $parsed ) )
1857
			return false;
1858
1859
		$tmp = download_url( $url );
1860
		if ( is_wp_error( $tmp ) ) {
1861
			return $tmp;
1862
		}
1863
1864
		// First check to see if we get a mime-type match by file, otherwise, check to
1865
		// see if WordPress supports this file as an image. If neither, then it is not supported.
1866 View Code Duplication
		if ( ! $this->is_file_supported_for_sideloading( $tmp ) || 'image' === $type && ! file_is_displayable_image( $tmp ) ) {
1867
			@unlink( $tmp );
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...
1868
			return new WP_Error( 'invalid_input', 'Invalid file type.', 403 );
1869
		}
1870
1871
		// emulate a $_FILES entry
1872
		$file_array = array(
1873
			'name' => basename( parse_url( $url, PHP_URL_PATH ) ),
1874
			'tmp_name' => $tmp,
1875
		);
1876
1877
		$id = media_handle_sideload( $file_array, $parent_post_id );
1878
		if ( file_exists( $tmp ) ) {
1879
			@unlink( $tmp );
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...
1880
		}
1881
1882
		if ( is_wp_error( $id ) ) {
1883
			return $id;
1884
		}
1885
1886
		if ( ! $id || ! is_int( $id ) ) {
1887
			return false;
1888
		}
1889
1890
		return $id;
1891
	}
1892
1893
	/**
1894
	 * Checks that the mime type of the specified file is among those in a filterable list of mime types.
1895
	 *
1896
	 * @param string $file Path to file to get its mime type.
1897
	 *
1898
	 * @return bool
1899
	 */
1900 View Code Duplication
	protected function is_file_supported_for_sideloading( $file ) {
1901
		if ( class_exists( 'finfo' ) ) { // php 5.3+
1902
			$finfo = new finfo( FILEINFO_MIME );
1903
			$mime = explode( '; ', $finfo->file( $file ) );
1904
			$type = $mime[0];
1905
1906
		} elseif ( function_exists( 'mime_content_type' ) ) { // PHP 5.2
1907
			$type = mime_content_type( $file );
1908
1909
		} else {
1910
			return false;
1911
		}
1912
1913
		/**
1914
		 * Filter the list of supported mime types for media sideloading.
1915
		 *
1916
		 * @since 4.0.0
1917
		 *
1918
		 * @module json-api
1919
		 *
1920
		 * @param array $supported_mime_types Array of the supported mime types for media sideloading.
1921
		 */
1922
		$supported_mime_types = apply_filters( 'jetpack_supported_media_sideload_types', array(
1923
			'image/png',
1924
			'image/jpeg',
1925
			'image/gif',
1926
			'image/bmp',
1927
			'video/quicktime',
1928
			'video/mp4',
1929
			'video/mpeg',
1930
			'video/ogg',
1931
			'video/3gpp',
1932
			'video/3gpp2',
1933
			'video/h261',
1934
			'video/h262',
1935
			'video/h264',
1936
			'video/x-msvideo',
1937
			'video/x-ms-wmv',
1938
			'video/x-ms-asf',
1939
		) );
1940
1941
		// If the type returned was not an array as expected, then we know we don't have a match.
1942
		if ( ! is_array( $supported_mime_types ) ) {
1943
			return false;
1944
		}
1945
1946
		return in_array( $type, $supported_mime_types );
1947
	}
1948
1949
	function allow_video_uploads( $mimes ) {
1950
		// if we are on Jetpack, bail - Videos are already allowed
1951
		if ( ! defined( 'IS_WPCOM' ) || !IS_WPCOM ) {
1952
			return $mimes;
1953
		}
1954
1955
		// extra check that this filter is only ever applied during REST API requests
1956
		if ( ! defined( 'REST_API_REQUEST' ) || ! REST_API_REQUEST ) {
1957
			return $mimes;
1958
		}
1959
1960
		// bail early if they already have the upgrade..
1961
		if ( get_option( 'video_upgrade' ) == '1' ) {
1962
			return $mimes;
1963
		}
1964
1965
		// lets whitelist to only specific clients right now
1966
		$clients_allowed_video_uploads = array();
1967
		/**
1968
		 * Filter the list of whitelisted video clients.
1969
		 *
1970
		 * @module json-api
1971
		 *
1972
		 * @since 3.2.0
1973
		 *
1974
		 * @param array $clients_allowed_video_uploads Array of whitelisted Video clients.
1975
		 */
1976
		$clients_allowed_video_uploads = apply_filters( 'rest_api_clients_allowed_video_uploads', $clients_allowed_video_uploads );
1977
		if ( !in_array( $this->api->token_details['client_id'], $clients_allowed_video_uploads ) ) {
1978
			return $mimes;
1979
		}
1980
1981
		$mime_list = wp_get_mime_types();
1982
1983
		$video_exts = explode( ' ', get_site_option( 'video_upload_filetypes', false, false ) );
1984
		/**
1985
		 * Filter the video filetypes allowed on the site.
1986
		 *
1987
		 * @module json-api
1988
		 *
1989
		 * @since 3.2.0
1990
		 *
1991
		 * @param array $video_exts Array of video filetypes allowed on the site.
1992
		 */
1993
		$video_exts = apply_filters( 'video_upload_filetypes', $video_exts );
1994
		$video_mimes = array();
1995
1996
		if ( !empty( $video_exts ) ) {
1997
			foreach ( $video_exts as $ext ) {
1998
				foreach ( $mime_list as $ext_pattern => $mime ) {
1999
					if ( $ext != '' && strpos( $ext_pattern, $ext ) !== false )
2000
						$video_mimes[$ext_pattern] = $mime;
2001
				}
2002
			}
2003
2004
			$mimes = array_merge( $mimes, $video_mimes );
2005
		}
2006
2007
		return $mimes;
2008
	}
2009
2010
	function is_current_site_multi_user() {
2011
		$users = wp_cache_get( 'site_user_count', 'WPCOM_JSON_API_Endpoint' );
2012
		if ( false === $users ) {
2013
			$user_query = new WP_User_Query( array(
2014
				'blog_id' => get_current_blog_id(),
2015
				'fields'  => 'ID',
2016
			) );
2017
			$users = (int) $user_query->get_total();
2018
			wp_cache_set( 'site_user_count', $users, 'WPCOM_JSON_API_Endpoint', DAY_IN_SECONDS );
2019
		}
2020
		return $users > 1;
2021
	}
2022
2023
	function allows_cross_origin_requests() {
2024
		return 'GET' == $this->method || $this->allow_cross_origin_request;
2025
	}
2026
2027
	function allows_unauthorized_requests( $origin, $complete_access_origins  ) {
2028
		return 'GET' == $this->method || ( $this->allow_unauthorized_request && in_array( $origin, $complete_access_origins ) );
2029
	}
2030
2031
	function get_platform() {
2032
		return wpcom_get_sal_platform( $this->api->token_details );
2033
	}
2034
2035
	/**
2036
	 * Allows the endpoint to perform logic to allow it to decide whether-or-not it should force a
2037
	 * response from the WPCOM API, or potentially go to the Jetpack blog.
2038
	 *
2039
	 * Override this method if you want to do something different.
2040
	 *
2041
	 * @param  int  $blog_id
2042
	 * @return bool
2043
	 */
2044
	function force_wpcom_request( $blog_id ) {
2045
		return false;
2046
	}
2047
2048
	/**
2049
	 * Return endpoint response
2050
	 *
2051
	 * @param ... determined by ->$path
2052
	 *
2053
	 * @return
2054
	 * 	falsy: HTTP 500, no response body
2055
	 *	WP_Error( $error_code, $error_message, $http_status_code ): HTTP $status_code, json_encode( array( 'error' => $error_code, 'message' => $error_message ) ) response body
2056
	 *	$data: HTTP 200, json_encode( $data ) response body
2057
	 */
2058
	abstract function callback( $path = '' );
2059
2060
2061
}
2062
2063
require_once( dirname( __FILE__ ) . '/json-endpoints.php' );
2064