<!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][7786] trunk: Add persistent caching support for xprofile field data</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/7786">7786</a></dd>
<dt>Author</dt> <dd>boonebgorges</dd>
<dt>Date</dt> <dd>2014-02-05 14:15:53 +0000 (Wed, 05 Feb 2014)</dd>
</dl>
<h3>Log Message</h3>
<pre>Add persistent caching support for xprofile field data
See <a href="http://buddypress.trac.wordpress.org/ticket/1332">#1332</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkbpcorebpcorecachephp">trunk/bp-core/bp-core-cache.php</a></li>
<li><a href="#trunkbpxprofilebpxprofilecachephp">trunk/bp-xprofile/bp-xprofile-cache.php</a></li>
<li><a href="#trunkbpxprofilebpxprofileclassesphp">trunk/bp-xprofile/bp-xprofile-classes.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 (7785 => 7786)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/bp-core/bp-core-cache.php 2014-02-04 22:35:17 UTC (rev 7785)
+++ trunk/bp-core/bp-core-cache.php 2014-02-05 14:15:53 UTC (rev 7786)
</span><span class="lines">@@ -57,6 +57,28 @@
</span><span class="cx"> add_action( 'deleted_user', 'bp_core_clear_member_count_caches' );
</span><span class="cx">
</span><span class="cx"> /**
</span><ins>+ * Determine which items from a list do not have cached values.
+ *
+ * @since BuddyPress (2.0.0)
+ *
+ * @param array $item_ids ID list.
+ * @param string $cache_group The cache group to check against.
+ * @return array
+ */
+function bp_get_non_cached_ids( $item_ids, $cache_group ) {
+ $uncached = array();
+
+ foreach ( $item_ids as $item_id ) {
+ $item_id = (int) $item_id;
+ if ( false === wp_cache_get( $item_id, $cache_group ) ) {
+ $uncached[] = $item_id;
+ }
+ }
+
+ return $uncached;
+}
+
+/**
</ins><span class="cx"> * Update the metadata cache for the specified objects.
</span><span class="cx"> *
</span><span class="cx"> * Based on WordPress's {@link update_meta_cache()}, this function primes the
</span></span></pre></div>
<a id="trunkbpxprofilebpxprofilecachephp"></a>
<div class="modfile"><h4>Modified: trunk/bp-xprofile/bp-xprofile-cache.php (7785 => 7786)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/bp-xprofile/bp-xprofile-cache.php 2014-02-04 22:35:17 UTC (rev 7785)
+++ trunk/bp-xprofile/bp-xprofile-cache.php 2014-02-05 14:15:53 UTC (rev 7786)
</span><span class="lines">@@ -39,5 +39,18 @@
</span><span class="cx"> add_action( 'xprofile_fields_saved_field', 'xprofile_clear_profile_field_object_cache' );
</span><span class="cx"> add_action( 'xprofile_fields_deleted_field', 'xprofile_clear_profile_field_object_cache' );
</span><span class="cx">
</span><ins>+/**
+ * Clear caches when a user's updates a field data object.
+ *
+ * @since BuddyPress (2.0.0)
+ *
+ * @param BP_XProfile_ProfileData
+ */
+function xprofile_clear_profiledata_object_cache( $data_obj ) {
+ wp_cache_delete( $data_obj->field_id, 'bp_xprofile_data_' . $data_obj->user_id );
+}
+add_action( 'xprofile_data_after_save', 'xprofile_clear_profiledata_object_cache' );
+add_action( 'xprofile_data_after_delete', 'xprofile_clear_profiledata_object_cache' );
+
</ins><span class="cx"> // List actions to clear super cached pages on, if super cache is installed
</span><span class="cx"> add_action( 'xprofile_updated_profile', 'bp_core_clear_cache' );
</span></span></pre></div>
<a id="trunkbpxprofilebpxprofileclassesphp"></a>
<div class="modfile"><h4>Modified: trunk/bp-xprofile/bp-xprofile-classes.php (7785 => 7786)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/bp-xprofile/bp-xprofile-classes.php 2014-02-04 22:35:17 UTC (rev 7785)
+++ trunk/bp-xprofile/bp-xprofile-classes.php 2014-02-05 14:15:53 UTC (rev 7786)
</span><span class="lines">@@ -193,7 +193,7 @@
</span><span class="cx"> $field_ids_sql = implode( ',', (array) $field_ids );
</span><span class="cx">
</span><span class="cx"> if ( ! empty( $field_ids ) && ! empty( $user_id ) ) {
</span><del>- $field_data = $wpdb->get_results( $wpdb->prepare( "SELECT id, field_id, value FROM {$bp->profile->table_name_data} WHERE field_id IN ( {$field_ids_sql} ) AND user_id = %d", $user_id ) );
</del><ins>+ $field_data = BP_XProfile_ProfileData::get_data_for_user( $user_id, $field_ids );
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> // Remove data-less fields, if necessary
</span><span class="lines">@@ -1094,18 +1094,25 @@
</span><span class="cx"> public function populate( $field_id, $user_id ) {
</span><span class="cx"> global $wpdb, $bp;
</span><span class="cx">
</span><del>- $sql = $wpdb->prepare( "SELECT * FROM {$bp->profile->table_name_data} WHERE field_id = %d AND user_id = %d", $field_id, $user_id );
</del><ins>+ $cache_group = 'bp_xprofile_data_' . $user_id;
+ $profiledata = wp_cache_get( $field_id, $cache_group );
</ins><span class="cx">
</span><del>- if ( $profiledata = $wpdb->get_row( $sql ) ) {
- $this->id = $profiledata->id;
- $this->user_id = $profiledata->user_id;
- $this->field_id = $profiledata->field_id;
- $this->value = stripslashes( $profiledata->value );
- $this->last_updated = $profiledata->last_updated;
- } else {
- // When no row is found, we'll need to set these properties manually
- $this->field_id = $field_id;
- $this->user_id = $user_id;
</del><ins>+ if ( false === $profiledata ) {
+ $sql = $wpdb->prepare( "SELECT * FROM {$bp->profile->table_name_data} WHERE field_id = %d AND user_id = %d", $field_id, $user_id );
+
+ if ( $profiledata = $wpdb->get_row( $sql ) ) {
+ $this->id = $profiledata->id;
+ $this->user_id = $profiledata->user_id;
+ $this->field_id = $profiledata->field_id;
+ $this->value = stripslashes( $profiledata->value );
+ $this->last_updated = $profiledata->last_updated;
+
+ wp_cache_set( $field_id, $profiledata, $cache_group );
+ } else {
+ // When no row is found, we'll need to set these properties manually
+ $this->field_id = $field_id;
+ $this->user_id = $user_id;
+ }
</ins><span class="cx"> }
</span><span class="cx"> }
</span><span class="cx">
</span><span class="lines">@@ -1197,6 +1204,69 @@
</span><span class="cx"> /** Static Methods ********************************************************/
</span><span class="cx">
</span><span class="cx"> /**
</span><ins>+ * Get a user's profile data for a set of fields.
+ *
+ * @param int $user_id
+ * @param array $field_ids
+ * @return array
+ */
+ public static function get_data_for_user( $user_id, $field_ids ) {
+ global $wpdb;
+
+ $data = array();
+
+ $cache_group = 'bp_xprofile_data_' . $user_id;
+
+ $uncached_field_ids = bp_get_non_cached_ids( $field_ids, $cache_group );
+
+ // Prime the cache
+ if ( ! empty( $uncached_field_ids ) ) {
+ $bp = buddypress();
+ $uncached_field_ids_sql = implode( ',', wp_parse_id_list( $uncached_field_ids ) );
+ $uncached_data = $wpdb->get_results( $wpdb->prepare( "SELECT id, user_id, field_id, value, last_updated FROM {$bp->profile->table_name_data} WHERE field_id IN ({$uncached_field_ids_sql}) AND user_id = %d", $user_id ) );
+
+ // Rekey
+ $queried_data = array();
+ foreach ( $uncached_data as $ud ) {
+ $d = new stdClass;
+ $d->id = $ud->id;
+ $d->user_id = $ud->user_id;
+ $d->field_id = $ud->field_id;
+ $d->value = $ud->value;
+ $d->last_updated = $ud->last_updated;
+
+ $queried_data[ $ud->field_id ] = $d;
+ }
+
+ // Set caches
+ foreach ( $field_ids as $field_id ) {
+
+ // If a value was found, cache it
+ if ( isset( $queried_data[ $field_id ] ) ) {
+ wp_cache_set( $field_id, $queried_data[ $field_id ], $cache_group );
+
+ // If no value was found, cache an empty item
+ // to avoid future cache misses
+ } else {
+ $d = new stdClass;
+ $d->id = '';
+ $d->field_id = $field_id;
+ $d->value = '';
+
+ wp_cache_set( $field_id, $d, $cache_group );
+ }
+ }
+ }
+
+ // Now that all items are cached, fetch them
+ foreach ( $field_ids as $field_id ) {
+ $data[] = wp_cache_get( $field_id, $cache_group );
+ }
+
+ return $data;
+ }
+
+ /**
</ins><span class="cx"> * BP_XProfile_ProfileData::get_all_for_user()
</span><span class="cx"> *
</span><span class="cx"> * Get all of the profile information for a specific user.
</span></span></pre>
</div>
</div>
</body>
</html>