<!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][9326] trunk: Only create a single activity when a friendship is created and make sure to display it on each involved user personal activities.</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" 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/9326">9326</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/9326","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>2015-01-09 08:56:45 +0000 (Fri, 09 Jan 2015)</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'>Only create a single activity when a friendship is created and make sure to display it on each involved user personal activities.
When a friendship is created, a single public activity will be created. Thanks to the new `BP_Activity_Query` class introduced in version 2.2, we are able to fetch this activity on each involved user personal activity stream.
Once BuddyPress will be updated to 2.2, all `hide_sitewide` activities related to a created friendship will be removed as they are not necessary anymore.
Fixes <a href="http://buddypress.trac.wordpress.org/ticket/6040">#6040</a>
props boonebgorges, r-a-y</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpcorebpcoreupdatephp">trunk/src/bp-core/bp-core-update.php</a></li>
<li><a href="#trunksrcbpfriendsbpfriendsactivityphp">trunk/src/bp-friends/bp-friends-activity.php</a></li>
<li><a href="#trunktestsphpunittestcasesfriendsactivityphp">trunk/tests/phpunit/testcases/friends/activity.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpcorebpcoreupdatephp"></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/bp-core-update.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-core/bp-core-update.php 2015-01-09 08:30:52 UTC (rev 9325)
+++ trunk/src/bp-core/bp-core-update.php 2015-01-09 08:56:45 UTC (rev 9326)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -399,6 +399,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * - Add messages meta table
</span><span class="cx" style="display: block; padding: 0 10px"> * - Update the component field of the 'new members' activity type
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * - Clean up hidden friendship activities
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since BuddyPress (2.2.0)
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -409,6 +410,10 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( bp_is_active( 'activity' ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> bp_migrate_new_member_activity_component();
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ if ( bp_is_active( 'friends' ) ) {
+ bp_cleanup_friendship_activities();
+ }
</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 class="lines" style="display: block; padding: 0 10px; color: #888">@@ -449,6 +454,21 @@
</span><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><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Remove all hidden friendship activities
+ *
+ * @since BuddyPress (2.2.0)
+ *
+ * @uses bp_activity_delete() to delete the corresponding friendship activities
+ */
+function bp_cleanup_friendship_activities() {
+ bp_activity_delete( array(
+ 'component' => buddypress()->friends->id,
+ 'type' => 'friendship_created',
+ 'hide_sitewide' => true,
+ ) );
+ }
+
+/**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Redirect user to BP's What's New page on first page load after activation.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since BuddyPress (1.7.0)
</span></span></pre></div>
<a id="trunksrcbpfriendsbpfriendsactivityphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-friends/bp-friends-activity.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-friends/bp-friends-activity.php 2015-01-09 08:30:52 UTC (rev 9325)
+++ trunk/src/bp-friends/bp-friends-activity.php 2015-01-09 08:56:45 UTC (rev 9326)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -271,6 +271,66 @@
</span><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'bp_activity_set_friends_scope_args', 'bp_friends_filter_activity_scope', 10, 2 );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Set up activity arguments for use with the 'just-me' scope.
+ *
+ * For details on the syntax, see {@link BP_Activity_Query}.
+ *
+ * @since BuddyPress (2.2.0)
+ *
+ * @param array $retval Empty array by default
+ * @param array $filter Current activity arguments
+ * @return array
+ */
+function bp_friends_filter_activity_just_me_scope( $retval, $filter ) {
+ // Get the requested action
+ $action = $filter['filter']['action'];
+
+ // Make sure actions are listed in an array
+ if ( ! is_array( $action ) ) {
+ $action = explode( ',', $filter['filter']['action'] );
+ }
+
+ $action = array_flip( array_filter( $action ) );
+
+ /**
+ * If filtering activities for something other than the friendship_created action
+ * return without changing anything
+ */
+ if ( ! empty( $action ) && ! isset( $action['friendship_created'] ) ) {
+ return $retval;
+ }
+
+ /**
+ * Else make sure to get the friendship_created action, the user is involved in
+ * - user initiated the friendship
+ * - user has been requested a friendship
+ */
+ return array(
+ 'relation' => 'OR',
+ array(
+ 'column' => 'user_id',
+ 'value' => $filter['user_id']
+ ),
+ array(
+ 'relation' => 'AND',
+ array(
+ 'column' => 'component',
+ 'value' => 'friends',
+ ),
+ array(
+ 'column' => 'secondary_item_id',
+ 'value' => $filter['user_id'],
+ ),
+ ),
+ 'override' => array(
+ 'display_comments' => 'stream',
+ 'filter' => array( 'user_id' => 0 ),
+ ),
+ );
+}
+add_filter( 'bp_activity_set_just-me_scope_args', 'bp_friends_filter_activity_just_me_scope', 20, 2 );
+
+/**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Add activity stream items when one members accepts another members request
</span><span class="cx" style="display: block; padding: 0 10px"> * for virtual friendship.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -293,14 +353,5 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'item_id' => $friendship_id,
</span><span class="cx" style="display: block; padding: 0 10px"> 'secondary_item_id' => $friend_user_id
</span><span class="cx" style="display: block; padding: 0 10px"> ) );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-
- // Record in activity streams for the friend
- friends_record_activity( array(
- 'user_id' => $friend_user_id,
- 'type' => 'friendship_created',
- 'item_id' => $friendship_id,
- 'secondary_item_id' => $initiator_user_id,
- 'hide_sitewide' => true // We've already got the first entry site wide
- ) );
</del><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> add_action( 'friends_friendship_accepted', 'bp_friends_friendship_accepted_activity', 10, 4 );
</span></span></pre></div>
<a id="trunktestsphpunittestcasesfriendsactivityphp"></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/friends/activity.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/testcases/friends/activity.php 2015-01-09 08:30:52 UTC (rev 9325)
+++ trunk/tests/phpunit/testcases/friends/activity.php 2015-01-09 08:56:45 UTC (rev 9326)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -95,5 +95,94 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertTrue( count( $fd_act['activities'] ) == 0, 'friends_delete_activity() should remove "friendship_created" activities about a deleted friendship' );
</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_friends_friendship_accepted_activity
+ */
+ public function test_bp_friends_friendship_accepted_activity() {
+ $old_user = get_current_user_id();
+
+ $u1 = $this->factory->user->create();
+ $u2 = $this->factory->user->create();
+
+ friends_add_friend( $u2, $u1 );
+ $friendship_id = friends_get_friendship_id( $u2, $u1 );
+
+ // Set current user to u1 to accepte the friendship
+ $this->set_current_user( $u1 );
+ friends_accept_friendship( $friendship_id );
+
+ // Reset the current user
+ $this->set_current_user( $old_user );
+
+ $u1_act = bp_activity_get( array(
+ 'component' => buddypress()->friends->id,
+ 'item_id' => $friendship_id,
+ 'scope' => 'just-me',
+ 'filter' => array( 'action' => array( 'friendship_created' ), 'user_id' => $u1 ),
+ ) );
+
+ $this->assertTrue( count( $u1_act['activities'] ) == 1, 'a public activity should be listed in the friend stream' );
+
+ $u2_act = bp_activity_get( array(
+ 'component' => buddypress()->friends->id,
+ 'item_id' => $friendship_id,
+ 'scope' => 'just-me',
+ 'filter' => array( 'action' => array( 'friendship_created' ), 'user_id' => $u2 ),
+ ) );
+
+ $this->assertTrue( count( $u2_act['activities'] ) == 1, 'a public activity should be listed in the initiator stream' );
+ }
+
+ /**
+ * @group bp_cleanup_friendship_activities
+ */
+ public function test_bp_cleanup_friendship_activities() {
+ $old_user = get_current_user_id();
+
+ $u1 = $this->factory->user->create();
+ $u2 = $this->factory->user->create();
+ $users = array( $u1, $u2 );
+
+ friends_add_friend( $u2, $u1 );
+ $friendship_id = friends_get_friendship_id( $u2, $u1 );
+
+ // Set current user to u1 to accepte the friendship and generate a public activity
+ $this->set_current_user( $u1 );
+ friends_accept_friendship( $friendship_id );
+
+ // Reset the current user
+ $this->set_current_user( $old_user );
+
+ $users[] = $this->factory->user->create();
+ $users[] = $this->factory->user->create();
+
+ foreach( $users as $u ) {
+ bp_activity_add( array(
+ 'user_id' => $u,
+ 'item_id' => $friendship_id,
+ 'type' => 'friendship_created',
+ 'component' => buddypress()->friends->id,
+ 'hide_sitewide' => true,
+ ) );
+ }
+
+ $hidden = bp_activity_get( array(
+ 'component' => buddypress()->friends->id,
+ 'filter' => array( 'action' => array( 'friendship_created' ) ),
+ 'show_hidden' => true,
+ ) );
+
+ bp_cleanup_friendship_activities();
+
+ $check = bp_activity_get( array(
+ 'component' => buddypress()->friends->id,
+ 'item_id' => $friendship_id,
+ 'filter' => array( 'action' => array( 'friendship_created' ) ),
+ 'show_hidden' => true,
+ ) );
+
+ $this->assertTrue( count( $check['activities'] ) == 1 );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre>
</div>
</div>
</body>
</html>