wp/wp-includes/class-wp-oembed-controller.php
changeset 7 cf61fcea0001
child 9 177826044cd9
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/wp/wp-includes/class-wp-oembed-controller.php	Mon Oct 14 17:39:30 2019 +0200
@@ -0,0 +1,200 @@
+<?php
+/**
+ * WP_oEmbed_Controller class, used to provide an oEmbed endpoint.
+ *
+ * @package WordPress
+ * @subpackage Embeds
+ * @since 4.4.0
+ */
+
+/**
+ * oEmbed API endpoint controller.
+ *
+ * Registers the API route and delivers the response data.
+ * The output format (XML or JSON) is handled by the REST API.
+ *
+ * @since 4.4.0
+ */
+final class WP_oEmbed_Controller {
+	/**
+	 * Register the oEmbed REST API route.
+	 *
+	 * @since 4.4.0
+	 */
+	public function register_routes() {
+		/**
+		 * Filters the maxwidth oEmbed parameter.
+		 *
+		 * @since 4.4.0
+		 *
+		 * @param int $maxwidth Maximum allowed width. Default 600.
+		 */
+		$maxwidth = apply_filters( 'oembed_default_width', 600 );
+
+		register_rest_route( 'oembed/1.0', '/embed', array(
+			array(
+				'methods'  => WP_REST_Server::READABLE,
+				'callback' => array( $this, 'get_item' ),
+				'args'     => array(
+					'url'      => array(
+						'required'          => true,
+						'sanitize_callback' => 'esc_url_raw',
+					),
+					'format'   => array(
+						'default'           => 'json',
+						'sanitize_callback' => 'wp_oembed_ensure_format',
+					),
+					'maxwidth' => array(
+						'default'           => $maxwidth,
+						'sanitize_callback' => 'absint',
+					),
+				),
+			),
+		) );
+
+		register_rest_route( 'oembed/1.0', '/proxy', array(
+			array(
+				'methods'  => WP_REST_Server::READABLE,
+				'callback' => array( $this, 'get_proxy_item' ),
+				'permission_callback' => array( $this, 'get_proxy_item_permissions_check' ),
+				'args'     => array(
+					'url'      => array(
+						'description'       => __( 'The URL of the resource for which to fetch oEmbed data.' ),
+						'type'              => 'string',
+						'required'          => true,
+						'sanitize_callback' => 'esc_url_raw',
+					),
+					'format'   => array(
+						'description'       => __( 'The oEmbed format to use.' ),
+						'type'              => 'string',
+						'default'           => 'json',
+						'enum'              => array(
+							'json',
+							'xml',
+						),
+					),
+					'maxwidth' => array(
+						'description'       => __( 'The maximum width of the embed frame in pixels.' ),
+						'type'              => 'integer',
+						'default'           => $maxwidth,
+						'sanitize_callback' => 'absint',
+					),
+					'maxheight' => array(
+						'description'       => __( 'The maximum height of the embed frame in pixels.' ),
+						'type'              => 'integer',
+						'sanitize_callback' => 'absint',
+					),
+					'discover' => array(
+						'description'       => __( 'Whether to perform an oEmbed discovery request for non-whitelisted providers.' ),
+						'type'              => 'boolean',
+						'default'           => true,
+					),
+				),
+			),
+		) );
+	}
+
+	/**
+	 * Callback for the embed API endpoint.
+	 *
+	 * Returns the JSON object for the post.
+	 *
+	 * @since 4.4.0
+	 *
+	 * @param WP_REST_Request $request Full data about the request.
+	 * @return WP_Error|array oEmbed response data or WP_Error on failure.
+	 */
+	public function get_item( $request ) {
+		$post_id = url_to_postid( $request['url'] );
+
+		/**
+		 * Filters the determined post ID.
+		 *
+		 * @since 4.4.0
+		 *
+		 * @param int    $post_id The post ID.
+		 * @param string $url     The requested URL.
+		 */
+		$post_id = apply_filters( 'oembed_request_post_id', $post_id, $request['url'] );
+
+		$data = get_oembed_response_data( $post_id, $request['maxwidth'] );
+
+		if ( ! $data ) {
+			return new WP_Error( 'oembed_invalid_url', get_status_header_desc( 404 ), array( 'status' => 404 ) );
+		}
+
+		return $data;
+	}
+
+	/**
+	 * Checks if current user can make a proxy oEmbed request.
+	 *
+	 * @since 4.8.0
+	 *
+	 * @return true|WP_Error True if the request has read access, WP_Error object otherwise.
+	 */
+	public function get_proxy_item_permissions_check() {
+		if ( ! current_user_can( 'edit_posts' ) ) {
+			return new WP_Error( 'rest_forbidden', __( 'Sorry, you are not allowed to make proxied oEmbed requests.' ), array( 'status' => rest_authorization_required_code() ) );
+		}
+		return true;
+	}
+
+	/**
+	 * Callback for the proxy API endpoint.
+	 *
+	 * Returns the JSON object for the proxied item.
+	 *
+	 * @since 4.8.0
+	 *
+	 * @see WP_oEmbed::get_html()
+	 * @param WP_REST_Request $request Full data about the request.
+	 * @return object|WP_Error oEmbed response data or WP_Error on failure.
+	 */
+	public function get_proxy_item( $request ) {
+		$args = $request->get_params();
+
+		// Serve oEmbed data from cache if set.
+		unset( $args['_wpnonce'] );
+		$cache_key = 'oembed_' . md5( serialize( $args ) );
+		$data = get_transient( $cache_key );
+		if ( ! empty( $data ) ) {
+			return $data;
+		}
+
+		$url = $request['url'];
+		unset( $args['url'] );
+
+		// Copy maxwidth/maxheight to width/height since WP_oEmbed::fetch() uses these arg names.
+		if ( isset( $args['maxwidth'] ) ) {
+			$args['width'] = $args['maxwidth'];
+		}
+		if ( isset( $args['maxheight'] ) ) {
+			$args['height'] = $args['maxheight'];
+		}
+
+		$data = _wp_oembed_get_object()->get_data( $url, $args );
+
+		if ( false === $data ) {
+			return new WP_Error( 'oembed_invalid_url', get_status_header_desc( 404 ), array( 'status' => 404 ) );
+		}
+
+		/**
+		 * Filters the oEmbed TTL value (time to live).
+		 *
+		 * Similar to the {@see 'oembed_ttl'} filter, but for the REST API
+		 * oEmbed proxy endpoint.
+		 *
+		 * @since 4.8.0
+		 *
+		 * @param int    $time    Time to live (in seconds).
+		 * @param string $url     The attempted embed URL.
+		 * @param array  $args    An array of embed request arguments.
+		 */
+		$ttl = apply_filters( 'rest_oembed_ttl', DAY_IN_SECONDS, $url, $args );
+
+		set_transient( $cache_key, $data, $ttl );
+
+		return $data;
+	}
+}