mirror of
https://github.com/gosticks/wordpress-develop.git
synced 2025-10-16 12:05:38 +00:00
cac678f807
r49212 greatly improved the performance of `get_dirsize()`, but also changed the structure of the data stored in the `dirsize_cache` transient. It stored relative paths instead of absolute ones, and also removed the unnecessary `size` array. That difference in data structures led to a fatal error in the following environment: * PHP 8 * Multisite * A custom `WP_CONTENT_DIR` which is not a child of WP's `ABSPATH` folder (e.g., [https://roots.io/bedrock/ Bedrock]) * The `upload_space_check_disabled` option set to `0` After upgrading to WP 5.6, the `dirsize_cache` transient still had data in the old format. When `wp-admin.php/index.php` was visited, `get_space_used()` received an `array` instead of an `int`, and tried to divide it by another `int`. PHP 7 would silently cast the arguments to match data types, but [https://wiki.php.net/rfc/arithmetic_operator_type_checks PHP 8 throws a fatal error]: `Uncaught TypeError: Unsupported operand types: array / int` `recurse_dirsize()` was using `ABSPATH` to convert the absolute paths to relative ones, but some upload locations are not located under `ABSPATH`. In those cases, `$directory` and `$cache_path` were identical, and that triggered the early return of the old `array`, instead of the expected `int`. In order to avoid that, this commit restores the absolute paths, but without the `size` array. It also adds a type check when returning cached values. Using absolute paths without `size` has the result of overwriting the old data, so that it matches the new format. The type check and upgrade routine are additional safety measures. Props peterwilsoncc, janthiel, helen, hellofromtonya, francina, pbiron. Fixes #51913. See #19879. git-svn-id: https://develop.svn.wordpress.org/trunk@49744 602fd350-edb4-49c9-b593-d223f7449a82
333 lines
12 KiB
PHP
333 lines
12 KiB
PHP
<?php
|
|
|
|
if ( is_multisite() ) :
|
|
|
|
/**
|
|
* Tests specific to the directory size caching in multisite.
|
|
*
|
|
* @ticket 19879
|
|
* @group multisite
|
|
*/
|
|
class Tests_Multisite_Dirsize_Cache extends WP_UnitTestCase {
|
|
protected $suppress = false;
|
|
|
|
function setUp() {
|
|
global $wpdb;
|
|
parent::setUp();
|
|
$this->suppress = $wpdb->suppress_errors();
|
|
}
|
|
|
|
function tearDown() {
|
|
global $wpdb;
|
|
$wpdb->suppress_errors( $this->suppress );
|
|
parent::tearDown();
|
|
}
|
|
|
|
/**
|
|
* Test whether dirsize_cache values are used correctly with a more complex dirsize cache mock.
|
|
*
|
|
* @ticket 19879
|
|
*/
|
|
function test_get_dirsize_cache_in_recurse_dirsize_mock() {
|
|
$blog_id = self::factory()->blog->create();
|
|
switch_to_blog( $blog_id );
|
|
|
|
/*
|
|
* Our comparison of space relies on an initial value of 0. If a previous test has failed
|
|
* or if the `src` directory already contains a directory with site content, then the initial
|
|
* expectation will be polluted. We create sites until an empty one is available.
|
|
*/
|
|
while ( 0 !== get_space_used() ) {
|
|
restore_current_blog();
|
|
$blog_id = self::factory()->blog->create();
|
|
switch_to_blog( $blog_id );
|
|
}
|
|
|
|
// Clear the dirsize cache.
|
|
delete_transient( 'dirsize_cache' );
|
|
|
|
// Set the dirsize cache to our mock.
|
|
set_transient( 'dirsize_cache', $this->_get_mock_dirsize_cache_for_site( $blog_id ) );
|
|
|
|
$upload_dir = wp_upload_dir();
|
|
|
|
// Check recurse_dirsize() against the mock. The cache should match.
|
|
$this->assertSame( 21, recurse_dirsize( $upload_dir['basedir'] . '/2/1' ) );
|
|
$this->assertSame( 22, recurse_dirsize( $upload_dir['basedir'] . '/2/2' ) );
|
|
$this->assertSame( 2, recurse_dirsize( $upload_dir['basedir'] . '/2' ) );
|
|
$this->assertSame( 11, recurse_dirsize( $upload_dir['basedir'] . '/1/1' ) );
|
|
$this->assertSame( 12, recurse_dirsize( $upload_dir['basedir'] . '/1/2' ) );
|
|
$this->assertSame( 13, recurse_dirsize( $upload_dir['basedir'] . '/1/3' ) );
|
|
$this->assertSame( 1, recurse_dirsize( $upload_dir['basedir'] . '/1' ) );
|
|
$this->assertSame( 42, recurse_dirsize( $upload_dir['basedir'] . '/custom_directory' ) );
|
|
|
|
// No cache match, upload directory should be empty and return 0.
|
|
$this->assertSame( 0, recurse_dirsize( $upload_dir['basedir'] ) );
|
|
|
|
// No cache match on non existing directory should return false.
|
|
$this->assertSame( false, recurse_dirsize( $upload_dir['basedir'] . '/does_not_exist' ) );
|
|
|
|
// Cleanup.
|
|
$this->remove_added_uploads();
|
|
restore_current_blog();
|
|
}
|
|
|
|
/**
|
|
* Test whether the dirsize_cache invalidation works given a file path as input.
|
|
*
|
|
* @ticket 19879
|
|
*/
|
|
function test_clean_dirsize_cache_file_input_mock() {
|
|
$blog_id = self::factory()->blog->create();
|
|
switch_to_blog( $blog_id );
|
|
|
|
/*
|
|
* Our comparison of space relies on an initial value of 0. If a previous test has failed
|
|
* or if the `src` directory already contains a directory with site content, then the initial
|
|
* expectation will be polluted. We create sites until an empty one is available.
|
|
*/
|
|
while ( 0 !== get_space_used() ) {
|
|
restore_current_blog();
|
|
$blog_id = self::factory()->blog->create();
|
|
switch_to_blog( $blog_id );
|
|
}
|
|
|
|
$upload_dir = wp_upload_dir();
|
|
$cache_key_prefix = untrailingslashit( $upload_dir['basedir'] );
|
|
|
|
// Clear the dirsize cache.
|
|
delete_transient( 'dirsize_cache' );
|
|
|
|
// Set the dirsize cache to our mock.
|
|
set_transient( 'dirsize_cache', $this->_get_mock_dirsize_cache_for_site( $blog_id ) );
|
|
|
|
$this->assertSame( true, array_key_exists( $cache_key_prefix . '/1/1', get_transient( 'dirsize_cache' ) ) );
|
|
$this->assertSame( true, array_key_exists( $cache_key_prefix . '/2/1', get_transient( 'dirsize_cache' ) ) );
|
|
$this->assertSame( true, array_key_exists( $cache_key_prefix . '/2', get_transient( 'dirsize_cache' ) ) );
|
|
|
|
// Invalidation should also respect the directory tree up.
|
|
// Should work fine with path to directory OR file.
|
|
clean_dirsize_cache( $upload_dir['basedir'] . '/2/1/file.dummy' );
|
|
|
|
$this->assertSame( false, array_key_exists( $cache_key_prefix . '/2/1', get_transient( 'dirsize_cache' ) ) );
|
|
$this->assertSame( false, array_key_exists( $cache_key_prefix . '/2', get_transient( 'dirsize_cache' ) ) );
|
|
|
|
// Other cache paths should not be invalidated.
|
|
$this->assertSame( true, array_key_exists( $cache_key_prefix . '/1/1', get_transient( 'dirsize_cache' ) ) );
|
|
|
|
// Cleanup.
|
|
$this->remove_added_uploads();
|
|
restore_current_blog();
|
|
}
|
|
|
|
/**
|
|
* Test whether the dirsize_cache invalidation works given a directory path as input.
|
|
*
|
|
* @ticket 19879
|
|
*/
|
|
function test_clean_dirsize_cache_folder_input_mock() {
|
|
$blog_id = self::factory()->blog->create();
|
|
switch_to_blog( $blog_id );
|
|
|
|
/*
|
|
* Our comparison of space relies on an initial value of 0. If a previous test has failed
|
|
* or if the `src` directory already contains a directory with site content, then the initial
|
|
* expectation will be polluted. We create sites until an empty one is available.
|
|
*/
|
|
while ( 0 !== get_space_used() ) {
|
|
restore_current_blog();
|
|
$blog_id = self::factory()->blog->create();
|
|
switch_to_blog( $blog_id );
|
|
}
|
|
|
|
$upload_dir = wp_upload_dir();
|
|
$cache_key_prefix = untrailingslashit( $upload_dir['basedir'] );
|
|
|
|
// Clear the dirsize cache.
|
|
delete_transient( 'dirsize_cache' );
|
|
|
|
// Set the dirsize cache to our mock.
|
|
set_transient( 'dirsize_cache', $this->_get_mock_dirsize_cache_for_site( $blog_id ) );
|
|
|
|
$this->assertSame( true, array_key_exists( $cache_key_prefix . '/1/1', get_transient( 'dirsize_cache' ) ) );
|
|
$this->assertSame( true, array_key_exists( $cache_key_prefix . '/2/1', get_transient( 'dirsize_cache' ) ) );
|
|
$this->assertSame( true, array_key_exists( $cache_key_prefix . '/2', get_transient( 'dirsize_cache' ) ) );
|
|
|
|
// Invalidation should also respect the directory tree up.
|
|
// Should work fine with path to directory OR file.
|
|
clean_dirsize_cache( $upload_dir['basedir'] . '/2/1' );
|
|
|
|
$this->assertSame( false, array_key_exists( $cache_key_prefix . '/2/1', get_transient( 'dirsize_cache' ) ) );
|
|
$this->assertSame( false, array_key_exists( $cache_key_prefix . '/2', get_transient( 'dirsize_cache' ) ) );
|
|
|
|
// Other cache paths should not be invalidated.
|
|
$this->assertSame( true, array_key_exists( $cache_key_prefix . '/1/1', get_transient( 'dirsize_cache' ) ) );
|
|
|
|
// Cleanup.
|
|
$this->remove_added_uploads();
|
|
restore_current_blog();
|
|
}
|
|
|
|
/**
|
|
* Test whether dirsize_cache values are used correctly with a simple real upload.
|
|
*
|
|
* @ticket 19879
|
|
*/
|
|
function test_get_dirsize_cache_in_recurse_dirsize_upload() {
|
|
$blog_id = self::factory()->blog->create();
|
|
switch_to_blog( $blog_id );
|
|
|
|
/*
|
|
* Our comparison of space relies on an initial value of 0. If a previous test has failed
|
|
* or if the `src` directory already contains a directory with site content, then the initial
|
|
* expectation will be polluted. We create sites until an empty one is available.
|
|
*/
|
|
while ( 0 !== get_space_used() ) {
|
|
restore_current_blog();
|
|
$blog_id = self::factory()->blog->create();
|
|
switch_to_blog( $blog_id );
|
|
}
|
|
|
|
// Clear the dirsize cache.
|
|
delete_transient( 'dirsize_cache' );
|
|
|
|
$upload_dir = wp_upload_dir();
|
|
|
|
$this->assertSame( 0, recurse_dirsize( $upload_dir['path'] ) );
|
|
|
|
// Upload a file to the new site using wp_upload_bits().
|
|
$filename = __FUNCTION__ . '.jpg';
|
|
$contents = __FUNCTION__ . '_contents';
|
|
$file = wp_upload_bits( $filename, null, $contents );
|
|
|
|
$calc_size = recurse_dirsize( $upload_dir['path'] );
|
|
$size = filesize( $file['file'] );
|
|
$this->assertSame( $size, $calc_size );
|
|
|
|
// `dirsize_cache` should now be filled after upload and recurse_dirsize() call.
|
|
$cache_path = untrailingslashit( $upload_dir['path'] );
|
|
$this->assertSame( true, is_array( get_transient( 'dirsize_cache' ) ) );
|
|
$this->assertSame( $size, get_transient( 'dirsize_cache' )[ $cache_path ] );
|
|
|
|
// Cleanup.
|
|
$this->remove_added_uploads();
|
|
restore_current_blog();
|
|
}
|
|
|
|
/**
|
|
* Test whether the filter to calculate space for an existing directory works as expected.
|
|
*
|
|
* @ticket 19879
|
|
*/
|
|
function test_pre_recurse_dirsize_filter() {
|
|
add_filter( 'pre_recurse_dirsize', array( $this, '_filter_pre_recurse_dirsize' ) );
|
|
|
|
$upload_dir = wp_upload_dir();
|
|
$this->assertSame( 1042, recurse_dirsize( $upload_dir['path'] ) );
|
|
|
|
remove_filter( 'pre_recurse_dirsize', array( $this, '_filter_pre_recurse_dirsize' ) );
|
|
}
|
|
|
|
function _filter_pre_recurse_dirsize() {
|
|
return 1042;
|
|
}
|
|
|
|
function _get_mock_dirsize_cache_for_site( $site_id ) {
|
|
$prefix = wp_upload_dir()['basedir'];
|
|
|
|
return array(
|
|
"$prefix/2/2" => 22,
|
|
"$prefix/2/1" => 21,
|
|
"$prefix/2" => 2,
|
|
"$prefix/1/3" => 13,
|
|
"$prefix/1/2" => 12,
|
|
"$prefix/1/1" => 11,
|
|
"$prefix/1" => 1,
|
|
"$prefix/custom_directory" => 42,
|
|
);
|
|
}
|
|
|
|
/*
|
|
* Test that 5.6+ gracefully handles the old 5.5 transient structure.
|
|
*
|
|
* @ticket 51913
|
|
*/
|
|
function test_5_5_transient_structure_compat() {
|
|
$blog_id = self::factory()->blog->create();
|
|
switch_to_blog( $blog_id );
|
|
|
|
/*
|
|
* Our comparison of space relies on an initial value of 0. If a previous test has failed
|
|
* or if the `src` directory already contains a directory with site content, then the initial
|
|
* expectation will be polluted. We create sites until an empty one is available.
|
|
*/
|
|
while ( 0 !== get_space_used() ) {
|
|
restore_current_blog();
|
|
$blog_id = self::factory()->blog->create();
|
|
switch_to_blog( $blog_id );
|
|
}
|
|
|
|
// Clear the dirsize cache.
|
|
delete_transient( 'dirsize_cache' );
|
|
|
|
// Set the dirsize cache to our mock.
|
|
set_transient( 'dirsize_cache', $this->_get_mock_5_5_dirsize_cache( $blog_id ) );
|
|
|
|
$upload_dir = wp_upload_dir();
|
|
|
|
/*
|
|
* The cached size should be ignored, because it's in the old format. The function
|
|
* will try to fetch a live value, but in this case the folder doesn't actually
|
|
* exist on disk, so the function should fail.
|
|
*/
|
|
$this->assertSame( false, recurse_dirsize( $upload_dir['basedir'] . '/2/1' ) );
|
|
|
|
/*
|
|
* Now that it's confirmed that old cached values aren't being returned, create the
|
|
* folder on disk, so that the the rest of the function can be tested.
|
|
*/
|
|
wp_mkdir_p( $upload_dir['basedir'] . '/2/1' );
|
|
$filename = $upload_dir['basedir'] . '/2/1/this-needs-to-exist.txt';
|
|
file_put_contents( $filename, 'this file is 21 bytes' );
|
|
|
|
// Clear the dirsize cache.
|
|
delete_transient( 'dirsize_cache' );
|
|
|
|
// Set the dirsize cache to our mock.
|
|
set_transient( 'dirsize_cache', $this->_get_mock_5_5_dirsize_cache( $blog_id ) );
|
|
|
|
/*
|
|
* Now that the folder exists, the old cached value should be overwritten
|
|
* with the size, using the current format.
|
|
*/
|
|
$this->assertSame( 21, recurse_dirsize( $upload_dir['basedir'] . '/2/1' ) );
|
|
$this->assertSame( 21, get_transient( 'dirsize_cache' )[ $upload_dir['basedir'] . '/2/1' ] );
|
|
|
|
// No cache match on non existing directory should return false.
|
|
$this->assertSame( false, recurse_dirsize( $upload_dir['basedir'] . '/does_not_exist' ) );
|
|
|
|
// Cleanup.
|
|
$this->remove_added_uploads();
|
|
rmdir( $upload_dir['basedir'] . '/2/1' );
|
|
|
|
restore_current_blog();
|
|
}
|
|
|
|
function _get_mock_5_5_dirsize_cache( $site_id ) {
|
|
$prefix = untrailingslashit( wp_upload_dir()['basedir'] );
|
|
|
|
return array(
|
|
"$prefix/2/2" => array( 'size' => 22 ),
|
|
"$prefix/2/1" => array( 'size' => 21 ),
|
|
"$prefix/2" => array( 'size' => 2 ),
|
|
"$prefix/1/3" => array( 'size' => 13 ),
|
|
"$prefix/1/2" => array( 'size' => 12 ),
|
|
"$prefix/1/1" => array( 'size' => 11 ),
|
|
"$prefix/1" => array( 'size' => 1 ),
|
|
"$prefix/custom_directory" => array( 'size' => 42 ),
|
|
);
|
|
}
|
|
}
|
|
|
|
endif;
|