Ticket #43316: autosave-controller.diff

new file src/wp-includes/rest-api/endpoints/class-wp-rest-autosaves-controller.php

@@ +1 @@
+<?php
+/**
+ * REST API: WP_REST_Autosaves_Controller class.
+ *
+ * @package WordPress
+ * @subpackage REST_API
+ * @since 5.0.0
+ */
+
+/**
+ * Core class used to access autosaves via the REST API.
+ *
+ * @since 5.0.0
+ *
+ * @see WP_REST_Controller
+ */
+class WP_REST_Autosaves_Controller extends WP_REST_Revisions_Controller {
+
+        /**
+         * Parent post type.
+         *
+         * @since 5.0.0
+         * @var string
+         */
+        private $parent_post_type;
+
+        /**
+         * Parent controller.
+         *
+         * @since 5.0.0
+         * @var WP_REST_Controller
+         */
+        private $parent_controller;
+
+        /**
+         * Parent controller.
+         *
+         * @since 5.0.0
+         * @var WP_REST_Controller
+         */
+        private $revision_controller;
+
+        /**
+         * The base of the parent controller's route.
+         *
+         * @since 5.0.0
+         * @var string
+         */
+        private $parent_base;
+
+        /**
+         * Constructor.
+         *
+         * @since 5.0.0
+         *
+         * @param string $parent_post_type Post type of the parent.
+         */
+        public function __construct( $parent_post_type ) {
+                $this->parent_post_type    = $parent_post_type;
+                $this->parent_controller   = new WP_REST_Posts_Controller( $parent_post_type );
+                $this->revision_controller = new WP_REST_Revisions_Controller( $parent_post_type );
+                $this->rest_namespace      = 'wp/v2';
+                $this->rest_base           = 'autosaves';
+                $post_type_object          = get_post_type_object( $parent_post_type );
+                $this->parent_base         = ! empty( $post_type_object->rest_base ) ? $post_type_object->rest_base : $post_type_object->name;
+        }
+
+        /**
+         * Registers routes for autosaves based on post types supporting autosaves.
+         *
+         * @since 5.0.0
+         *
+         * @see register_rest_route()
+         */
+        public function register_routes() {
+                register_rest_route(
+                        $this->rest_namespace, '/' . $this->parent_base . '/(?P<parent>[\d]+)/' . $this->rest_base, array(
+                                'args'   => array(
+                                        'parent' => array(
+                                                'description' => __( 'The ID for the parent of the object.', 'gutenberg' ),
+                                                'type'        => 'integer',
+                                        ),
+                                ),
+                                array(
+                                        'methods'             => WP_REST_Server::READABLE,
+                                        'callback'            => array( $this, 'get_items' ),
+                                        'permission_callback' => array( $this->revision_controller, 'get_items_permissions_check' ),
+                                        'args'                => $this->get_collection_params(),
+                                ),
+                                array(
+                                        'methods'             => WP_REST_Server::CREATABLE,
+                                        'callback'            => array( $this, 'create_item' ),
+                                        'permission_callback' => array( $this->parent_controller, 'create_item_permissions_check' ),
+                                        'args'                => $this->get_endpoint_args_for_item_schema( WP_REST_Server::CREATABLE ),
+                                ),
+                                'schema' => array( $this, 'get_public_item_schema' ),
+                        )
+                );
+
+                register_rest_route(
+                        $this->rest_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 object.', 'gutenberg' ),
+                                                'type'        => 'integer',
+                                        ),
+                                        'id'     => array(
+                                                'description' => __( 'Unique identifier for the object.', 'gutenberg' ),
+                                                'type'        => 'integer',
+                                        ),
+                                ),
+                                array(
+                                        'methods'             => WP_REST_Server::READABLE,
+                                        'callback'            => array( $this, 'get_item' ),
+                                        'permission_callback' => array( $this->revision_controller, '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->revision_controller, 'delete_item_permissions_check' ),
+                                        'args'                => array(
+                                                'force' => array(
+                                                        'type'        => 'boolean',
+                                                        'default'     => false,
+                                                        'description' => __( 'Required to be true, as autosaves do not support trashing.', 'gutenberg' ),
+                                                ),
+                                        ),
+                                ),
+                                array(
+                                        'methods'             => WP_REST_Server::CREATABLE,
+                                        'callback'            => array( $this, 'create_item' ),
+                                        'permission_callback' => array( $this->parent_controller, 'create_item_permissions_check' ),
+                                        'args'                => $this->get_endpoint_args_for_item_schema( WP_REST_Server::CREATABLE ),
+                                ),
+                                'schema' => array( $this, 'get_public_item_schema' ),
+                        )
+                );
+
+        }
+
+        /**
+         * Creates a single autosave.
+         *
+         * @since 5.0.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 create_item( $request ) {
+
+                // Map new fields onto the existing post data.
+                $parent            = $this->revision_controller->get_parent( $request['parent'] );
+                $prepared_post     = $this->parent_controller->prepare_item_for_database( $request );
+                $prepared_post->ID = $parent->ID;
+
+                // If the parent post a draft, autosaving updates it and does not create a revision.
+                if ( 'draft' === $parent->post_status ) {
+
+                        // Disable revisions.
+                        remove_action( 'post_updated', 'wp_save_post_revision' );
+
+                        $autosave_id = wp_update_post( (array) $prepared_post, true );
+
+                        // Re-enable revisions.
+                        add_action( 'post_updated', 'wp_save_post_revision' );
+                        if ( ! is_wp_error( $autosave_id ) ) {
+                                $post = get_post( $autosave_id );
+                        }
+                } else {
+
+                        // Non-draft posts - update the post, creating an autosave.
+                        $autosave_id = $this->create_post_autosave( (array) $prepared_post );
+                        $post        = get_post( $autosave_id );
+                }
+                $request->set_param( 'context', 'edit' );
+
+                $response = $this->prepare_item_for_response( $post, $request );
+                $response = rest_ensure_response( $response );
+
+                $response->set_status( 201 );
+                $response->header( 'Location', rest_url( sprintf( '%s/%s/%d', $this->rest_namespace, $this->rest_base, $autosave_id ) ) );
+
+                return $response;
+        }
+
+        /**
+         * Get the autosave, if the ID is valid.
+         *
+         * @since 5.0.0
+         *
+         * @param int $id Supplied ID.
+         * @return WP_Post|WP_Error Revision post object if ID is valid, WP_Error otherwise.
+         */
+        public function get_item( $id ) {
+                $error = new WP_Error( 'rest_post_invalid_id', __( 'Invalid autosave ID.', 'gutenberg' ), array( 'status' => 404 ) );
+                if ( (int) $id <= 0 ) {
+                        return $error;
+                }
+
+                $autosave = get_post( (int) $id );
+                if ( empty( $autosave ) || empty( $autosave->ID ) || 'autosave' !== $autosave->post_type ) {
+                        return $error;
+                }
+
+                return $autosave;
+        }
+
+        /**
+         * Gets a collection of autosaves using wp_get_post_autosave.
+         *
+         * Contains the user's autosave, for empty if it doesn't exist.
+         *
+         * @since 5.0.0
+         *
+         * @param WP_REST_Request $request Full data 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->revision_controller->get_parent( $request['parent'] );
+                if ( is_wp_error( $parent ) ) {
+                        return $parent;
+                }
+
+                $autosave = wp_get_post_autosave( $request['parent'] );
+
+                if ( ! $autosave ) {
+                        return array();
+                }
+
+                $response   = array();
+                $data       = $this->prepare_item_for_response( $autosave, $request );
+                $response[] = $this->prepare_response_for_collection( $data );
+
+                return rest_ensure_response( $response );
+        }
+
+
+        /**
+         * Retrieves the autosave's schema, conforming to JSON Schema.
+         *
+         * @since 5.0.0
+         *
+         * @return array Item schema data.
+         */
+        public function get_item_schema() {
+                return $this->revision_controller->get_item_schema();
+        }
+
+        /**
+         * Creates autosave data for the specified post from $_POST data.
+         *
+         * From core post.php.
+         *
+         * @since 2.6.0
+         *
+         * @param mixed $post_data Associative array containing the post data or int post ID.
+         * @return mixed The autosave revision ID. WP_Error or 0 on error.
+         */
+        public function create_post_autosave( $post_data ) {
+
+                $post_id     = (int) $post_data['ID'];
+                $post_author = get_current_user_id();
+
+                // Store one autosave per author. If there is already an autosave, overwrite it.
+                $old_autosave = wp_get_post_autosave( $post_id, $post_author );
+                if ( $old_autosave ) {
+                        $new_autosave                = _wp_post_revision_data( $post_data, true );
+                        $new_autosave['ID']          = $old_autosave->ID;
+                        $new_autosave['post_author'] = $post_author;
+
+                        // If the new autosave has the same content as the post, delete the autosave.
+                        $post                  = get_post( $post_id );
+                        $autosave_is_different = false;
+                        foreach ( array_intersect( array_keys( $new_autosave ), array_keys( _wp_post_revision_fields( $post ) ) ) as $field ) {
+                                if ( normalize_whitespace( $new_autosave[ $field ] ) != normalize_whitespace( $post->$field ) ) {
+                                        $autosave_is_different = true;
+                                        break;
+                                }
+                        }
+
+                        if ( ! $autosave_is_different ) {
+                                wp_delete_post_revision( $old_autosave->ID );
+                                return 0;
+                        }
+
+                        /**
+                         * Fires before an autosave is stored.
+                         *
+                         * @since 4.1.0
+                         *
+                         * @param array $new_autosave Post array - the autosave that is about to be saved.
+                         */
+                        do_action( 'wp_creating_autosave', $new_autosave );
+
+                        return wp_update_post( $new_autosave );
+                }
+
+                // _wp_put_post_revision() expects unescaped.
+                $post_data = wp_unslash( $post_data );
+
+                // Otherwise create the new autosave as a special post revision.
+                return _wp_put_post_revision( $post_data, true );
+        }
+}

src/wp-settings.php

@@ -230 +230 @@
 require( ABSPATH . WPINC . '/rest-api/endpoints/class-wp-rest-post-types-controller.php' );
 require( ABSPATH . WPINC . '/rest-api/endpoints/class-wp-rest-post-statuses-controller.php' );
 require( ABSPATH . WPINC . '/rest-api/endpoints/class-wp-rest-revisions-controller.php' );
+require( ABSPATH . WPINC . '/rest-api/endpoints/class-wp-rest-autosaves-controller.php' );
 require( ABSPATH . WPINC . '/rest-api/endpoints/class-wp-rest-taxonomies-controller.php' );
 require( ABSPATH . WPINC . '/rest-api/endpoints/class-wp-rest-terms-controller.php' );
 require( ABSPATH . WPINC . '/rest-api/endpoints/class-wp-rest-users-controller.php' );