<!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][12754] trunk: Members: stop mirroring user `last_activity` data to user metadata</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 { white-space: pre-line; 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" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="http://buddypress.trac.wordpress.org/changeset/12754">12754</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"http://buddypress.trac.wordpress.org/changeset/12754","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>imath</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2020-10-15 18:33:17 +0000 (Thu, 15 Oct 2020)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Members: stop mirroring user `last_activity` data to user metadata
The primary storage location for user `last_activity` is the activity table. For backward compatibility reasons, we used to mirror that data into user metadata.
Backward compatibility user `last_activity` metadata mirroring is now only done if the legacy user query is enabled. This can be achieved by forcing the `bp_use_legacy_user_query` filter to return `true`.
Props boonebgorges, r-a-y
Fixes <a href="http://buddypress.trac.wordpress.org/ticket/7882">#7882</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpcoreclassesclassbpcoreuserphp">trunk/src/bp-core/classes/class-bp-core-user.php</a></li>
<li><a href="#trunksrcbpmembersbpmembersfunctionsphp">trunk/src/bp-members/bp-members-functions.php</a></li>
<li><a href="#trunktestsphpunittestcasescoreclassbpcoreuserphp">trunk/tests/phpunit/testcases/core/class-bp-core-user.php</a></li>
<li><a href="#trunktestsphpunittestcasesmembersfunctionsphp">trunk/tests/phpunit/testcases/members/functions.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpcoreclassesclassbpcoreuserphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-core/classes/class-bp-core-user.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-core/classes/class-bp-core-user.php 2020-10-15 16:33:31 UTC (rev 12753)
+++ trunk/src/bp-core/classes/class-bp-core-user.php 2020-10-15 18:33:17 UTC (rev 12754)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -760,11 +760,12 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Fetch the user's last_activity.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( 'active' != $type ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $user_activity = $wpdb->get_results( $wpdb->prepare( "SELECT user_id as id, meta_value as last_activity FROM {$wpdb->usermeta} WHERE meta_key = %s AND user_id IN ( {$user_ids} )", bp_get_user_meta_key( 'last_activity' ) ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $user_activity = self::get_last_activity( $user_ids );
</ins><span class="cx" style="display: block; padding: 0 10px"> for ( $i = 0, $count = count( $paged_users ); $i < $count; ++$i ) {
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( (array) $user_activity as $activity ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( $activity->id == $paged_users[$i]->id )
- $paged_users[$i]->last_activity = $activity->last_activity;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! empty( $activity['user_id'] ) && (int) $activity['user_id'] === (int) $paged_users[$i]->id ) {
+ $paged_users[$i]->last_activity = $activity['date_recorded'];
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunksrcbpmembersbpmembersfunctionsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-members/bp-members-functions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-members/bp-members-functions.php 2020-10-15 16:33:31 UTC (rev 12753)
+++ trunk/src/bp-members/bp-members-functions.php 2020-10-15 18:33:17 UTC (rev 12754)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -126,8 +126,22 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'count_total' => 'count_query' // What kind of total user count to do, if any. 'count_query', 'sql_calc_found_rows', or false.
</span><span class="cx" style="display: block; padding: 0 10px"> ), 'core_get_users' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // For legacy users. Use of BP_Core_User::get_users() is deprecated.
- if ( apply_filters( 'bp_use_legacy_user_query', false, __FUNCTION__, $r ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * For legacy users. Use of BP_Core_User::get_users() is deprecated.
+ *
+ * Forcing this filter to true will use the legacy user query. As of
+ * BuddyPress 7.0.0, mirroring of the 'last_activity' value to usermeta
+ * is also disabled if true. See bp_update_user_last_activity().
+ *
+ * @since 2.0.0
+ *
+ * @param bool $retval Defaults to false.
+ * @param string $function Current function name.
+ * @param array $r User query arguments.
+ */
+ $use_legacy_query = apply_filters( 'bp_use_legacy_user_query', false, __FUNCTION__, $r );
+
+ if ( $use_legacy_query ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $retval = BP_Core_User::get_users(
</span><span class="cx" style="display: block; padding: 0 10px"> $r['type'],
</span><span class="cx" style="display: block; padding: 0 10px"> $r['per_page'],
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1048,6 +1062,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Update a user's last activity.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 1.9.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 7.0.0 Backward compatibility usermeta mirroring is only allowed if the
+ * legacy user query is enabled.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $user_id ID of the user being updated.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $time Time of last activity, in 'Y-m-d H:i:s' format.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1070,15 +1086,24 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $time = bp_core_current_time();
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // As of BuddyPress 2.0, last_activity is no longer stored in usermeta.
- // However, we mirror it there for backward compatibility. Do not use!
- // Remove our warning and re-add.
- remove_filter( 'update_user_metadata', '_bp_update_user_meta_last_activity_warning', 10 );
- remove_filter( 'get_user_metadata', '_bp_get_user_meta_last_activity_warning', 10 );
- bp_update_user_meta( $user_id, 'last_activity', $time );
- add_filter( 'update_user_metadata', '_bp_update_user_meta_last_activity_warning', 10, 4 );
- add_filter( 'get_user_metadata', '_bp_get_user_meta_last_activity_warning', 10, 4 );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /** This filter is documented in bp_core_get_users() */
+ $use_legacy_query = apply_filters( 'bp_use_legacy_user_query', false, __FUNCTION__, [ 'user_id' => $user_id ] );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /*
+ * As of BuddyPress 2.0, last_activity is no longer stored in usermeta.
+ * However, we mirror it there for backward compatibility. Do not use!
+ *
+ * As of BuddyPress 7.0, mirroring is only allowed if the legacy user
+ * query is enabled.
+ */
+ if ( $use_legacy_query ) {
+ remove_filter( 'update_user_metadata', '_bp_update_user_meta_last_activity_warning', 10 );
+ remove_filter( 'get_user_metadata', '_bp_get_user_meta_last_activity_warning', 10 );
+ bp_update_user_meta( $user_id, 'last_activity', $time );
+ add_filter( 'update_user_metadata', '_bp_update_user_meta_last_activity_warning', 10, 4 );
+ add_filter( 'get_user_metadata', '_bp_get_user_meta_last_activity_warning', 10, 4 );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> return BP_Core_User::update_last_activity( $user_id, $time );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre></div>
<a id="trunktestsphpunittestcasescoreclassbpcoreuserphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/testcases/core/class-bp-core-user.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/testcases/core/class-bp-core-user.php 2020-10-15 16:33:31 UTC (rev 12753)
+++ trunk/tests/phpunit/testcases/core/class-bp-core-user.php 2020-10-15 18:33:17 UTC (rev 12754)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -9,6 +9,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @expectedDeprecated BP_Core_User::get_users
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function test_get_users_with_exclude_querystring() {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ add_filter( 'bp_use_legacy_user_query', '__return_true' );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $u1 = self::factory()->user->create();
</span><span class="cx" style="display: block; padding: 0 10px"> $u2 = self::factory()->user->create();
</span><span class="cx" style="display: block; padding: 0 10px"> $u3 = self::factory()->user->create();
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -18,6 +20,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $users = BP_Core_User::get_users( 'active', 0, 1, 0, false, false, true, $exclude_qs );
</span><span class="cx" style="display: block; padding: 0 10px"> $user_ids = wp_parse_id_list( wp_list_pluck( $users['users'], 'id' ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ remove_filter( 'bp_use_legacy_user_query', '__return_true' );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( array( $u2 ), $user_ids );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -25,6 +29,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @expectedDeprecated BP_Core_User::get_users
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function test_get_users_with_exclude_array() {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ add_filter( 'bp_use_legacy_user_query', '__return_true' );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $u1 = self::factory()->user->create();
</span><span class="cx" style="display: block; padding: 0 10px"> $u2 = self::factory()->user->create();
</span><span class="cx" style="display: block; padding: 0 10px"> $u3 = self::factory()->user->create();
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -38,6 +44,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $users = BP_Core_User::get_users( 'active', 0, 1, 0, false, false, true, $exclude_array );
</span><span class="cx" style="display: block; padding: 0 10px"> $user_ids = wp_parse_id_list( wp_list_pluck( $users['users'], 'id' ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ remove_filter( 'bp_use_legacy_user_query', '__return_true' );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( array( $u2 ), $user_ids );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -45,6 +53,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @expectedDeprecated BP_Core_User::get_users
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function test_get_users_with_include_querystring() {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ add_filter( 'bp_use_legacy_user_query', '__return_true' );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $u1 = self::factory()->user->create( array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'last_activity' => gmdate( 'Y-m-d H:i:s' ),
</span><span class="cx" style="display: block; padding: 0 10px"> ) );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -60,6 +70,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $users = BP_Core_User::get_users( 'active', 0, 1, 0, $include_qs );
</span><span class="cx" style="display: block; padding: 0 10px"> $user_ids = wp_parse_id_list( wp_list_pluck( $users['users'], 'id' ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ remove_filter( 'bp_use_legacy_user_query', '__return_true' );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( array( $u1, $u3 ), $user_ids );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -67,6 +79,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @expectedDeprecated BP_Core_User::get_users
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function test_get_users_with_include_array() {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ add_filter( 'bp_use_legacy_user_query', '__return_true' );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $u1 = self::factory()->user->create( array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'last_activity' => gmdate( 'Y-m-d H:i:s' ),
</span><span class="cx" style="display: block; padding: 0 10px"> ) );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -90,6 +104,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // typecast...ugh
</span><span class="cx" style="display: block; padding: 0 10px"> $user_ids = array_map( 'intval', $user_ids );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ remove_filter( 'bp_use_legacy_user_query', '__return_true' );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( array( $u1, $u3 ), $user_ids );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre></div>
<a id="trunktestsphpunittestcasesmembersfunctionsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/testcases/members/functions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/testcases/members/functions.php 2020-10-15 16:33:31 UTC (rev 12753)
+++ trunk/tests/phpunit/testcases/members/functions.php 2020-10-15 18:33:17 UTC (rev 12754)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -386,7 +386,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Setup parameters to assert to be the same
</span><span class="cx" style="display: block; padding: 0 10px"> $expected = $time;
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $found = bp_get_user_meta( $user, 'last_activity', true );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $found = bp_get_user_last_activity( $user );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( $expected, $found );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>