diff --git a/src/wp-includes/rest-api.php b/src/wp-includes/rest-api.php index 0cce9fa62f..51e5e6f1a3 100644 --- a/src/wp-includes/rest-api.php +++ b/src/wp-includes/rest-api.php @@ -192,6 +192,8 @@ function create_initial_rest_routes() { if ( post_type_supports( $post_type->name, 'revisions' ) ) { $revisions_controller = new WP_REST_Revisions_Controller( $post_type->name ); $revisions_controller->register_routes(); + $controller = new WP_REST_Autosaves_Controller( $post_type->name ); + $controller->register_routes(); } } diff --git a/src/wp-includes/rest-api/endpoints/class-wp-rest-autosaves-controller.php b/src/wp-includes/rest-api/endpoints/class-wp-rest-autosaves-controller.php new file mode 100644 index 0000000000..4b9036415d --- /dev/null +++ b/src/wp-includes/rest-api/endpoints/class-wp-rest-autosaves-controller.php @@ -0,0 +1,376 @@ +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; + } + + /**o + * Registers routes for autosaves. + * + * @since 5.0.0 + * + * @see register_rest_route() + */ + public function register_routes() { + register_rest_route( + $this->rest_namespace, '/' . $this->parent_base . '/(?P[\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[\d]+)/' . $this->rest_base . '/(?P[\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' ), + ) + ); + + } + + /** + * Get the parent post, if the ID is valid. + * + * @since 4.7.2 + * + * @param int $id Supplied ID. + * @return WP_Post|WP_Error Post object if ID is valid, WP_Error otherwise. + */ + protected function get_parent( $parent ) { + return $this->revision_controller->get_parent( $parent ); + } + /** + * 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->get_parent( $request->get_param( '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 ) { + + define( 'DOING_AUTOSAVE', true ); + $autosave_id = wp_update_post( (array) $prepared_post, true ); + + 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; + } + + /** + * Update an autosave, if the ID is valid. + * + * @since 5.0.0 + * + * @param WP_REST_Request $request Full data about the request. + * @return WP_Post|WP_Error Revision post object if ID is valid, WP_Error otherwise. + */ + public function update_item( $request ) { + $parent = $request->get_param( 'parent' ); + $id = $request->get_param( 'id' ); + $error = new WP_Error( 'rest_post_invalid_id', __( 'Invalid autosave ID.', 'gutenberg' ), array( 'status' => 404 ) ); + if ( (int) $parent <= 0 ) { + return $error; + } + + $prepared_post = $this->parent_controller->prepare_item_for_database( $request ); + $prepared_post->ID = $id; + $post_id = wp_update_post( (array) $prepared_post ); + $post = get_post( $post_id ); + $fields_update = $this->update_additional_fields_for_object( $post, $request ); + + if ( is_wp_error( $fields_update ) ) { + return $fields_update; + } + + $request->set_param( 'context', 'edit' ); + + $response = $this->prepare_item_for_response( $post, $request ); + + return rest_ensure_response( $response ); + } + /** + * Get the autosave, if the ID is valid. + * + * @since 5.0.0 + * + * @param WP_REST_Request $request Full data about the request. + * @return WP_Post|WP_Error Revision post object if ID is valid, WP_Error otherwise. + */ + public function get_item( $request ) { + $parent = $request->get_param( 'parent' ); + $error = new WP_Error( 'rest_post_invalid_id', __( 'Invalid autosave ID.', 'gutenberg' ), array( 'status' => 404 ) ); + if ( (int) $parent <= 0 ) { + return $error; + } + $autosave = wp_get_post_autosave( (int) $parent ); + + if ( empty( $autosave ) || empty( $autosave->ID ) || 'revision' !== $autosave->post_type ) { + return $error; + } + $autosave->post_parent = $parent; + $response = $this->prepare_item_for_response( $autosave, $request ); + + return $response; + } + + /** + * 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->get_parent( $request->get_param( 'parent' ) ); + if ( is_wp_error( $parent ) ) { + return $parent; + } + + $autosave = wp_get_post_autosave( $request->get_param( '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 wp-admin/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; + } + + /** + * This filter is documented in wp-admin/post.php. + */ + 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 ); + } + + /** + * Prepares the revision for the REST response. + * + * @since 5.0.0 + * + * @param WP_Post $post Post revision object. + * @param WP_REST_Request $request Request object. + * + * @return WP_REST_Response Response object. + */ + public function prepare_item_for_response( $post, $request ) { + $data = array(); + $response = $this->revision_controller->prepare_item_for_response( $post, $request ); + + /** + * Filters a revision returned from the API. + * + * Allows modification of the revision right before it is returned. + * + * @since 5.0.0 + * + * @param WP_REST_Response $response The response object. + * @param WP_Post $post The original revision object. + * @param WP_REST_Request $request Request used to generate the response. + */ + return apply_filters( 'rest_prepare_autosave', $response, $post, $request ); + + } + +} diff --git a/src/wp-settings.php b/src/wp-settings.php index 6edd3c98ca..b2c4189c64 100644 --- a/src/wp-settings.php +++ b/src/wp-settings.php @@ -230,6 +230,7 @@ require( ABSPATH . WPINC . '/rest-api/endpoints/class-wp-rest-attachments-contro 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' ); diff --git a/tests/phpunit/tests/rest-api/rest-autosaves-controller.php b/tests/phpunit/tests/rest-api/rest-autosaves-controller.php new file mode 100644 index 0000000000..9824c29321 --- /dev/null +++ b/tests/phpunit/tests/rest-api/rest-autosaves-controller.php @@ -0,0 +1,393 @@ + 'Post Title', + 'content' => 'Post content', + 'excerpt' => 'Post excerpt', + 'name' => 'test', + 'author' => get_current_user_id(), + ); + + return wp_parse_args( $args, $defaults ); + } + + protected function check_create_autosave_response( $response ) { + $this->assertNotInstanceOf( 'WP_Error', $response ); + $response = rest_ensure_response( $response ); + + $this->assertEquals( 201, $response->get_status() ); + $headers = $response->get_headers(); + $this->assertArrayHasKey( 'Location', $headers ); + } + + public static function wpSetUpBeforeClass( $factory ) { + self::$post_id = $factory->post->create(); + self::$page_id = $factory->post->create( array( 'post_type' => 'page' ) ); + + self::$editor_id = $factory->user->create( + array( + 'role' => 'editor', + ) + ); + self::$contributor_id = $factory->user->create( + array( + 'role' => 'contributor', + ) + ); + + wp_set_current_user( self::$editor_id ); + + // Create an autosave. + self::$autosave_post_id = wp_create_post_autosave( + array( + 'post_content' => 'This content is better.', + 'post_ID' => self::$post_id, + 'post_type' => 'post', + ) + ); + + self::$autosave_page_id = wp_create_post_autosave( + array( + 'post_content' => 'This content is better.', + 'post_ID' => self::$page_id, + 'post_type' => 'post', + ) + ); + + } + + public static function wpTearDownAfterClass() { + // Also deletes revisions. + wp_delete_post( self::$post_id, true ); + wp_delete_post( self::$page_id, true ); + + self::delete_user( self::$editor_id ); + self::delete_user( self::$contributor_id ); + } + + public function setUp() { + parent::setUp(); + wp_set_current_user( self::$editor_id ); + + $this->post_autosave = wp_get_post_autosave( self::$post_id ); + } + + public function test_register_routes() { + $routes = rest_get_server()->get_routes(); + $this->assertArrayHasKey( '/wp/v2/posts/(?P[\d]+)/autosaves', $routes ); + $this->assertArrayHasKey( '/wp/v2/posts/(?P[\d]+)/autosaves/(?P[\d]+)', $routes ); + $this->assertArrayHasKey( '/wp/v2/pages/(?P[\d]+)/autosaves', $routes ); + $this->assertArrayHasKey( '/wp/v2/pages/(?P[\d]+)/autosaves/(?P[\d]+)', $routes ); + } + + public function test_context_param() { + // Collection + $request = new WP_REST_Request( 'OPTIONS', '/wp/v2/posts/' . self::$post_id . '/autosaves' ); + $response = rest_get_server()->dispatch( $request ); + $data = $response->get_data(); + $this->assertEquals( 'view', $data['endpoints'][0]['args']['context']['default'] ); + $this->assertEqualSets( array( 'view', 'edit', 'embed' ), $data['endpoints'][0]['args']['context']['enum'] ); + // Single + $request = new WP_REST_Request( 'OPTIONS', '/wp/v2/posts/' . self::$post_id . '/autosaves/' . self::$autosave_post_id ); + $response = rest_get_server()->dispatch( $request ); + $data = $response->get_data(); + $this->assertEquals( 'view', $data['endpoints'][0]['args']['context']['default'] ); + $this->assertEqualSets( array( 'view', 'edit', 'embed' ), $data['endpoints'][0]['args']['context']['enum'] ); } + + public function test_get_items() { + wp_set_current_user( self::$editor_id ); + $request = new WP_REST_Request( 'GET', '/wp/v2/posts/' . self::$post_id . '/autosaves' ); + $response = rest_get_server()->dispatch( $request ); + $data = $response->get_data(); + $this->assertEquals( 200, $response->get_status() ); + $this->assertCount( 1, $data ); + + $this->assertEquals( self::$autosave_post_id, $data[0]['id'] ); + + $this->check_get_autosave_response( $data[0], $this->post_autosave ); + } + + public function test_get_items_no_permission() { + wp_set_current_user( 0 ); + $request = new WP_REST_Request( 'GET', '/wp/v2/posts/' . self::$post_id . '/autosaves' ); + $response = rest_get_server()->dispatch( $request ); + $this->assertErrorResponse( 'rest_cannot_read', $response, 401 ); + wp_set_current_user( self::$contributor_id ); + $response = rest_get_server()->dispatch( $request ); + $this->assertErrorResponse( 'rest_cannot_read', $response, 403 ); + } + + public function test_get_items_missing_parent() { + wp_set_current_user( self::$editor_id ); + $request = new WP_REST_Request( 'GET', '/wp/v2/posts/' . REST_TESTS_IMPOSSIBLY_HIGH_NUMBER . '/autosaves' ); + $response = rest_get_server()->dispatch( $request ); + $this->assertErrorResponse( 'rest_post_invalid_parent', $response, 404 ); + } + + public function test_get_items_invalid_parent_post_type() { + wp_set_current_user( self::$editor_id ); + $request = new WP_REST_Request( 'GET', '/wp/v2/posts/' . self::$page_id . '/autosaves' ); + $response = rest_get_server()->dispatch( $request ); + $this->assertErrorResponse( 'rest_post_invalid_parent', $response, 404 ); + } + + public function test_get_item() { + wp_set_current_user( self::$editor_id ); + $request = new WP_REST_Request( 'GET', '/wp/v2/posts/' . self::$post_id . '/autosaves/' . self::$autosave_post_id ); + $response = rest_get_server()->dispatch( $request ); + $this->assertEquals( 200, $response->get_status() ); + $data = $response->get_data(); + + $this->check_get_autosave_response( $response, $this->post_autosave ); + $fields = array( + 'author', + 'date', + 'date_gmt', + 'modified', + 'modified_gmt', + 'guid', + 'id', + 'parent', + 'slug', + 'title', + 'excerpt', + 'content', + ); + $this->assertEqualSets( $fields, array_keys( $data ) ); + $this->assertSame( self::$editor_id, $data['author'] ); + } + + public function test_get_item_embed_context() { + wp_set_current_user( self::$editor_id ); + $request = new WP_REST_Request( 'GET', '/wp/v2/posts/' . self::$post_id . '/autosaves/' . self::$autosave_post_id ); + $request->set_param( 'context', 'embed' ); + $response = rest_get_server()->dispatch( $request ); + $fields = array( + 'author', + 'date', + 'id', + 'parent', + 'slug', + 'title', + 'excerpt', + ); + $data = $response->get_data(); + $this->assertEqualSets( $fields, array_keys( $data ) ); + } + + public function test_get_item_no_permission() { + $request = new WP_REST_Request( 'GET', '/wp/v2/posts/' . self::$post_id . '/autosaves/' . self::$autosave_post_id ); + wp_set_current_user( self::$contributor_id ); + $response = rest_get_server()->dispatch( $request ); + $this->assertErrorResponse( 'rest_cannot_read', $response, 403 ); + } + + public function test_get_item_missing_parent() { + wp_set_current_user( self::$editor_id ); + $request = new WP_REST_Request( 'GET', '/wp/v2/posts/' . REST_TESTS_IMPOSSIBLY_HIGH_NUMBER . '/autosaves/' . self::$autosave_post_id ); + $response = rest_get_server()->dispatch( $request ); + $this->assertErrorResponse( 'rest_post_invalid_parent', $response, 404 ); + + } + + public function test_get_item_invalid_parent_post_type() { + wp_set_current_user( self::$editor_id ); + $request = new WP_REST_Request( 'GET', '/wp/v2/posts/' . self::$page_id . '/autosaves' ); + $response = rest_get_server()->dispatch( $request ); + $this->assertErrorResponse( 'rest_post_invalid_parent', $response, 404 ); + } + + public function test_delete_item() { + wp_set_current_user( self::$editor_id ); + $request = new WP_REST_Request( 'DELETE', '/wp/v2/posts/' . self::$post_id . '/autosaves/' . self::$autosave_post_id ); + $request->set_param( 'force', true ); + $response = rest_get_server()->dispatch( $request ); + $this->assertEquals( 200, $response->get_status() ); + $this->assertNull( get_post( self::$autosave_post_id ) ); + } + + public function test_delete_item_no_trash() { + wp_set_current_user( self::$editor_id ); + + $request = new WP_REST_Request( 'DELETE', '/wp/v2/posts/' . self::$post_id . '/autosaves/' . self::$autosave_post_id ); + $response = rest_get_server()->dispatch( $request ); + $this->assertErrorResponse( 'rest_trash_not_supported', $response, 501 ); + + $request->set_param( 'force', 'false' ); + $response = rest_get_server()->dispatch( $request ); + $this->assertErrorResponse( 'rest_trash_not_supported', $response, 501 ); + + // Ensure the revision still exists + $this->assertNotNull( get_post( self::$autosave_post_id ) ); + } + + public function test_delete_item_no_permission() { + wp_set_current_user( self::$contributor_id ); + $request = new WP_REST_Request( 'DELETE', '/wp/v2/posts/' . self::$post_id . '/autosaves/' . self::$autosave_post_id ); + $response = rest_get_server()->dispatch( $request ); + $this->assertErrorResponse( 'rest_cannot_read', $response, 403 ); + } + + public function test_prepare_item() { + wp_set_current_user( self::$editor_id ); + $request = new WP_REST_Request( 'GET', '/wp/v2/posts/' . self::$post_id . '/autosaves/' . self::$autosave_post_id ); + $response = rest_get_server()->dispatch( $request ); + $this->assertEquals( 200, $response->get_status() ); + $this->check_get_autosave_response( $response, $this->post_autosave ); + } + + public function test_get_item_schema() { + $request = new WP_REST_Request( 'OPTIONS', '/wp/v2/posts/' . self::$post_id . '/autosaves' ); + $response = rest_get_server()->dispatch( $request ); + $data = $response->get_data(); + $properties = $data['schema']['properties']; + $this->assertEquals( 12, count( $properties ) ); + $this->assertArrayHasKey( 'author', $properties ); + $this->assertArrayHasKey( 'content', $properties ); + $this->assertArrayHasKey( 'date', $properties ); + $this->assertArrayHasKey( 'date_gmt', $properties ); + $this->assertArrayHasKey( 'excerpt', $properties ); + $this->assertArrayHasKey( 'guid', $properties ); + $this->assertArrayHasKey( 'id', $properties ); + $this->assertArrayHasKey( 'modified', $properties ); + $this->assertArrayHasKey( 'modified_gmt', $properties ); + $this->assertArrayHasKey( 'parent', $properties ); + $this->assertArrayHasKey( 'slug', $properties ); + $this->assertArrayHasKey( 'title', $properties ); + } + + public function test_create_item() { + + wp_set_current_user( self::$editor_id ); + + $request = new WP_REST_Request( 'POST', '/wp/v2/posts/' . self::$post_id . '/autosaves' ); + $request->add_header( 'content-type', 'application/x-www-form-urlencoded' ); + $params = $this->set_post_data(); + $request->set_body_params( $params ); + $response = rest_get_server()->dispatch( $request ); + + $this->check_create_autosave_response( $response ); + } + + public function test_update_item() { + wp_set_current_user( self::$editor_id ); + $request = new WP_REST_Request( 'POST', '/wp/v2/posts/' . self::$post_id . '/autosaves/' . self::$autosave_post_id ); + $request->add_header( 'content-type', 'application/x-www-form-urlencoded' ); + $params = $this->set_post_data(); + $request->set_body_params( $params ); + $response = rest_get_server()->dispatch( $request ); + $this->assertErrorResponse( 'rest_post_exists', $response, 400 ); + } + + public function test_get_additional_field_registration() { + $schema = array( + 'type' => 'integer', + 'description' => 'Some integer of mine', + 'enum' => array( 1, 2, 3, 4 ), + 'context' => array( 'view', 'edit' ), + ); + + register_rest_field( + 'post-revision', 'my_custom_int', array( + 'schema' => $schema, + 'get_callback' => array( $this, 'additional_field_get_callback' ), + 'update_callback' => array( $this, 'additional_field_update_callback' ), + ) + ); + + $request = new WP_REST_Request( 'OPTIONS', '/wp/v2/posts/' . self::$post_id . '/autosaves' ); + + $response = rest_get_server()->dispatch( $request ); + $data = $response->get_data(); + + $this->assertArrayHasKey( 'my_custom_int', $data['schema']['properties'] ); + $this->assertEquals( $schema, $data['schema']['properties']['my_custom_int'] ); + + wp_set_current_user( 1 ); + + $request = new WP_REST_Request( 'GET', '/wp/v2/posts/' . self::$post_id . '/autosaves/' . self::$autosave_post_id ); + + $response = rest_get_server()->dispatch( $request ); + $this->assertArrayHasKey( 'my_custom_int', $response->data ); + + global $wp_rest_additional_fields; + $wp_rest_additional_fields = array(); + } + + public function additional_field_get_callback( $object ) { + return get_post_meta( $object['id'], 'my_custom_int', true ); + } + + public function additional_field_update_callback( $value, $post ) { + update_post_meta( $post->ID, 'my_custom_int', $value ); + } + + protected function check_get_autosave_response( $response, $autosave ) { + if ( $response instanceof WP_REST_Response ) { + $links = $response->get_links(); + $response = $response->get_data(); + } else { + $this->assertArrayHasKey( '_links', $response ); + $links = $response['_links']; + } + + $this->assertEquals( $autosave->post_author, $response['author'] ); + + $rendered_content = apply_filters( 'the_content', $autosave->post_content ); + $this->assertEquals( $rendered_content, $response['content']['rendered'] ); + + $this->assertEquals( mysql_to_rfc3339( $autosave->post_date ), $response['date'] ); + $this->assertEquals( mysql_to_rfc3339( $autosave->post_date_gmt ), $response['date_gmt'] ); + + $rendered_guid = apply_filters( 'get_the_guid', $autosave->guid, $autosave->ID ); + $this->assertEquals( $rendered_guid, $response['guid']['rendered'] ); + + $this->assertEquals( $autosave->ID, $response['id'] ); + $this->assertEquals( mysql_to_rfc3339( $autosave->post_modified ), $response['modified'] ); + $this->assertEquals( mysql_to_rfc3339( $autosave->post_modified_gmt ), $response['modified_gmt'] ); + $this->assertEquals( $autosave->post_name, $response['slug'] ); + + $rendered_title = get_the_title( $autosave->ID ); + $this->assertEquals( $rendered_title, $response['title']['rendered'] ); + + $parent = get_post( $autosave->post_parent ); + $parent_controller = new WP_REST_Posts_Controller( $parent->post_type ); + $parent_object = get_post_type_object( $parent->post_type ); + $parent_base = ! empty( $parent_object->rest_base ) ? $parent_object->rest_base : $parent_object->name; + $this->assertEquals( rest_url( '/wp/v2/' . $parent_base . '/' . $autosave->post_parent ), $links['parent'][0]['href'] ); + } + + public function test_get_item_sets_up_postdata() { + wp_set_current_user( self::$editor_id ); + $request = new WP_REST_Request( 'GET', '/wp/v2/posts/' . self::$post_id . '/autosaves/' . self::$autosave_post_id ); + rest_get_server()->dispatch( $request ); + + $post = get_post(); + $parent_post_id = wp_is_post_revision( $post->ID ); + + $this->assertEquals( $post->ID, self::$autosave_post_id ); + $this->assertEquals( $parent_post_id, self::$post_id ); + } + +} diff --git a/tests/phpunit/tests/rest-api/rest-schema-setup.php b/tests/phpunit/tests/rest-api/rest-schema-setup.php index e5b3460122..e3271318b6 100644 --- a/tests/phpunit/tests/rest-api/rest-schema-setup.php +++ b/tests/phpunit/tests/rest-api/rest-schema-setup.php @@ -89,10 +89,14 @@ class WP_Test_REST_Schema_Initialization extends WP_Test_REST_TestCase { '/wp/v2/posts/(?P[\\d]+)', '/wp/v2/posts/(?P[\\d]+)/revisions', '/wp/v2/posts/(?P[\\d]+)/revisions/(?P[\\d]+)', + '/wp/v2/posts/(?P[\\d]+)/autosaves', + '/wp/v2/posts/(?P[\\d]+)/autosaves/(?P[\\d]+)', '/wp/v2/pages', '/wp/v2/pages/(?P[\\d]+)', '/wp/v2/pages/(?P[\\d]+)/revisions', '/wp/v2/pages/(?P[\\d]+)/revisions/(?P[\\d]+)', + '/wp/v2/pages/(?P[\\d]+)/autosaves', + '/wp/v2/pages/(?P[\\d]+)/autosaves/(?P[\\d]+)', '/wp/v2/media', '/wp/v2/media/(?P[\\d]+)', '/wp/v2/types', @@ -159,6 +163,15 @@ class WP_Test_REST_Schema_Initialization extends WP_Test_REST_TestCase { $post_revisions = array_values( wp_get_post_revisions( $post_id ) ); $post_revision_id = $post_revisions[ count( $post_revisions ) - 1 ]->ID; + // Create an autosave. + wp_create_post_autosave( + array( + 'post_ID' => $post_id, + 'post_content' => 'Autosave post content.', + 'post_type' => 'post', + ) + ); + $page_id = $this->factory->post->create( array( 'post_type' => 'page', @@ -180,6 +193,15 @@ class WP_Test_REST_Schema_Initialization extends WP_Test_REST_TestCase { $page_revisions = array_values( wp_get_post_revisions( $page_id ) ); $page_revision_id = $page_revisions[ count( $page_revisions ) - 1 ]->ID; + // Create an autosave. + wp_create_post_autosave( + array( + 'post_ID' => $page_id, + 'post_content' => 'Autosave page content.', + 'post_type' => 'page', + ) + ); + $tag_id = $this->factory->tag->create( array( 'name' => 'REST API Client Fixture: Tag', @@ -271,6 +293,14 @@ class WP_Test_REST_Schema_Initialization extends WP_Test_REST_TestCase { 'route' => '/wp/v2/posts/' . $post_id . '/revisions/' . $post_revision_id, 'name' => 'revision', ), + array( + 'route' => '/wp/v2/posts/' . $post_id . '/autosaves', + 'name' => 'postAutosaves', + ), + array( + 'route' => '/wp/v2/posts/' . $post_id . '/autosaves/' . $post_revision_id, + 'name' => 'autosave', + ), array( 'route' => '/wp/v2/pages', 'name' => 'PagesCollection', @@ -287,6 +317,14 @@ class WP_Test_REST_Schema_Initialization extends WP_Test_REST_TestCase { 'route' => '/wp/v2/pages/' . $page_id . '/revisions/' . $page_revision_id, 'name' => 'pageRevision', ), + array( + 'route' => '/wp/v2/pages/' . $page_id . '/autosaves', + 'name' => 'pageAutosaves', + ), + array( + 'route' => '/wp/v2/pages/' . $page_id . '/autosaves/' . $page_revision_id, + 'name' => 'pageAutosave', + ), array( 'route' => '/wp/v2/media', 'name' => 'MediaCollection', diff --git a/tests/qunit/fixtures/wp-api-generated.js b/tests/qunit/fixtures/wp-api-generated.js index 583843fbc1..c70451fee5 100644 --- a/tests/qunit/fixtures/wp-api-generated.js +++ b/tests/qunit/fixtures/wp-api-generated.js @@ -783,6 +783,223 @@ mockedApiResponse.Schema = { } ] }, + "/wp/v2/posts/(?P[\\d]+)/autosaves": { + "namespace": "wp/v2", + "methods": [ + "GET", + "POST" + ], + "endpoints": [ + { + "methods": [ + "GET" + ], + "args": { + "parent": { + "required": false, + "description": "The ID for the parent of the object.", + "type": "integer" + }, + "context": { + "required": false, + "default": "view", + "enum": [ + "view", + "embed", + "edit" + ], + "description": "Scope under which the request is made; determines fields present in response.", + "type": "string" + } + } + }, + { + "methods": [ + "POST" + ], + "args": { + "parent": { + "required": false, + "description": "The ID for the parent of the object.", + "type": "integer" + }, + "author": { + "required": false, + "description": "The ID for the author of the object.", + "type": "integer" + }, + "date": { + "required": false, + "description": "The date the object was published, in the site's timezone.", + "type": "string" + }, + "date_gmt": { + "required": false, + "description": "The date the object was published, as GMT.", + "type": "string" + }, + "id": { + "required": false, + "description": "Unique identifier for the object.", + "type": "integer" + }, + "modified": { + "required": false, + "description": "The date the object was last modified, in the site's timezone.", + "type": "string" + }, + "modified_gmt": { + "required": false, + "description": "The date the object was last modified, as GMT.", + "type": "string" + }, + "slug": { + "required": false, + "description": "An alphanumeric identifier for the object unique to its type.", + "type": "string" + }, + "title": { + "required": false, + "description": "The title for the object.", + "type": "object" + }, + "content": { + "required": false, + "description": "The content for the object.", + "type": "object" + }, + "excerpt": { + "required": false, + "description": "The excerpt for the object.", + "type": "object" + } + } + } + ] + }, + "/wp/v2/posts/(?P[\\d]+)/autosaves/(?P[\\d]+)": { + "namespace": "wp/v2", + "methods": [ + "GET", + "DELETE", + "POST" + ], + "endpoints": [ + { + "methods": [ + "GET" + ], + "args": { + "parent": { + "required": false, + "description": "The ID for the parent of the object.", + "type": "integer" + }, + "id": { + "required": false, + "description": "Unique identifier for the object.", + "type": "integer" + }, + "context": { + "required": false, + "default": "view", + "enum": [ + "view", + "embed", + "edit" + ], + "description": "Scope under which the request is made; determines fields present in response.", + "type": "string" + } + } + }, + { + "methods": [ + "DELETE" + ], + "args": { + "parent": { + "required": false, + "description": "The ID for the parent of the object.", + "type": "integer" + }, + "id": { + "required": false, + "description": "Unique identifier for the object.", + "type": "integer" + }, + "force": { + "required": false, + "default": false, + "description": "Required to be true, as autosaves do not support trashing.", + "type": "boolean" + } + } + }, + { + "methods": [ + "POST" + ], + "args": { + "parent": { + "required": false, + "description": "The ID for the parent of the object.", + "type": "integer" + }, + "id": { + "required": false, + "description": "Unique identifier for the object.", + "type": "integer" + }, + "author": { + "required": false, + "description": "The ID for the author of the object.", + "type": "integer" + }, + "date": { + "required": false, + "description": "The date the object was published, in the site's timezone.", + "type": "string" + }, + "date_gmt": { + "required": false, + "description": "The date the object was published, as GMT.", + "type": "string" + }, + "modified": { + "required": false, + "description": "The date the object was last modified, in the site's timezone.", + "type": "string" + }, + "modified_gmt": { + "required": false, + "description": "The date the object was last modified, as GMT.", + "type": "string" + }, + "slug": { + "required": false, + "description": "An alphanumeric identifier for the object unique to its type.", + "type": "string" + }, + "title": { + "required": false, + "description": "The title for the object.", + "type": "object" + }, + "content": { + "required": false, + "description": "The content for the object.", + "type": "object" + }, + "excerpt": { + "required": false, + "description": "The excerpt for the object.", + "type": "object" + } + } + } + ] + }, "/wp/v2/pages": { "namespace": "wp/v2", "methods": [ @@ -1321,6 +1538,223 @@ mockedApiResponse.Schema = { } ] }, + "/wp/v2/pages/(?P[\\d]+)/autosaves": { + "namespace": "wp/v2", + "methods": [ + "GET", + "POST" + ], + "endpoints": [ + { + "methods": [ + "GET" + ], + "args": { + "parent": { + "required": false, + "description": "The ID for the parent of the object.", + "type": "integer" + }, + "context": { + "required": false, + "default": "view", + "enum": [ + "view", + "embed", + "edit" + ], + "description": "Scope under which the request is made; determines fields present in response.", + "type": "string" + } + } + }, + { + "methods": [ + "POST" + ], + "args": { + "parent": { + "required": false, + "description": "The ID for the parent of the object.", + "type": "integer" + }, + "author": { + "required": false, + "description": "The ID for the author of the object.", + "type": "integer" + }, + "date": { + "required": false, + "description": "The date the object was published, in the site's timezone.", + "type": "string" + }, + "date_gmt": { + "required": false, + "description": "The date the object was published, as GMT.", + "type": "string" + }, + "id": { + "required": false, + "description": "Unique identifier for the object.", + "type": "integer" + }, + "modified": { + "required": false, + "description": "The date the object was last modified, in the site's timezone.", + "type": "string" + }, + "modified_gmt": { + "required": false, + "description": "The date the object was last modified, as GMT.", + "type": "string" + }, + "slug": { + "required": false, + "description": "An alphanumeric identifier for the object unique to its type.", + "type": "string" + }, + "title": { + "required": false, + "description": "The title for the object.", + "type": "object" + }, + "content": { + "required": false, + "description": "The content for the object.", + "type": "object" + }, + "excerpt": { + "required": false, + "description": "The excerpt for the object.", + "type": "object" + } + } + } + ] + }, + "/wp/v2/pages/(?P[\\d]+)/autosaves/(?P[\\d]+)": { + "namespace": "wp/v2", + "methods": [ + "GET", + "DELETE", + "POST" + ], + "endpoints": [ + { + "methods": [ + "GET" + ], + "args": { + "parent": { + "required": false, + "description": "The ID for the parent of the object.", + "type": "integer" + }, + "id": { + "required": false, + "description": "Unique identifier for the object.", + "type": "integer" + }, + "context": { + "required": false, + "default": "view", + "enum": [ + "view", + "embed", + "edit" + ], + "description": "Scope under which the request is made; determines fields present in response.", + "type": "string" + } + } + }, + { + "methods": [ + "DELETE" + ], + "args": { + "parent": { + "required": false, + "description": "The ID for the parent of the object.", + "type": "integer" + }, + "id": { + "required": false, + "description": "Unique identifier for the object.", + "type": "integer" + }, + "force": { + "required": false, + "default": false, + "description": "Required to be true, as autosaves do not support trashing.", + "type": "boolean" + } + } + }, + { + "methods": [ + "POST" + ], + "args": { + "parent": { + "required": false, + "description": "The ID for the parent of the object.", + "type": "integer" + }, + "id": { + "required": false, + "description": "Unique identifier for the object.", + "type": "integer" + }, + "author": { + "required": false, + "description": "The ID for the author of the object.", + "type": "integer" + }, + "date": { + "required": false, + "description": "The date the object was published, in the site's timezone.", + "type": "string" + }, + "date_gmt": { + "required": false, + "description": "The date the object was published, as GMT.", + "type": "string" + }, + "modified": { + "required": false, + "description": "The date the object was last modified, in the site's timezone.", + "type": "string" + }, + "modified_gmt": { + "required": false, + "description": "The date the object was last modified, as GMT.", + "type": "string" + }, + "slug": { + "required": false, + "description": "An alphanumeric identifier for the object unique to its type.", + "type": "string" + }, + "title": { + "required": false, + "description": "The title for the object.", + "type": "object" + }, + "content": { + "required": false, + "description": "The content for the object.", + "type": "object" + }, + "excerpt": { + "required": false, + "description": "The excerpt for the object.", + "type": "object" + } + } + } + ] + }, "/wp/v2/media": { "namespace": "wp/v2", "methods": [ @@ -3669,6 +4103,35 @@ mockedApiResponse.postRevisions = [ "guid": { "rendered": "http://example.org/?p=4" }, + "title": { + "rendered": "" + }, + "content": { + "rendered": "

Autosave post content.

\n" + }, + "excerpt": { + "rendered": "" + }, + "_links": { + "parent": [ + { + "href": "http://example.org/index.php?rest_route=/wp/v2/posts/3" + } + ] + } + }, + { + "author": 59, + "date": "2017-02-14T00:00:00", + "date_gmt": "2017-02-14T00:00:00", + "id": 427, + "modified": "2017-02-14T00:00:00", + "modified_gmt": "2017-02-14T00:00:00", + "parent": 426, + "slug": "426-revision-v1", + "guid": { + "rendered": "http://example.org/?p=427" + }, "title": { "rendered": "REST API Client Fixture: Post" }, @@ -3681,7 +4144,7 @@ mockedApiResponse.postRevisions = [ "_links": { "parent": [ { - "href": "http://example.org/index.php?rest_route=/wp/v2/posts/3" + "href": "http://example.org/index.php?rest_route=/wp/v2/posts/426" } ] } @@ -3711,6 +4174,65 @@ mockedApiResponse.revision = { } }; +mockedApiResponse.postAutosaves = [ + { + "author": 59, + "date": "2017-02-14T00:00:00", + "date_gmt": "2017-02-14T00:00:00", + "id": 428, + "modified": "2017-02-14T00:00:00", + "modified_gmt": "2017-02-14T00:00:00", + "parent": 426, + "slug": "426-autosave-v1", + "guid": { + "rendered": "http://example.org/?p=428" + }, + "title": { + "rendered": "" + }, + "content": { + "rendered": "

Autosave post content.

\n" + }, + "excerpt": { + "rendered": "" + }, + "_links": { + "parent": [ + { + "href": "http://example.org/index.php?rest_route=/426" + } + ] + } + } +]; + +mockedApiResponse.autosave = { + "ID": 427, + "post_author": "59", + "post_date": "2018-03-10 16:46:38", + "post_date_gmt": "2018-03-10 16:46:38", + "post_content": "Updated post content.", + "post_title": "REST API Client Fixture: Post", + "post_excerpt": "REST API Client Fixture: Post", + "post_status": "inherit", + "comment_status": "closed", + "ping_status": "closed", + "post_password": "", + "post_name": "426-revision-v1", + "to_ping": "", + "pinged": "", + "post_modified": "2018-03-10 16:46:38", + "post_modified_gmt": "2018-03-10 16:46:38", + "post_content_filtered": "", + "post_parent": 426, + "guid": "http://example.org/?p=427", + "menu_order": 0, + "post_type": "revision", + "post_mime_type": "", + "comment_count": "0", + "filter": "raw" +}; + mockedApiResponse.PagesCollection = [ { "id": 5, @@ -3838,6 +4360,35 @@ mockedApiResponse.pageRevisions = [ "guid": { "rendered": "http://example.org/?p=6" }, + "title": { + "rendered": "" + }, + "content": { + "rendered": "

Autosave page content.

\n" + }, + "excerpt": { + "rendered": "" + }, + "_links": { + "parent": [ + { + "href": "http://example.org/index.php?rest_route=/wp/v2/pages/5" + } + ] + } + }, + { + "author": 59, + "date": "2017-02-14T00:00:00", + "date_gmt": "2017-02-14T00:00:00", + "id": 430, + "modified": "2017-02-14T00:00:00", + "modified_gmt": "2017-02-14T00:00:00", + "parent": 429, + "slug": "429-revision-v1", + "guid": { + "rendered": "http://example.org/?p=430" + }, "title": { "rendered": "REST API Client Fixture: Page" }, @@ -3850,7 +4401,7 @@ mockedApiResponse.pageRevisions = [ "_links": { "parent": [ { - "href": "http://example.org/index.php?rest_route=/wp/v2/pages/5" + "href": "http://example.org/index.php?rest_route=/wp/v2/pages/429" } ] } @@ -3880,6 +4431,65 @@ mockedApiResponse.pageRevision = { } }; +mockedApiResponse.pageAutosaves = [ + { + "author": 59, + "date": "2017-02-14T00:00:00", + "date_gmt": "2017-02-14T00:00:00", + "id": 431, + "modified": "2017-02-14T00:00:00", + "modified_gmt": "2017-02-14T00:00:00", + "parent": 429, + "slug": "429-autosave-v1", + "guid": { + "rendered": "http://example.org/?p=431" + }, + "title": { + "rendered": "" + }, + "content": { + "rendered": "

Autosave page content.

\n" + }, + "excerpt": { + "rendered": "" + }, + "_links": { + "parent": [ + { + "href": "http://example.org/index.php?rest_route=/429" + } + ] + } + } +]; + +mockedApiResponse.pageAutosave = { + "ID": 430, + "post_author": "59", + "post_date": "2018-03-10 16:46:38", + "post_date_gmt": "2018-03-10 16:46:38", + "post_content": "Updated page content.", + "post_title": "REST API Client Fixture: Page", + "post_excerpt": "REST API Client Fixture: Page", + "post_status": "inherit", + "comment_status": "closed", + "ping_status": "closed", + "post_password": "", + "post_name": "429-revision-v1", + "to_ping": "", + "pinged": "", + "post_modified": "2018-03-10 16:46:38", + "post_modified_gmt": "2018-03-10 16:46:38", + "post_content_filtered": "", + "post_parent": 429, + "guid": "http://example.org/?p=430", + "menu_order": 0, + "post_type": "revision", + "post_mime_type": "", + "comment_count": "0", + "filter": "raw" +}; + mockedApiResponse.MediaCollection = [ { "id": 7,