mirror of
https://github.com/gosticks/wordpress-develop.git
synced 2025-10-16 12:05:38 +00:00
83d27ba447
This commit modifies the `rest_get_date_with_gmt` function to correctly parse local and UTC timestamps with or without timezone information. It also ensures that the REST API can edit the dates of draft posts by setting the `edit_date` flag to `wp_update_post`. Overall this commit ensures that post and comment dates can be set and updated as expected. Fixes #39256. git-svn-id: https://develop.svn.wordpress.org/trunk@40101 602fd350-edb4-49c9-b593-d223f7449a82
450 lines
15 KiB
PHP
450 lines
15 KiB
PHP
<?php
|
|
/**
|
|
* REST API functions.
|
|
*
|
|
* @package WordPress
|
|
* @subpackage REST API
|
|
*/
|
|
|
|
require_once ABSPATH . 'wp-admin/includes/admin.php';
|
|
require_once ABSPATH . WPINC . '/rest-api.php';
|
|
|
|
/**
|
|
* @group restapi
|
|
*/
|
|
class Tests_REST_API extends WP_UnitTestCase {
|
|
public function setUp() {
|
|
// Override the normal server with our spying server.
|
|
$GLOBALS['wp_rest_server'] = new Spy_REST_Server();
|
|
parent::setup();
|
|
}
|
|
|
|
/**
|
|
* Checks that the main classes are loaded.
|
|
*/
|
|
function test_rest_api_active() {
|
|
$this->assertTrue( class_exists( 'WP_REST_Server' ) );
|
|
$this->assertTrue( class_exists( 'WP_REST_Request' ) );
|
|
$this->assertTrue( class_exists( 'WP_REST_Response' ) );
|
|
$this->assertTrue( class_exists( 'WP_REST_Posts_Controller' ) );
|
|
}
|
|
|
|
/**
|
|
* The rest_api_init hook should have been registered with init, and should
|
|
* have a default priority of 10.
|
|
*/
|
|
function test_init_action_added() {
|
|
$this->assertEquals( 10, has_action( 'init', 'rest_api_init' ) );
|
|
}
|
|
|
|
public function test_add_extra_api_taxonomy_arguments() {
|
|
$taxonomy = get_taxonomy( 'category' );
|
|
$this->assertTrue( $taxonomy->show_in_rest );
|
|
$this->assertEquals( 'categories', $taxonomy->rest_base );
|
|
$this->assertEquals( 'WP_REST_Terms_Controller', $taxonomy->rest_controller_class );
|
|
|
|
$taxonomy = get_taxonomy( 'post_tag' );
|
|
$this->assertTrue( $taxonomy->show_in_rest );
|
|
$this->assertEquals( 'tags', $taxonomy->rest_base );
|
|
$this->assertEquals( 'WP_REST_Terms_Controller', $taxonomy->rest_controller_class );
|
|
}
|
|
|
|
public function test_add_extra_api_post_type_arguments() {
|
|
$post_type = get_post_type_object( 'post' );
|
|
$this->assertTrue( $post_type->show_in_rest );
|
|
$this->assertEquals( 'posts', $post_type->rest_base );
|
|
$this->assertEquals( 'WP_REST_Posts_Controller', $post_type->rest_controller_class );
|
|
|
|
$post_type = get_post_type_object( 'page' );
|
|
$this->assertTrue( $post_type->show_in_rest );
|
|
$this->assertEquals( 'pages', $post_type->rest_base );
|
|
$this->assertEquals( 'WP_REST_Posts_Controller', $post_type->rest_controller_class );
|
|
|
|
$post_type = get_post_type_object( 'attachment' );
|
|
$this->assertTrue( $post_type->show_in_rest );
|
|
$this->assertEquals( 'media', $post_type->rest_base );
|
|
$this->assertEquals( 'WP_REST_Attachments_Controller', $post_type->rest_controller_class );
|
|
}
|
|
|
|
/**
|
|
* Check that a single route is canonicalized.
|
|
*
|
|
* Ensures that single and multiple routes are handled correctly.
|
|
*/
|
|
public function test_route_canonicalized() {
|
|
register_rest_route( 'test-ns', '/test', array(
|
|
'methods' => array( 'GET' ),
|
|
'callback' => '__return_null',
|
|
) );
|
|
|
|
// Check the route was registered correctly.
|
|
$endpoints = $GLOBALS['wp_rest_server']->get_raw_endpoint_data();
|
|
$this->assertArrayHasKey( '/test-ns/test', $endpoints );
|
|
|
|
// Check the route was wrapped in an array.
|
|
$endpoint = $endpoints['/test-ns/test'];
|
|
$this->assertArrayNotHasKey( 'callback', $endpoint );
|
|
$this->assertArrayHasKey( 'namespace', $endpoint );
|
|
$this->assertEquals( 'test-ns', $endpoint['namespace'] );
|
|
|
|
// Grab the filtered data.
|
|
$filtered_endpoints = $GLOBALS['wp_rest_server']->get_routes();
|
|
$this->assertArrayHasKey( '/test-ns/test', $filtered_endpoints );
|
|
$endpoint = $filtered_endpoints['/test-ns/test'];
|
|
$this->assertCount( 1, $endpoint );
|
|
$this->assertArrayHasKey( 'callback', $endpoint[0] );
|
|
$this->assertArrayHasKey( 'methods', $endpoint[0] );
|
|
$this->assertArrayHasKey( 'args', $endpoint[0] );
|
|
}
|
|
|
|
/**
|
|
* Check that a single route is canonicalized.
|
|
*
|
|
* Ensures that single and multiple routes are handled correctly.
|
|
*/
|
|
public function test_route_canonicalized_multiple() {
|
|
register_rest_route( 'test-ns', '/test', array(
|
|
array(
|
|
'methods' => array( 'GET' ),
|
|
'callback' => '__return_null',
|
|
),
|
|
array(
|
|
'methods' => array( 'POST' ),
|
|
'callback' => '__return_null',
|
|
),
|
|
) );
|
|
|
|
// Check the route was registered correctly.
|
|
$endpoints = $GLOBALS['wp_rest_server']->get_raw_endpoint_data();
|
|
$this->assertArrayHasKey( '/test-ns/test', $endpoints );
|
|
|
|
// Check the route was wrapped in an array.
|
|
$endpoint = $endpoints['/test-ns/test'];
|
|
$this->assertArrayNotHasKey( 'callback', $endpoint );
|
|
$this->assertArrayHasKey( 'namespace', $endpoint );
|
|
$this->assertEquals( 'test-ns', $endpoint['namespace'] );
|
|
|
|
$filtered_endpoints = $GLOBALS['wp_rest_server']->get_routes();
|
|
$endpoint = $filtered_endpoints['/test-ns/test'];
|
|
$this->assertCount( 2, $endpoint );
|
|
|
|
// Check for both methods.
|
|
foreach ( array( 0, 1 ) as $key ) {
|
|
$this->assertArrayHasKey( 'callback', $endpoint[ $key ] );
|
|
$this->assertArrayHasKey( 'methods', $endpoint[ $key ] );
|
|
$this->assertArrayHasKey( 'args', $endpoint[ $key ] );
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Check that routes are merged by default.
|
|
*/
|
|
public function test_route_merge() {
|
|
register_rest_route( 'test-ns', '/test', array(
|
|
'methods' => array( 'GET' ),
|
|
'callback' => '__return_null',
|
|
) );
|
|
register_rest_route( 'test-ns', '/test', array(
|
|
'methods' => array( 'POST' ),
|
|
'callback' => '__return_null',
|
|
) );
|
|
|
|
// Check both routes exist.
|
|
$endpoints = $GLOBALS['wp_rest_server']->get_routes();
|
|
$endpoint = $endpoints['/test-ns/test'];
|
|
$this->assertCount( 2, $endpoint );
|
|
}
|
|
|
|
/**
|
|
* Check that we can override routes.
|
|
*/
|
|
public function test_route_override() {
|
|
register_rest_route( 'test-ns', '/test', array(
|
|
'methods' => array( 'GET' ),
|
|
'callback' => '__return_null',
|
|
'should_exist' => false,
|
|
) );
|
|
register_rest_route( 'test-ns', '/test', array(
|
|
'methods' => array( 'POST' ),
|
|
'callback' => '__return_null',
|
|
'should_exist' => true,
|
|
), true );
|
|
|
|
// Check we only have one route.
|
|
$endpoints = $GLOBALS['wp_rest_server']->get_routes();
|
|
$endpoint = $endpoints['/test-ns/test'];
|
|
$this->assertCount( 1, $endpoint );
|
|
|
|
// Check it's the right one.
|
|
$this->assertArrayHasKey( 'should_exist', $endpoint[0] );
|
|
$this->assertTrue( $endpoint[0]['should_exist'] );
|
|
}
|
|
|
|
/**
|
|
* Test that we reject routes without namespaces
|
|
*
|
|
* @expectedIncorrectUsage register_rest_route
|
|
*/
|
|
public function test_route_reject_empty_namespace() {
|
|
register_rest_route( '', '/test-empty-namespace', array(
|
|
'methods' => array( 'POST' ),
|
|
'callback' => '__return_null',
|
|
), true );
|
|
$endpoints = $GLOBALS['wp_rest_server']->get_routes();
|
|
$this->assertFalse( isset( $endpoints['/test-empty-namespace'] ) );
|
|
}
|
|
|
|
/**
|
|
* Test that we reject empty routes
|
|
*
|
|
* @expectedIncorrectUsage register_rest_route
|
|
*/
|
|
public function test_route_reject_empty_route() {
|
|
register_rest_route( '/test-empty-route', '', array(
|
|
'methods' => array( 'POST' ),
|
|
'callback' => '__return_null',
|
|
), true );
|
|
$endpoints = $GLOBALS['wp_rest_server']->get_routes();
|
|
$this->assertFalse( isset( $endpoints['/test-empty-route'] ) );
|
|
}
|
|
|
|
/**
|
|
* The rest_route query variable should be registered.
|
|
*/
|
|
function test_rest_route_query_var() {
|
|
rest_api_init();
|
|
$this->assertTrue( in_array( 'rest_route', $GLOBALS['wp']->public_query_vars ) );
|
|
}
|
|
|
|
public function test_route_method() {
|
|
register_rest_route( 'test-ns', '/test', array(
|
|
'methods' => array( 'GET' ),
|
|
'callback' => '__return_null',
|
|
) );
|
|
|
|
$routes = $GLOBALS['wp_rest_server']->get_routes();
|
|
|
|
$this->assertEquals( $routes['/test-ns/test'][0]['methods'], array( 'GET' => true ) );
|
|
}
|
|
|
|
/**
|
|
* The 'methods' arg should accept a single value as well as array.
|
|
*/
|
|
public function test_route_method_string() {
|
|
register_rest_route( 'test-ns', '/test', array(
|
|
'methods' => 'GET',
|
|
'callback' => '__return_null',
|
|
) );
|
|
|
|
$routes = $GLOBALS['wp_rest_server']->get_routes();
|
|
|
|
$this->assertEquals( $routes['/test-ns/test'][0]['methods'], array( 'GET' => true ) );
|
|
}
|
|
|
|
/**
|
|
* The 'methods' arg should accept a single value as well as array.
|
|
*/
|
|
public function test_route_method_array() {
|
|
register_rest_route( 'test-ns', '/test', array(
|
|
'methods' => array( 'GET', 'POST' ),
|
|
'callback' => '__return_null',
|
|
) );
|
|
|
|
$routes = $GLOBALS['wp_rest_server']->get_routes();
|
|
|
|
$this->assertEquals( $routes['/test-ns/test'][0]['methods'], array( 'GET' => true, 'POST' => true ) );
|
|
}
|
|
|
|
/**
|
|
* The 'methods' arg should a comma seperated string.
|
|
*/
|
|
public function test_route_method_comma_seperated() {
|
|
register_rest_route( 'test-ns', '/test', array(
|
|
'methods' => 'GET,POST',
|
|
'callback' => '__return_null',
|
|
) );
|
|
|
|
$routes = $GLOBALS['wp_rest_server']->get_routes();
|
|
|
|
$this->assertEquals( $routes['/test-ns/test'][0]['methods'], array( 'GET' => true, 'POST' => true ) );
|
|
}
|
|
|
|
public function test_options_request() {
|
|
register_rest_route( 'test-ns', '/test', array(
|
|
'methods' => 'GET,POST',
|
|
'callback' => '__return_null',
|
|
) );
|
|
|
|
$request = new WP_REST_Request( 'OPTIONS', '/test-ns/test' );
|
|
$response = rest_handle_options_request( null, $GLOBALS['wp_rest_server'], $request );
|
|
$response = rest_send_allow_header( $response, $GLOBALS['wp_rest_server'], $request );
|
|
$headers = $response->get_headers();
|
|
$this->assertArrayHasKey( 'Allow', $headers );
|
|
|
|
$this->assertEquals( 'GET, POST', $headers['Allow'] );
|
|
}
|
|
|
|
/**
|
|
* Ensure that the OPTIONS handler doesn't kick in for non-OPTIONS requests.
|
|
*/
|
|
public function test_options_request_not_options() {
|
|
register_rest_route( 'test-ns', '/test', array(
|
|
'methods' => 'GET,POST',
|
|
'callback' => '__return_true',
|
|
) );
|
|
|
|
$request = new WP_REST_Request( 'GET', '/test-ns/test' );
|
|
$response = rest_handle_options_request( null, $GLOBALS['wp_rest_server'], $request );
|
|
|
|
$this->assertNull( $response );
|
|
}
|
|
|
|
/**
|
|
* The get_rest_url function should return a URL consistently terminated with a "/",
|
|
* whether the blog is configured with pretty permalink support or not.
|
|
*/
|
|
public function test_rest_url_generation() {
|
|
// In pretty permalinks case, we expect a path of wp-json/ with no query.
|
|
$this->set_permalink_structure( '/%year%/%monthnum%/%day%/%postname%/' );
|
|
$this->assertEquals( 'http://' . WP_TESTS_DOMAIN . '/wp-json/', get_rest_url() );
|
|
|
|
// In index permalinks case, we expect a path of index.php/wp-json/ with no query.
|
|
$this->set_permalink_structure( '/index.php/%year%/%monthnum%/%day%/%postname%/' );
|
|
$this->assertEquals( 'http://' . WP_TESTS_DOMAIN . '/index.php/wp-json/', get_rest_url() );
|
|
|
|
// In non-pretty case, we get a query string to invoke the rest router.
|
|
$this->set_permalink_structure( '' );
|
|
$this->assertEquals( 'http://' . WP_TESTS_DOMAIN . '/?rest_route=/', get_rest_url() );
|
|
|
|
}
|
|
/**
|
|
* @ticket 34299
|
|
*/
|
|
public function test_rest_url_scheme() {
|
|
$_SERVER['SERVER_NAME'] = parse_url( home_url(), PHP_URL_HOST );
|
|
$_siteurl = get_option( 'siteurl' );
|
|
|
|
set_current_screen( 'edit.php' );
|
|
$this->assertTrue( is_admin() );
|
|
|
|
// Test an HTTP URL
|
|
unset( $_SERVER['HTTPS'] );
|
|
$url = get_rest_url();
|
|
$this->assertSame( 'http', parse_url( $url, PHP_URL_SCHEME ) );
|
|
|
|
// Test an HTTPS URL
|
|
$_SERVER['HTTPS'] = 'on';
|
|
$url = get_rest_url();
|
|
$this->assertSame( 'https', parse_url( $url, PHP_URL_SCHEME ) );
|
|
|
|
// Switch to an admin request on a different domain name
|
|
$_SERVER['SERVER_NAME'] = 'admin.example.org';
|
|
update_option( 'siteurl', 'http://admin.example.org' );
|
|
$this->assertNotEquals( $_SERVER['SERVER_NAME'], parse_url( home_url(), PHP_URL_HOST ) );
|
|
|
|
// // Test an HTTP URL
|
|
unset( $_SERVER['HTTPS'] );
|
|
$url = get_rest_url();
|
|
$this->assertSame( 'http', parse_url( $url, PHP_URL_SCHEME ) );
|
|
|
|
// // Test an HTTPS URL
|
|
$_SERVER['HTTPS'] = 'on';
|
|
$url = get_rest_url();
|
|
$this->assertSame( 'http', parse_url( $url, PHP_URL_SCHEME ) );
|
|
|
|
// Reset
|
|
update_option( 'siteurl', $_siteurl );
|
|
set_current_screen( 'front' );
|
|
|
|
}
|
|
|
|
public function jsonp_callback_provider() {
|
|
return array(
|
|
// Standard names
|
|
array( 'Springfield', true ),
|
|
array( 'shelby.ville', true ),
|
|
array( 'cypress_creek', true ),
|
|
array( 'KampKrusty1', true ),
|
|
|
|
// Invalid names
|
|
array( 'ogden-ville', false ),
|
|
array( 'north haverbrook', false ),
|
|
array( "Terror['Lake']", false ),
|
|
array( 'Cape[Feare]', false ),
|
|
array( '"NewHorrorfield"', false ),
|
|
array( 'Scream\\ville', false ),
|
|
);
|
|
}
|
|
|
|
/**
|
|
* @dataProvider jsonp_callback_provider
|
|
*/
|
|
public function test_jsonp_callback_check( $callback, $valid ) {
|
|
$this->assertEquals( $valid, wp_check_jsonp_callback( $callback ) );
|
|
}
|
|
|
|
public function rest_date_provider() {
|
|
return array(
|
|
// Valid dates with timezones
|
|
array( '2017-01-16T11:30:00-05:00', gmmktime( 11, 30, 0, 1, 16, 2017 ) + 5 * HOUR_IN_SECONDS ),
|
|
array( '2017-01-16T11:30:00-05:30', gmmktime( 11, 30, 0, 1, 16, 2017 ) + 5.5 * HOUR_IN_SECONDS ),
|
|
array( '2017-01-16T11:30:00-05' , gmmktime( 11, 30, 0, 1, 16, 2017 ) + 5 * HOUR_IN_SECONDS ),
|
|
array( '2017-01-16T11:30:00+05' , gmmktime( 11, 30, 0, 1, 16, 2017 ) - 5 * HOUR_IN_SECONDS ),
|
|
array( '2017-01-16T11:30:00-00' , gmmktime( 11, 30, 0, 1, 16, 2017 ) ),
|
|
array( '2017-01-16T11:30:00+00' , gmmktime( 11, 30, 0, 1, 16, 2017 ) ),
|
|
array( '2017-01-16T11:30:00Z' , gmmktime( 11, 30, 0, 1, 16, 2017 ) ),
|
|
|
|
// Valid dates without timezones
|
|
array( '2017-01-16T11:30:00' , gmmktime( 11, 30, 0, 1, 16, 2017 ) ),
|
|
|
|
// Invalid dates (TODO: support parsing partial dates as ranges, see #38641)
|
|
array( '2017-01-16T11:30:00-5', false ),
|
|
array( '2017-01-16T11:30', false ),
|
|
array( '2017-01-16T11', false ),
|
|
array( '2017-01-16T', false ),
|
|
array( '2017-01-16', false ),
|
|
array( '2017-01', false ),
|
|
array( '2017', false ),
|
|
);
|
|
}
|
|
|
|
/**
|
|
* @dataProvider rest_date_provider
|
|
*/
|
|
public function test_rest_parse_date( $string, $value ) {
|
|
$this->assertEquals( $value, rest_parse_date( $string ) );
|
|
}
|
|
|
|
public function rest_date_force_utc_provider() {
|
|
return array(
|
|
// Valid dates with timezones
|
|
array( '2017-01-16T11:30:00-05:00', gmmktime( 11, 30, 0, 1, 16, 2017 ) ),
|
|
array( '2017-01-16T11:30:00-05:30', gmmktime( 11, 30, 0, 1, 16, 2017 ) ),
|
|
array( '2017-01-16T11:30:00-05' , gmmktime( 11, 30, 0, 1, 16, 2017 ) ),
|
|
array( '2017-01-16T11:30:00+05' , gmmktime( 11, 30, 0, 1, 16, 2017 ) ),
|
|
array( '2017-01-16T11:30:00-00' , gmmktime( 11, 30, 0, 1, 16, 2017 ) ),
|
|
array( '2017-01-16T11:30:00+00' , gmmktime( 11, 30, 0, 1, 16, 2017 ) ),
|
|
array( '2017-01-16T11:30:00Z' , gmmktime( 11, 30, 0, 1, 16, 2017 ) ),
|
|
|
|
// Valid dates without timezones
|
|
array( '2017-01-16T11:30:00' , gmmktime( 11, 30, 0, 1, 16, 2017 ) ),
|
|
|
|
// Invalid dates (TODO: support parsing partial dates as ranges, see #38641)
|
|
array( '2017-01-16T11:30:00-5', false ),
|
|
array( '2017-01-16T11:30', false ),
|
|
array( '2017-01-16T11', false ),
|
|
array( '2017-01-16T', false ),
|
|
array( '2017-01-16', false ),
|
|
array( '2017-01', false ),
|
|
array( '2017', false ),
|
|
);
|
|
}
|
|
|
|
/**
|
|
* @dataProvider rest_date_force_utc_provider
|
|
*/
|
|
public function test_rest_parse_date_force_utc( $string, $value ) {
|
|
$this->assertEquals( $value, rest_parse_date( $string, true ) );
|
|
}
|
|
}
|