<!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][13154] trunk: Avoid generating many `new_avatar` activities in a short time frame</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/13154">13154</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/13154","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>2021-11-20 14:21:24 +0000 (Sat, 20 Nov 2021)</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'>Avoid generating many `new_avatar` activities in a short time frame
For an hour time frame, if a user publishes many `new_avatar` activities, only the latest one will be kept.
Props oztaser
See <a href="http://buddypress.trac.wordpress.org/ticket/8581">#8581</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpmembersbpmembersactivityphp">trunk/src/bp-members/bp-members-activity.php</a></li>
<li><a href="#trunktestsphpunittestcasesmembersactivityphp">trunk/tests/phpunit/testcases/members/activity.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpmembersbpmembersactivityphp"></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-activity.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-members/bp-members-activity.php 2021-11-19 05:03:56 UTC (rev 13153)
+++ trunk/src/bp-members/bp-members-activity.php 2021-11-20 14:21:24 UTC (rev 13154)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -192,11 +192,46 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> $user_id = apply_filters( 'bp_members_new_avatar_user_id', $user_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">+ // Check to make sure that a user has just one `new_avatar` activity per throttle time.
+ $last_new_avatar_activity = bp_activity_get(
+ array(
+ 'user_id' => $user_id,
+ 'component' => buddypress()->members->id,
+ 'type' => 'new_avatar',
+ 'per_page' => 1,
+ )
+ );
+
+ if ( ! empty( $last_new_avatar_activity['activities'] ) ) {
+ /**
+ * Filters the throttle time, in seconds, used to prevent generating multiple `new_avatar` activity
+ * in a short amount of time.
+ *
+ * @since 10.0.0
+ *
+ * @param int $value Throttle time, in seconds.
+ */
+ $throttle_period = apply_filters( 'bp_members_new_avatar_throttle_time', HOUR_IN_SECONDS );
+ $then = strtotime( $last_new_avatar_activity['activities'][0]->date_recorded );
+ $now = bp_core_current_time( true, 'timestamp' );
+
+ // Delete the old activity.
+ if ( ( $now - $then ) < $throttle_period ) {
+ bp_activity_delete(
+ array(
+ 'id' => $last_new_avatar_activity['activities'][0]->id,
+ )
+ );
+ }
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // Add the activity.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- bp_activity_add( array(
- 'user_id' => $user_id,
- 'component' => buddypress()->members->id,
- 'type' => 'new_avatar'
- ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ bp_activity_add(
+ array(
+ 'user_id' => $user_id,
+ 'component' => buddypress()->members->id,
+ 'type' => 'new_avatar',
+ )
+ );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> add_action( 'bp_members_avatar_uploaded', 'bp_members_new_avatar_activity' );
</span></span></pre></div>
<a id="trunktestsphpunittestcasesmembersactivityphp"></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/activity.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/testcases/members/activity.php 2021-11-19 05:03:56 UTC (rev 13153)
+++ trunk/tests/phpunit/testcases/members/activity.php 2021-11-20 14:21:24 UTC (rev 13154)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -93,4 +93,56 @@
</span><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><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * @group bp_members_new_avatar_activity
+ */
+ public function test_bp_members_new_avatar_activity_throttled() {
+ $u = self::factory()->user->create();
+ $a = self::factory()->activity->create( array(
+ 'component' => 'members',
+ 'type' => 'new_avatar',
+ 'user_id' => $u,
+ ) );
+
+ bp_members_new_avatar_activity( $u );
+
+ $new_avatar_activities = bp_activity_get( array(
+ 'user_id' => $u,
+ 'component' => buddypress()->members->id,
+ 'type' => 'new_avatar',
+ 'count_total' => 'count_query',
+ ) );
+
+ $this->assertEquals( 1, $new_avatar_activities['total'] );
+ $this->assertNotSame( $a, $new_avatar_activities['activities'][0]->id );
+ }
+
+ /**
+ * @group bp_members_new_avatar_activity
+ */
+ public function test_bp_members_new_avatar_activity_outside_of_throttle_time() {
+ $u = self::factory()->user->create();
+
+ $time = strtotime( bp_core_current_time() );
+ $prev_time = date( 'Y-m-d H:i:s', $time - ( 121 * HOUR_IN_SECONDS ) );
+
+ $a = self::factory()->activity->create( array(
+ 'component' => 'members',
+ 'type' => 'new_avatar',
+ 'user_id' => $u,
+ 'recorded_time' => $prev_time,
+ ) );
+
+ bp_members_new_avatar_activity( $u );
+
+ $new_avatar_activities = bp_activity_get( array(
+ 'user_id' => $u,
+ 'component' => buddypress()->members->id,
+ 'type' => 'new_avatar',
+ 'count_total' => 'count_query',
+ ) );
+
+ $this->assertEquals( 2, $new_avatar_activities['total'] );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>