<?php

/**

 * REST API: WP_REST_Revisions_Controller class

 *

 * @package WordPress

 * @subpackage REST_API

 * @since 4.7.0

 */

/**

 * Core class used to access revisions via the REST API.

 *

 * @since 4.7.0

 *

 * @see WP_REST_Controller

 */

class WP_REST_Revisions_Controller extends WP_REST_Controller {

	/**

	 * Parent post type.

	 *

	 * @since 4.7.0

	 * @var string

	 */

	private $parent_post_type;

	/**

	 * Instance of a revision meta fields object.

	 *

	 * @since 6.4.0

	 * @var WP_REST_Post_Meta_Fields

	 */

	protected $meta;

	/**

	 * Parent controller.

	 *

	 * @since 4.7.0

	 * @var WP_REST_Controller

	 */

	private $parent_controller;

	/**

	 * The base of the parent controller's route.

	 *

	 * @since 4.7.0

	 * @var string

	 */

	private $parent_base;

	/**

	 * Constructor.

	 *

	 * @since 4.7.0

	 *

	 * @param string $parent_post_type Post type of the parent.

	 */

	public function __construct( $parent_post_type ) {

		$this->parent_post_type = $parent_post_type;

		$post_type_object       = get_post_type_object( $parent_post_type );

		$parent_controller      = $post_type_object->get_rest_controller();

		if ( ! $parent_controller ) {

			$parent_controller = new WP_REST_Posts_Controller( $parent_post_type );

		}

		$this->parent_controller = $parent_controller;

		$this->rest_base         = 'revisions';

		$this->parent_base       = ! empty( $post_type_object->rest_base ) ? $post_type_object->rest_base : $post_type_object->name;

		$this->namespace         = ! empty( $post_type_object->rest_namespace ) ? $post_type_object->rest_namespace : 'wp/v2';

		$this->meta              = new WP_REST_Post_Meta_Fields( $parent_post_type );

	}

	/**

	 * Registers the routes for revisions based on post types supporting revisions.

	 *

	 * @since 4.7.0

	 *

	 * @see register_rest_route()

	 */

	public function register_routes() {

		register_rest_route(

			$this->namespace,

			'/' . $this->parent_base . '/(?P<parent>[\d]+)/' . $this->rest_base,

			array(

				'args'   => array(

					'parent' => array(

						'description' => __( 'The ID for the parent of the revision.' ),

						'type'        => 'integer',

					),

				),

				array(

					'methods'             => WP_REST_Server::READABLE,

					'callback'            => array( $this, 'get_items' ),

					'permission_callback' => array( $this, 'get_items_permissions_check' ),

					'args'                => $this->get_collection_params(),

				),

				'schema' => array( $this, 'get_public_item_schema' ),

			)

		);

		register_rest_route(

			$this->namespace,

			'/' . $this->parent_base . '/(?P<parent>[\d]+)/' . $this->rest_base . '/(?P<id>[\d]+)',

			array(

				'args'   => array(

					'parent' => array(

						'description' => __( 'The ID for the parent of the revision.' ),

						'type'        => 'integer',

					),

					'id'     => array(

						'description' => __( 'Unique identifier for the revision.' ),

						'type'        => 'integer',

					),

				),

				array(

					'methods'             => WP_REST_Server::READABLE,

					'callback'            => array( $this, 'get_item' ),

					'permission_callback' => array( $this, 'get_item_permissions_check' ),

					'args'                => array(

						'context' => $this->get_context_param( array( 'default' => 'view' ) ),

					),

				),

				array(

					'methods'             => WP_REST_Server::DELETABLE,

					'callback'            => array( $this, 'delete_item' ),

					'permission_callback' => array( $this, 'delete_item_permissions_check' ),

					'args'                => array(

						'force' => array(

							'type'        => 'boolean',

							'default'     => false,

							'description' => __( 'Required to be true, as revisions do not support trashing.' ),

						),

					),

				),

				'schema' => array( $this, 'get_public_item_schema' ),

			)

		);

	}

	/**

	 * Get the parent post, if the ID is valid.

	 *

	 * @since 4.7.2

	 *

	 * @param int $parent_post_id Supplied ID.

	 * @return WP_Post|WP_Error Post object if ID is valid, WP_Error otherwise.

	 */

	protected function get_parent( $parent_post_id ) {

		$error = new WP_Error(

			'rest_post_invalid_parent',

			__( 'Invalid post parent ID.' ),

			array( 'status' => 404 )

		);

		if ( (int) $parent_post_id <= 0 ) {

			return $error;

		}

		$parent_post = get_post( (int) $parent_post_id );

		if ( empty( $parent_post ) || empty( $parent_post->ID )

			|| $this->parent_post_type !== $parent_post->post_type

		) {

			return $error;

		}

		return $parent_post;

	}

	/**

	 * Checks if a given request has access to get revisions.

	 *

	 * @since 4.7.0

	 *

	 * @param WP_REST_Request $request Full details about the request.

	 * @return true|WP_Error True if the request has read access, WP_Error object otherwise.

	 */

	public function get_items_permissions_check( $request ) {

		$parent = $this->get_parent( $request['parent'] );

		if ( is_wp_error( $parent ) ) {

			return $parent;

		}

		if ( ! current_user_can( 'edit_post', $parent->ID ) ) {

			return new WP_Error(

				'rest_cannot_read',

				__( 'Sorry, you are not allowed to view revisions of this post.' ),

				array( 'status' => rest_authorization_required_code() )

			);

		}

		return true;

	}

	/**

	 * Get the revision, if the ID is valid.

	 *

	 * @since 4.7.2

	 *

	 * @param int $id Supplied ID.

	 * @return WP_Post|WP_Error Revision post object if ID is valid, WP_Error otherwise.

	 */

	protected function get_revision( $id ) {

		$error = new WP_Error(

			'rest_post_invalid_id',

			__( 'Invalid revision ID.' ),

			array( 'status' => 404 )

		);

		if ( (int) $id <= 0 ) {

			return $error;

		}

		$revision = get_post( (int) $id );

		if ( empty( $revision ) || empty( $revision->ID ) || 'revision' !== $revision->post_type ) {

			return $error;

		}

		return $revision;

	}

	/**

	 * Gets a collection of revisions.

	 *

	 * @since 4.7.0

	 *

	 * @param WP_REST_Request $request Full details about the request.

	 * @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.

	 */

	public function get_items( $request ) {

		$parent = $this->get_parent( $request['parent'] );

		if ( is_wp_error( $parent ) ) {

			return $parent;

		}

		// Ensure a search string is set in case the orderby is set to 'relevance'.

		if ( ! empty( $request['orderby'] ) && 'relevance' === $request['orderby'] && empty( $request['search'] ) ) {

			return new WP_Error(

				'rest_no_search_term_defined',

				__( 'You need to define a search term to order by relevance.' ),

				array( 'status' => 400 )

			);

		}

		// Ensure an include parameter is set in case the orderby is set to 'include'.

		if ( ! empty( $request['orderby'] ) && 'include' === $request['orderby'] && empty( $request['include'] ) ) {

			return new WP_Error(

				'rest_orderby_include_missing_include',

				__( 'You need to define an include parameter to order by include.' ),

				array( 'status' => 400 )

			);

		}

		if ( wp_revisions_enabled( $parent ) ) {

			$registered = $this->get_collection_params();

			$args       = array(

				'post_parent'      => $parent->ID,

				'post_type'        => 'revision',

				'post_status'      => 'inherit',

				'posts_per_page'   => -1,

				'orderby'          => 'date ID',

				'order'            => 'DESC',

				'suppress_filters' => true,

			);

			$parameter_mappings = array(

				'exclude'  => 'post__not_in',

				'include'  => 'post__in',

				'offset'   => 'offset',

				'order'    => 'order',

				'orderby'  => 'orderby',

				'page'     => 'paged',

				'per_page' => 'posts_per_page',

				'search'   => 's',

			);

			foreach ( $parameter_mappings as $api_param => $wp_param ) {

				if ( isset( $registered[ $api_param ], $request[ $api_param ] ) ) {

					$args[ $wp_param ] = $request[ $api_param ];

				}

			}

			// For backward-compatibility, 'date' needs to resolve to 'date ID'.

			if ( isset( $args['orderby'] ) && 'date' === $args['orderby'] ) {

				$args['orderby'] = 'date ID';

			}

			/** This filter is documented in wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php */

			$args       = apply_filters( 'rest_revision_query', $args, $request );

			$query_args = $this->prepare_items_query( $args, $request );

			$revisions_query = new WP_Query();

			$revisions       = $revisions_query->query( $query_args );

			$offset          = isset( $query_args['offset'] ) ? (int) $query_args['offset'] : 0;

			$total_revisions = $revisions_query->found_posts;

			if ( $total_revisions < 1 ) {

				// Out-of-bounds, run the query again without LIMIT for total count.

				unset( $query_args['paged'], $query_args['offset'] );

				$count_query = new WP_Query();

				$count_query->query( $query_args );

				$total_revisions = $count_query->found_posts;

			}

			if ( $revisions_query->query_vars['posts_per_page'] > 0 ) {

				$max_pages = (int) ceil( $total_revisions / (int) $revisions_query->query_vars['posts_per_page'] );

			} else {

				$max_pages = $total_revisions > 0 ? 1 : 0;

			}

			if ( $total_revisions > 0 ) {

				if ( $offset >= $total_revisions ) {

					return new WP_Error(

						'rest_revision_invalid_offset_number',

						__( 'The offset number requested is larger than or equal to the number of available revisions.' ),

						array( 'status' => 400 )

					);

				} elseif ( ! $offset && $page > $max_pages ) {

					return new WP_Error(

						'rest_revision_invalid_page_number',

						__( 'The page number requested is larger than the number of pages available.' ),

						array( 'status' => 400 )

					);

				}

			}

		} else {

			$revisions       = array();

			$total_revisions = 0;

			$max_pages       = 0;

			$page            = (int) $request['page'];

		}

		}

		$response->header( 'X-WP-Total', (int) $total_revisions );

		$response->header( 'X-WP-TotalPages', (int) $max_pages );

		$request_params = $request->get_query_params();

		$base_path      = rest_url( sprintf( '%s/%s/%d/%s', $this->namespace, $this->parent_base, $request['parent'], $this->rest_base ) );

		$base           = add_query_arg( urlencode_deep( $request_params ), $base_path );

		if ( $page > 1 ) {

			$prev_page = $page - 1;

			if ( $prev_page > $max_pages ) {

				$prev_page = $max_pages;

			}

			$prev_link = add_query_arg( 'page', $prev_page, $base );

			$response->link_header( 'prev', $prev_link );

		}

		if ( $max_pages > $page ) {

			$next_page = $page + 1;

			$next_link = add_query_arg( 'page', $next_page, $base );

			$response->link_header( 'next', $next_link );

		}

		return $response;

	}

	/**

	 * Checks if a given request has access to get a specific revision.

	 *

	 * @since 4.7.0

	 *

	 * @param WP_REST_Request $request Full details about the request.

	 * @return true|WP_Error True if the request has read access for the item, WP_Error object otherwise.

	 */

	public function get_item_permissions_check( $request ) {

		return $this->get_items_permissions_check( $request );

	}

	/**

	 * Retrieves one revision from the collection.

	 *

	 * @since 4.7.0

	 * @since 6.5.0 Added a condition to check that parent id matches revision parent id.

	 *

	 * @param WP_REST_Request $request Full details about the request.

	 * @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.

	 */

	public function get_item( $request ) {