Changeset 7819

Timestamp:

02/07/2014 01:54:29 AM (11 years ago)

Author:

boonebgorges

Message:

Add persistent caching for bp_core_get_root_options()

See #5362

Location:

trunk

Files:

• bp-core/bp-core-cache.php (modified) (1 diff)
• bp-core/bp-core-options.php (modified) (1 diff)
• tests/testcases/core/functions.php (modified) (1 diff)

trunk/bp-core/bp-core-cache.php

@@ -97 +97 @@
 }
 add_action( 'update_option', 'bp_core_clear_directory_pages_cache_settings_edit' );
+
+/**
+ * Clear the root_blog_options cache when any of its options are updated.
+ *
+ * @since BuddyPress (2.0.0)
+ *
+ * @param string $option Option name.
+ */
+function bp_core_clear_root_options_cache( $option ) {
+    $keys = array_keys( bp_get_default_options() );
+    $keys = array_merge( $keys, array(
+        'registration',
+        'avatar_default',
+        'tags_blog_id',
+        'sitewide_tags_blog',
+        'registration',
+        'fileupload_mask',
+    ) );
+
+    if ( in_array( $option, $keys ) ) {
+        wp_cache_delete( 'root_blog_options', 'bp' );
+    }
+}
+add_action( 'update_option', 'bp_core_clear_root_options_cache' );
+add_action( 'update_site_option', 'bp_core_clear_root_options_cache' );
+add_action( 'add_option', 'bp_core_clear_root_options_cache' );
+add_action( 'add_site_option', 'bp_core_clear_root_options_cache' );
 
 /**

trunk/bp-core/bp-core-options.php

@@ -305 +305 @@
 
     // Do some magic to get all the root blog options in 1 swoop
-    $blog_options_keys      = "'" . join( "', '", (array) $root_blog_option_keys ) . "'";
-    $blog_options_table     = bp_is_multiblog_mode() ? $wpdb->options : $wpdb->get_blog_prefix( bp_get_root_blog_id() ) . 'options';
-    $blog_options_query     = "SELECT option_name AS name, option_value AS value FROM {$blog_options_table} WHERE option_name IN ( {$blog_options_keys} )";
-    $root_blog_options_meta = $wpdb->get_results( $blog_options_query );
-
-    // On Multisite installations, some options must always be fetched from sitemeta
-    if ( is_multisite() ) {
-        $network_options = apply_filters( 'bp_core_network_options', array(
-            'tags_blog_id'       => '0',
-            'sitewide_tags_blog' => '',
-            'registration'       => '0',
-            'fileupload_maxk'    => '1500'
-        ) );
-
-        $current_site           = get_current_site();
-        $network_option_keys    = array_keys( $network_options );
-        $sitemeta_options_keys  = "'" . join( "', '", (array) $network_option_keys ) . "'";
-        $sitemeta_options_query = $wpdb->prepare( "SELECT meta_key AS name, meta_value AS value FROM {$wpdb->sitemeta} WHERE meta_key IN ( {$sitemeta_options_keys} ) AND site_id = %d", $current_site->id );
-        $network_options_meta   = $wpdb->get_results( $sitemeta_options_query );
-
-        // Sitemeta comes second in the merge, so that network 'registration' value wins
-        $root_blog_options_meta = array_merge( $root_blog_options_meta, $network_options_meta );
-    }
-
-    // Missing some options, so do some one-time fixing
-    if ( empty( $root_blog_options_meta ) || ( count( $root_blog_options_meta ) < count( $root_blog_option_keys ) ) ) {
-
-        // Get a list of the keys that are already populated
-        $existing_options = array();
-        foreach( $root_blog_options_meta as $already_option ) {
-            $existing_options[$already_option->name] = $already_option->value;
+    // Check cache first - We cache here instead of using the standard WP
+    // settings cache because the current blog may not be the root blog,
+    // and it's not practical to access the cache across blogs
+    $root_blog_options_meta = wp_cache_get( 'root_blog_options', 'bp' );
+
+    if ( false === $root_blog_options_meta ) {
+        $blog_options_keys      = "'" . join( "', '", (array) $root_blog_option_keys ) . "'";
+        $blog_options_table     = bp_is_multiblog_mode() ? $wpdb->options : $wpdb->get_blog_prefix( bp_get_root_blog_id() ) . 'options';
+        $blog_options_query     = "SELECT option_name AS name, option_value AS value FROM {$blog_options_table} WHERE option_name IN ( {$blog_options_keys} )";
+        $root_blog_options_meta = $wpdb->get_results( $blog_options_query );
+
+        // On Multisite installations, some options must always be fetched from sitemeta
+        if ( is_multisite() ) {
+            $network_options = apply_filters( 'bp_core_network_options', array(
+                'tags_blog_id'       => '0',
+                'sitewide_tags_blog' => '',
+                'registration'       => '0',
+                'fileupload_maxk'    => '1500'
+            ) );
+
+            $current_site           = get_current_site();
+            $network_option_keys    = array_keys( $network_options );
+            $sitemeta_options_keys  = "'" . join( "', '", (array) $network_option_keys ) . "'";
+            $sitemeta_options_query = $wpdb->prepare( "SELECT meta_key AS name, meta_value AS value FROM {$wpdb->sitemeta} WHERE meta_key IN ( {$sitemeta_options_keys} ) AND site_id = %d", $current_site->id );
+            $network_options_meta   = $wpdb->get_results( $sitemeta_options_query );
+
+            // Sitemeta comes second in the merge, so that network 'registration' value wins
+            $root_blog_options_meta = array_merge( $root_blog_options_meta, $network_options_meta );
         }
 
-        // Unset the query - We'll be resetting it soon
-        unset( $root_blog_options_meta );
-
-        // Loop through options
-        foreach ( $root_blog_options as $old_meta_key => $old_meta_default ) {
-            // Clear out the value from the last time around
-            unset( $old_meta_value );
-
-            if ( isset( $existing_options[$old_meta_key] ) ) {
-                continue;
+        // Missing some options, so do some one-time fixing
+        if ( empty( $root_blog_options_meta ) || ( count( $root_blog_options_meta ) < count( $root_blog_option_keys ) ) ) {
+
+            // Get a list of the keys that are already populated
+            $existing_options = array();
+            foreach( $root_blog_options_meta as $already_option ) {
+                $existing_options[$already_option->name] = $already_option->value;
             }
 
-            // Get old site option
-            if ( is_multisite() )
-                $old_meta_value = get_site_option( $old_meta_key );
-
-            // No site option so look in root blog
-            if ( empty( $old_meta_value ) )
-                $old_meta_value = bp_get_option( $old_meta_key, $old_meta_default );
-
-            // Update the root blog option
-            bp_update_option( $old_meta_key, $old_meta_value );
-
-            // Update the global array
-            $root_blog_options_meta[$old_meta_key] = $old_meta_value;
+            // Unset the query - We'll be resetting it soon
+            unset( $root_blog_options_meta );
+
+            // Loop through options
+            foreach ( $root_blog_options as $old_meta_key => $old_meta_default ) {
+                // Clear out the value from the last time around
+                unset( $old_meta_value );
+
+                if ( isset( $existing_options[$old_meta_key] ) ) {
+                    continue;
+                }
+
+                // Get old site option
+                if ( is_multisite() )
+                    $old_meta_value = get_site_option( $old_meta_key );
+
+                // No site option so look in root blog
+                if ( empty( $old_meta_value ) )
+                    $old_meta_value = bp_get_option( $old_meta_key, $old_meta_default );
+
+                // Update the root blog option
+                bp_update_option( $old_meta_key, $old_meta_value );
+
+                // Update the global array
+                $root_blog_options_meta[$old_meta_key] = $old_meta_value;
+            }
+
+            $root_blog_options_meta = array_merge( $root_blog_options_meta, $existing_options );
+            unset( $existing_options );
+
+        // We're all matched up
+        } else {
+            // Loop through our results and make them usable
+            foreach ( $root_blog_options_meta as $root_blog_option )
+                $root_blog_options[$root_blog_option->name] = $root_blog_option->value;
+
+            // Copy the options no the return val
+            $root_blog_options_meta = $root_blog_options;
+
+            // Clean up our temporary copy
+            unset( $root_blog_options );
         }
 
-        $root_blog_options_meta = array_merge( $root_blog_options_meta, $existing_options );
-        unset( $existing_options );
-
-    // We're all matched up
-    } else {
-        // Loop through our results and make them usable
-        foreach ( $root_blog_options_meta as $root_blog_option )
-            $root_blog_options[$root_blog_option->name] = $root_blog_option->value;
-
-        // Copy the options no the return val
-        $root_blog_options_meta = $root_blog_options;
-
-        // Clean up our temporary copy
-        unset( $root_blog_options );
+        wp_cache_set( 'root_blog_options', $root_blog_options_meta, 'bp' );
     }
 

trunk/tests/testcases/core/functions.php

@@ -297 +297 @@
     }
 
+    /**
+     * @group bp_core_get_root_options
+     */
+    public function test_bp_core_get_root_options_cache_invalidate() {
+        $keys = array_keys( bp_get_default_options() );
+        $keys[] = 'registration';
+        $keys[] = 'avatar_default';
+
+        foreach ( $keys as $key ) {
+            // prime cache
+            $root_options = bp_core_get_root_options();
+
+            bp_update_option( $key, 'foo' );
+
+            $this->assertFalse( wp_cache_get( 'root_blog_options', 'bp' ), 'Cache not invalidated after updating "' . $key . '"' );
+        }
+
+        if ( is_multisite() ) {
+            $ms_keys = array(
+                'tags_blog_id',
+                'sitewide_tags_blog',
+                'registration',
+                'fileupload_mask',
+            );
+
+            foreach ( $ms_keys as $ms_key ) {
+                $root_options = bp_core_get_root_options();
+
+                update_site_option( $ms_key, 'foooooooo' );
+
+                $this->assertFalse( wp_cache_get( 'root_blog_options', 'bp' ), 'Cache not invalidated after updating "' . $ms_key . '"' );
+            }
+        }
+    }
 }