<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[BuddyPress][7819] trunk: Add persistent caching for bp_core_get_root_options()</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta">
<dt>Revision</dt> <dd><a href="http://buddypress.trac.wordpress.org/changeset/7819">7819</a></dd>
<dt>Author</dt> <dd>boonebgorges</dd>
<dt>Date</dt> <dd>2014-02-07 01:54:29 +0000 (Fri, 07 Feb 2014)</dd>
</dl>
<h3>Log Message</h3>
<pre>Add persistent caching for bp_core_get_root_options()
See <a href="http://buddypress.trac.wordpress.org/ticket/5362">#5362</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkbpcorebpcorecachephp">trunk/bp-core/bp-core-cache.php</a></li>
<li><a href="#trunkbpcorebpcoreoptionsphp">trunk/bp-core/bp-core-options.php</a></li>
<li><a href="#trunkteststestcasescorefunctionsphp">trunk/tests/testcases/core/functions.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkbpcorebpcorecachephp"></a>
<div class="modfile"><h4>Modified: trunk/bp-core/bp-core-cache.php (7818 => 7819)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/bp-core/bp-core-cache.php 2014-02-07 01:03:38 UTC (rev 7818)
+++ trunk/bp-core/bp-core-cache.php 2014-02-07 01:54:29 UTC (rev 7819)
</span><span class="lines">@@ -98,6 +98,33 @@
</span><span class="cx"> add_action( 'update_option', 'bp_core_clear_directory_pages_cache_settings_edit' );
</span><span class="cx">
</span><span class="cx"> /**
</span><ins>+ * 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' );
+
+/**
</ins><span class="cx"> * Determine which items from a list do not have cached values.
</span><span class="cx"> *
</span><span class="cx"> * @since BuddyPress (2.0.0)
</span></span></pre></div>
<a id="trunkbpcorebpcoreoptionsphp"></a>
<div class="modfile"><h4>Modified: trunk/bp-core/bp-core-options.php (7818 => 7819)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/bp-core/bp-core-options.php 2014-02-07 01:03:38 UTC (rev 7818)
+++ trunk/bp-core/bp-core-options.php 2014-02-07 01:54:29 UTC (rev 7819)
</span><span class="lines">@@ -304,80 +304,89 @@
</span><span class="cx"> $root_blog_option_keys = array_keys( $root_blog_options );
</span><span class="cx">
</span><span class="cx"> // Do some magic to get all the root blog options in 1 swoop
</span><del>- $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 );
</del><ins>+ // 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' );
</ins><span class="cx">
</span><del>- // 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'
- ) );
</del><ins>+ 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 );
</ins><span class="cx">
</span><del>- $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 );
</del><ins>+ // 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'
+ ) );
</ins><span class="cx">
</span><del>- // 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 );
- }
</del><ins>+ $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 );
</ins><span class="cx">
</span><del>- // 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;
</del><ins>+ // 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 );
</ins><span class="cx"> }
</span><span class="cx">
</span><del>- // Unset the query - We'll be resetting it soon
- unset( $root_blog_options_meta );
</del><ins>+ // 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 ) ) ) {
</ins><span class="cx">
</span><del>- // 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;
</del><ins>+ // 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;
</ins><span class="cx"> }
</span><span class="cx">
</span><del>- // Get old site option
- if ( is_multisite() )
- $old_meta_value = get_site_option( $old_meta_key );
</del><ins>+ // Unset the query - We'll be resetting it soon
+ unset( $root_blog_options_meta );
</ins><span class="cx">
</span><del>- // 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 );
</del><ins>+ // 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 );
</ins><span class="cx">
</span><del>- // Update the root blog option
- bp_update_option( $old_meta_key, $old_meta_value );
</del><ins>+ if ( isset( $existing_options[$old_meta_key] ) ) {
+ continue;
+ }
</ins><span class="cx">
</span><del>- // Update the global array
- $root_blog_options_meta[$old_meta_key] = $old_meta_value;
- }
</del><ins>+ // Get old site option
+ if ( is_multisite() )
+ $old_meta_value = get_site_option( $old_meta_key );
</ins><span class="cx">
</span><del>- $root_blog_options_meta = array_merge( $root_blog_options_meta, $existing_options );
- unset( $existing_options );
</del><ins>+ // 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 );
</ins><span class="cx">
</span><del>- // 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;
</del><ins>+ // Update the root blog option
+ bp_update_option( $old_meta_key, $old_meta_value );
</ins><span class="cx">
</span><del>- // Copy the options no the return val
- $root_blog_options_meta = $root_blog_options;
</del><ins>+ // Update the global array
+ $root_blog_options_meta[$old_meta_key] = $old_meta_value;
+ }
</ins><span class="cx">
</span><del>- // Clean up our temporary copy
- unset( $root_blog_options );
</del><ins>+ $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' );
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> return apply_filters( 'bp_core_get_root_options', $root_blog_options_meta );
</span></span></pre></div>
<a id="trunkteststestcasescorefunctionsphp"></a>
<div class="modfile"><h4>Modified: trunk/tests/testcases/core/functions.php (7818 => 7819)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/tests/testcases/core/functions.php 2014-02-07 01:03:38 UTC (rev 7818)
+++ trunk/tests/testcases/core/functions.php 2014-02-07 01:54:29 UTC (rev 7819)
</span><span class="lines">@@ -296,4 +296,38 @@
</span><span class="cx"> bp_update_option( 'bp-pages', $v );
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+ /**
+ * @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 . '"' );
+ }
+ }
+ }
</ins><span class="cx"> }
</span></span></pre>
</div>
</div>
</body>
</html>