Completed
Push — update/dialogue-focus-on-conte... ( 9f1745...fa862f )
by
unknown
80:03 queued 71:18
created

...com-json-api-render-embed-reversal-endpoint.php (6 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
new WPCOM_JSON_API_Render_Embed_Reversal_Endpoint( array(
4
	'description' => "Determines if the given embed code can be reversed into a single line embed or a shortcode, and if so returns the embed or shortcode. Note: The current user must have publishing access.",
5
	//'group'       => 'sites',
6
	'group'       => '__do_not_document',
7
	'stat'        => 'embeds:reversal',
8
	'method'      => 'POST',
9
	'path'        => '/sites/%s/embeds/reversal',
10
	'path_labels' => array(
11
		'$site'    => '(int|string) Site ID or domain',
12
	),
13
	'request_format' => array(
14
		'maybe_embed' => '(string) The embed code to reverse. Required. Only accepts one at a time.',
15
	),
16
	'response_format' => array(
17
		'maybe_embed' => '(string) The original embed code that was passed in for rendering.',
18
		'reversal_type' => '(string) The type of reversal. Either an embed or a shortcode.',
19
		'render_result' => '(html) The rendered HTML result of the embed or shortcode.',
20
		'result' => '(string) The reversed content. Either a single line embed or a shortcode.',
21
		'scripts'   => '(array) An array of JavaScript files needed to render the embed or shortcode. Returned in the format of <code>{ "script-slug" : { "src": "http://example.com/file.js", "extra" : "" } }</code> where extra contains any neccessary extra JS for initializing the source file and src contains the script to load. Omitted if no scripts are neccessary.',
22
		'styles'    => '(array) An array of CSS files needed to render the embed or shortcode. Returned in the format of <code>{ "style-slug" : { "src": "http://example.com/file.css", "media" : "all" } }</code>. Omitted if no styles are neccessary.',
23
	),
24
	'example_request'      => 'https://public-api.wordpress.com/rest/v1/sites/82974409/shortcode-reversals/render/',
25
	'example_request_data' => array(
26
		'headers' => array(
27
			'authorization' => 'Bearer YOUR_API_TOKEN'
28
		),
29
30
		'body' => array(
31
			'maybe_embed' => '<iframe width="480" height="302" src="http://www.ustream.tv/embed/recorded/26370522/highlight/299667?v=3&amp;wmode=direct" scrolling="no" frameborder="0"></iframe>',
32
		)
33
	),
34
) );
35
36
class WPCOM_JSON_API_Render_Embed_Reversal_Endpoint extends WPCOM_JSON_API_Render_Endpoint {
37
	// /sites/%s/embeds/reversal -> $blog_id
38
	function callback( $path = '', $blog_id = 0 ) {
39
		$blog_id = $this->api->switch_to_blog_and_validate_user( $this->api->get_blog_id( $blog_id ) );
40
		if ( is_wp_error( $blog_id ) ) {
41
			return $blog_id;
42
		}
43
44
		if ( ! current_user_can( 'edit_posts' ) ) {
45
			return new WP_Error( 'unauthorized', 'Your token must have permission to post on this blog.', 403 );
0 ignored issues
show
The call to WP_Error::__construct() has too many arguments starting with 'unauthorized'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
46
		}
47
48
		$is_shortcode = $is_embed = false;
49
50
		$input = $this->input( true );
51
		$maybe_embed = trim( $input['maybe_embed'] );
52
		if ( empty( $maybe_embed ) ) {
53
			return new WP_Error( 'empty_embed', 'Please provide an embed code to process.', 400 );
0 ignored issues
show
The call to WP_Error::__construct() has too many arguments starting with 'empty_embed'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
54
		}
55
56
		$ksesed_content = trim( wp_strip_all_tags( wp_kses_post( $maybe_embed ), true ) );
57
		if ( empty( $ksesed_content ) ) {
58
			return new WP_Error( 'invalid_embed', 'Invalid or empty embed provided.', 400 );
0 ignored issues
show
The call to WP_Error::__construct() has too many arguments starting with 'invalid_embed'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
59
		}
60
61
		$shortcode_pattern = get_shortcode_regex();
62
		$url_pattern = '/^http(s)?:\/\/[a-z0-9-]+(.[a-z0-9-]+)*(:[0-9]+)?(\/.*)?$/i';
63
		preg_match_all( "/$shortcode_pattern/s", $ksesed_content, $shortcode_matches );
64
		preg_match_all( "$url_pattern", $ksesed_content, $url_matches );
65
66
		if ( empty( $shortcode_matches[0] ) && empty( $url_matches[0] ) )
67
			return new WP_Error( 'invalid_embed', 'The provided embed is not supported.', 400 );
0 ignored issues
show
The call to WP_Error::__construct() has too many arguments starting with 'invalid_embed'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
68
69
		if ( ( count( $shortcode_matches[0] ) + count( $url_matches[0] ) ) > 1 ) {
70
			return new WP_Error( 'invalid_embed', 'Only one embed/shortcode reversal can be rendered at a time.', 400 );
0 ignored issues
show
The call to WP_Error::__construct() has too many arguments starting with 'invalid_embed'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
71
		}
72
73
		if ( ! empty( $shortcode_matches[0] ) ) {
74
			$is_shortcode = true;
75
		} elseif ( ! empty( $url_matches[0] ) ) {
76
			$is_embed = true;
77
		}
78
79
		$render = $this->process_render( array( $this, 'render_shortcode_reversal' ), array( 'shortcode_reversal' => $ksesed_content, 'is_shortcode' => $is_shortcode, 'is_embed' => $is_embed ) );
80
81
82
		// if nothing happened, then the shortcode does not exist.
83
		global $wp_embed;
84
		if ( empty( $render ) || empty( $render['result'] ) || $ksesed_content == $render['result'] || $wp_embed->maybe_make_link( $maybe_embed ) == $render['result'] ) {
85
			return new WP_Error( 'invalid_embed',  'The provided embed is not supported.', 400 );
0 ignored issues
show
The call to WP_Error::__construct() has too many arguments starting with 'invalid_embed'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
86
		}
87
88
		// our output for this endpoint..
89
		$return['maybe_embed'] = $maybe_embed;
90
		$return['result'] = $ksesed_content;
91
		$return['reversal_type'] = ( $is_embed ) ? 'embed' : 'shortcode';
92
		$return['render_result'] = $render['result'];
93
94
		$return = $this->add_assets( $return, $render['loaded_scripts'], $render['loaded_styles'] );
95
96
		return $return;
97
	}
98
99
	function render_shortcode_reversal( $args ) {
100
		if ( $args['is_shortcode'] ) {
101
			return call_user_func( array( $this, 'do_shortcode' ), $args['shortcode_reversal'] );
102
		} else if ( $args['is_embed'] ) {
103
			return call_user_func( array( $this, 'do_embed' ), $args['shortcode_reversal'] );
104
		}
105
		return false;
106
	}
107
108
}