From 363445adcbdeaef05ad9eecff7dd2933efc5e935 Mon Sep 17 00:00:00 2001 From: Felix Arntz Date: Mon, 16 Oct 2017 22:28:52 +0000 Subject: [PATCH] Multisite: Revert [41719]. While `get_site_by()` makes sense as a more explicit and less complex replacement for `get_blog_details()`, it is not ready yet in terms of caching, where it currently falls short of the older function under specific circumstances. See #40180, #40228. git-svn-id: https://develop.svn.wordpress.org/trunk@41883 602fd350-edb4-49c9-b593-d223f7449a82 --- src/wp-includes/class-wp-site.php | 9 +- src/wp-includes/ms-blogs.php | 151 ++++++++++++++---- tests/phpunit/tests/multisite/site.php | 42 ++--- tests/phpunit/tests/multisite/siteDetails.php | 38 +++++ 4 files changed, 183 insertions(+), 57 deletions(-) diff --git a/src/wp-includes/class-wp-site.php b/src/wp-includes/class-wp-site.php index 5bfc6430f2..f438264370 100644 --- a/src/wp-includes/class-wp-site.php +++ b/src/wp-includes/class-wp-site.php @@ -330,14 +330,7 @@ final class WP_Site { wp_cache_set( $this->blog_id, $details, 'site-details' ); } - /** - * Filters a blog's details. - * - * @since MU (3.0.0) - * @deprecated 4.7.0 Use site_details - * - * @param object $details The blog details. - */ + /** This filter is documented in wp-includes/ms-blogs.php */ $details = apply_filters_deprecated( 'blog_details', array( $details ), '4.7.0', 'site_details' ); /** diff --git a/src/wp-includes/ms-blogs.php b/src/wp-includes/ms-blogs.php index 7a125c34f8..cdb9691b90 100644 --- a/src/wp-includes/ms-blogs.php +++ b/src/wp-includes/ms-blogs.php @@ -93,7 +93,8 @@ function get_id_from_blogname( $slug ) { * Retrieve the details for a blog from the blogs table and blog options. * * @since MU (3.0.0) - * @since 4.9.0 Use get_site_by() internally. + * + * @global wpdb $wpdb WordPress database abstraction object. * * @param int|string|array $fields Optional. A blog ID, a blog slug, or an array of fields to query against. * If not specified the current blog ID is used. @@ -102,46 +103,138 @@ function get_id_from_blogname( $slug ) { * @return WP_Site|false Blog details on success. False on failure. */ function get_blog_details( $fields = null, $get_all = true ) { - if ( is_array( $fields ) ) { - if ( isset( $fields['blog_id'] ) ) { - $field = 'id'; - $value = (int) $fields['blog_id']; - } elseif ( isset( $fields['domain'] ) && isset( $fields['path'] ) ) { - $field = 'url'; - $value = $fields['domain'] . '/' . ltrim( $fields['path'], '/' ); - } elseif ( isset( $fields['domain'] ) && is_subdomain_install() ) { - $field = 'domain'; - $value = $fields['domain']; + global $wpdb; + + if ( is_array($fields ) ) { + if ( isset($fields['blog_id']) ) { + $blog_id = $fields['blog_id']; + } elseif ( isset($fields['domain']) && isset($fields['path']) ) { + $key = md5( $fields['domain'] . $fields['path'] ); + $blog = wp_cache_get($key, 'blog-lookup'); + if ( false !== $blog ) + return $blog; + if ( substr( $fields['domain'], 0, 4 ) == 'www.' ) { + $nowww = substr( $fields['domain'], 4 ); + $blog = $wpdb->get_row( $wpdb->prepare( "SELECT * FROM $wpdb->blogs WHERE domain IN (%s,%s) AND path = %s ORDER BY CHAR_LENGTH(domain) DESC", $nowww, $fields['domain'], $fields['path'] ) ); + } else { + $blog = $wpdb->get_row( $wpdb->prepare( "SELECT * FROM $wpdb->blogs WHERE domain = %s AND path = %s", $fields['domain'], $fields['path'] ) ); + } + if ( $blog ) { + wp_cache_set($blog->blog_id . 'short', $blog, 'blog-details'); + $blog_id = $blog->blog_id; + } else { + return false; + } + } elseif ( isset($fields['domain']) && is_subdomain_install() ) { + $key = md5( $fields['domain'] ); + $blog = wp_cache_get($key, 'blog-lookup'); + if ( false !== $blog ) + return $blog; + if ( substr( $fields['domain'], 0, 4 ) == 'www.' ) { + $nowww = substr( $fields['domain'], 4 ); + $blog = $wpdb->get_row( $wpdb->prepare( "SELECT * FROM $wpdb->blogs WHERE domain IN (%s,%s) ORDER BY CHAR_LENGTH(domain) DESC", $nowww, $fields['domain'] ) ); + } else { + $blog = $wpdb->get_row( $wpdb->prepare( "SELECT * FROM $wpdb->blogs WHERE domain = %s", $fields['domain'] ) ); + } + if ( $blog ) { + wp_cache_set($blog->blog_id . 'short', $blog, 'blog-details'); + $blog_id = $blog->blog_id; + } else { + return false; + } } else { return false; } } else { - if ( ! $fields ) { - $field = 'id'; - $value = get_current_blog_id(); - } elseif ( ! is_numeric( $fields ) ) { - $field = 'slug'; - $value = $fields; + if ( ! $fields ) + $blog_id = get_current_blog_id(); + elseif ( ! is_numeric( $fields ) ) + $blog_id = get_id_from_blogname( $fields ); + else + $blog_id = $fields; + } + + $blog_id = (int) $blog_id; + + $all = $get_all == true ? '' : 'short'; + $details = wp_cache_get( $blog_id . $all, 'blog-details' ); + + if ( $details ) { + if ( ! is_object( $details ) ) { + if ( $details == -1 ) { + return false; + } else { + // Clear old pre-serialized objects. Cache clients do better with that. + wp_cache_delete( $blog_id . $all, 'blog-details' ); + unset($details); + } } else { - $field = 'id'; - $value = (int) $fields; + return $details; } } - $site = get_site_by( $field, $value ); - - if ( ! $site ) { - return false; - } - + // Try the other cache. if ( $get_all ) { - // Prepopulate magic properties for backward compatibility. - foreach ( array( 'blogname', 'siteurl', 'post_count', 'home' ) as $detail ) { - $site->$detail = $site->$detail; + $details = wp_cache_get( $blog_id . 'short', 'blog-details' ); + } else { + $details = wp_cache_get( $blog_id, 'blog-details' ); + // If short was requested and full cache is set, we can return. + if ( $details ) { + if ( ! is_object( $details ) ) { + if ( $details == -1 ) { + return false; + } else { + // Clear old pre-serialized objects. Cache clients do better with that. + wp_cache_delete( $blog_id, 'blog-details' ); + unset($details); + } + } else { + return $details; + } } } - return $site; + if ( empty($details) ) { + $details = WP_Site::get_instance( $blog_id ); + if ( ! $details ) { + // Set the full cache. + wp_cache_set( $blog_id, -1, 'blog-details' ); + return false; + } + } + + if ( ! $details instanceof WP_Site ) { + $details = new WP_Site( $details ); + } + + if ( ! $get_all ) { + wp_cache_set( $blog_id . $all, $details, 'blog-details' ); + return $details; + } + + switch_to_blog( $blog_id ); + $details->blogname = get_option( 'blogname' ); + $details->siteurl = get_option( 'siteurl' ); + $details->post_count = get_option( 'post_count' ); + $details->home = get_option( 'home' ); + restore_current_blog(); + + /** + * Filters a blog's details. + * + * @since MU (3.0.0) + * @deprecated 4.7.0 Use site_details + * + * @param object $details The blog details. + */ + $details = apply_filters_deprecated( 'blog_details', array( $details ), '4.7.0', 'site_details' ); + + wp_cache_set( $blog_id . $all, $details, 'blog-details' ); + + $key = md5( $details->domain . $details->path ); + wp_cache_set( $key, $details, 'blog-lookup' ); + + return $details; } /** diff --git a/tests/phpunit/tests/multisite/site.php b/tests/phpunit/tests/multisite/site.php index 0804778c55..d0b460b752 100644 --- a/tests/phpunit/tests/multisite/site.php +++ b/tests/phpunit/tests/multisite/site.php @@ -118,21 +118,22 @@ class Tests_Multisite_Site extends WP_UnitTestCase { // $get_all = false, only retrieve details from the blogs table $details = get_blog_details( $blog_id, false ); - $cached_details = wp_cache_get( $blog_id, 'sites' ); - $this->assertNotFalse( $cached_details ); - $this->assertEqualSets( get_object_vars( $details ), get_object_vars( $cached_details ) ); + // Combine domain and path for a site specific cache key. + $key = md5( $details->domain . $details->path ); + + $this->assertEquals( $details, wp_cache_get( $blog_id . 'short', 'blog-details' ) ); // get_blogaddress_by_name() $this->assertEquals( 'http://' . $details->domain . $details->path, get_blogaddress_by_name( trim( $details->path, '/' ) ) ); - // This is empty until get_blog_details() is called with $get_all = true - $this->assertEquals( false, wp_cache_get( $blog_id, 'site-details' ) ); + // These are empty until get_blog_details() is called with $get_all = true + $this->assertEquals( false, wp_cache_get( $blog_id, 'blog-details' ) ); + $this->assertEquals( false, wp_cache_get( $key, 'blog-lookup' ) ); // $get_all = true, populate the full blog-details cache and the blog slug lookup cache $details = get_blog_details( $blog_id, true ); - $cached_details = wp_cache_get( $blog_id, 'site-details' ); - $this->assertNotFalse( $cached_details ); - $this->assertEqualSets( get_object_vars( $details ), get_object_vars( $cached_details ) ); + $this->assertEquals( $details, wp_cache_get( $blog_id, 'blog-details' ) ); + $this->assertEquals( $details, wp_cache_get( $key, 'blog-lookup' ) ); // Check existence of each database table for the created site. foreach ( $wpdb->tables( 'blog', false ) as $table ) { @@ -195,8 +196,9 @@ class Tests_Multisite_Site extends WP_UnitTestCase { // Delete the site without forcing a table drop. wpmu_delete_blog( $blog_id, false ); - $this->assertEquals( false, wp_cache_get( $blog_id, 'sites' ) ); - $this->assertEquals( false, wp_cache_get( $blog_id, 'site-details' ) ); + $this->assertEquals( false, wp_cache_get( $blog_id, 'blog-details' ) ); + $this->assertEquals( false, wp_cache_get( $blog_id . 'short', 'blog-details' ) ); + $this->assertEquals( false, wp_cache_get( $key, 'blog-lookup' ) ); $this->assertEquals( false, wp_cache_get( $key, 'blog-id-cache' ) ); } @@ -232,8 +234,9 @@ class Tests_Multisite_Site extends WP_UnitTestCase { // Delete the site and force a table drop. wpmu_delete_blog( $blog_id, true ); - $this->assertEquals( false, wp_cache_get( $blog_id, 'sites' ) ); - $this->assertEquals( false, wp_cache_get( $blog_id, 'site-details' ) ); + $this->assertEquals( false, wp_cache_get( $blog_id, 'blog-details' ) ); + $this->assertEquals( false, wp_cache_get( $blog_id . 'short', 'blog-details' ) ); + $this->assertEquals( false, wp_cache_get( $key, 'blog-lookup' ) ); $this->assertEquals( false, wp_cache_get( $key, 'blog-id-cache' ) ); } @@ -269,8 +272,9 @@ class Tests_Multisite_Site extends WP_UnitTestCase { // Delete the site and force a table drop. wpmu_delete_blog( $blog_id, true ); - $this->assertEquals( false, wp_cache_get( $blog_id, 'sites' ) ); - $this->assertEquals( false, wp_cache_get( $blog_id, 'site-details' ) ); + $this->assertEquals( false, wp_cache_get( $blog_id, 'blog-details' ) ); + $this->assertEquals( false, wp_cache_get( $blog_id . 'short', 'blog-details' ) ); + $this->assertEquals( false, wp_cache_get( $key, 'blog-lookup' ) ); $this->assertEquals( false, wp_cache_get( $key, 'blog-id-cache' ) ); } @@ -386,21 +390,19 @@ class Tests_Multisite_Site extends WP_UnitTestCase { // Prime the cache for an invalid site. get_blog_details( $blog_id ); - // When the cache is primed with an invalid site, the value is not set. - $this->assertFalse( wp_cache_get( $blog_id, 'site-details' ) ); + // When the cache is primed with an invalid site, the value is set to -1. + $this->assertEquals( -1, wp_cache_get( $blog_id, 'blog-details' ) ); // Create a site in the invalid site's place. self::factory()->blog->create(); // When a new site is created, its cache is cleared through refresh_blog_details. - $this->assertFalse( wp_cache_get( $blog_id, 'site-details' ) ); + $this->assertFalse( wp_cache_get( $blog_id, 'blog-details' ) ); $blog = get_blog_details( $blog_id ); // When the cache is refreshed, it should now equal the site data. - $cached_blog = wp_cache_get( $blog_id, 'site-details' ); - $this->assertNotFalse( $cached_blog ); - $this->assertEqualSets( get_object_vars( $blog ), get_object_vars( $cached_blog ) ); + $this->assertEquals( $blog, wp_cache_get( $blog_id, 'blog-details' ) ); } /** diff --git a/tests/phpunit/tests/multisite/siteDetails.php b/tests/phpunit/tests/multisite/siteDetails.php index 5a64fb9df1..bce6aaead4 100644 --- a/tests/phpunit/tests/multisite/siteDetails.php +++ b/tests/phpunit/tests/multisite/siteDetails.php @@ -27,6 +27,25 @@ class Tests_Multisite_Site_Details extends WP_UnitTestCase { $this->assertFalse( $cached_result ); } + /** + * @dataProvider data_whitelisted_options + * + * @ticket 40063 + */ + public function test_update_whitelisted_option_deletes_blog_details_cache( $whitelisted_option, $temporary_value ) { + $blog_details = get_blog_details(); + + $original_value = $blog_details->$whitelisted_option; + update_option( $whitelisted_option, $temporary_value ); + + $cached_result = wp_cache_get( $blog_details->id, 'blog-details' ); + + /* Reset to original value. */ + update_option( $whitelisted_option, $original_value ); + + $this->assertFalse( $cached_result ); + } + /** * @dataProvider data_whitelisted_options * @@ -46,6 +65,25 @@ class Tests_Multisite_Site_Details extends WP_UnitTestCase { $this->assertNotFalse( $cached_result ); } + /** + * @dataProvider data_whitelisted_options + * + * @ticket 40063 + */ + public function test_update_whitelisted_option_does_not_delete_short_blog_details_cache( $whitelisted_option, $temporary_value ) { + $blog_details = get_blog_details( null, false ); + + $original_value = get_option( $whitelisted_option ); + update_option( $whitelisted_option, $temporary_value ); + + $cached_result = wp_cache_get( $blog_details->id . 'short', 'blog-details' ); + + /* Reset to original value. */ + update_option( $whitelisted_option, $original_value ); + + $this->assertNotFalse( $cached_result ); + } + /** * @dataProvider data_whitelisted_options *