Ticket #6040: 6040.patch

src/bp-friends/bp-friends-activity.php

@@ -134 +134 @@
         $initiator_link = bp_core_get_userlink( $activity->user_id );
         $friend_link    = bp_core_get_userlink( $activity->secondary_item_id );
 
-        $action = sprintf( __( '%1$s and %2$s are now friends', 'buddypress' ), $initiator_link, $friend_link );
+        $action = sprintf( __( '%1$s accepted %2$s to be their friend', 'buddypress' ), $initiator_link, $friend_link );
+
+        // Check the friendship status on the member's page only
+        if ( bp_is_user() && friends_check_friendship( $activity->user_id, $activity->secondary_item_id ) ) {
+                $action = sprintf( __( '%1$s and %2$s are now friends', 'buddypress' ), $initiator_link, $friend_link );
+        }
 
         // Backward compatibility for legacy filter
         // The old filter has the $friendship object passed to it. We want to
@@ -168 +173 @@
         $initiator_link = bp_core_get_userlink( $activity->user_id );
         $friend_link    = bp_core_get_userlink( $activity->secondary_item_id );
 
-        $action = sprintf( __( '%1$s and %2$s are now friends', 'buddypress' ), $initiator_link, $friend_link );
+        $action = sprintf( __( '%1$s requested %2$s to be their friend', 'buddypress' ), $initiator_link, $friend_link );
+
+        // Check the friendship status on the member's page only
+        if ( bp_is_user() && friends_check_friendship( $activity->user_id, $activity->secondary_item_id ) ) {
+                $action = sprintf( __( '%1$s and %2$s are now friends', 'buddypress' ), $initiator_link, $friend_link );
+        }
 
         // Backward compatibility for legacy filter
         // The old filter has the $friendship object passed to it. We want to
@@ -246 +256 @@
         }
 
         // Get links to both members profiles
+        $friend_link    = bp_core_get_userlink( $friend_user_id );
+
+        // Record in activity streams for the friend
+        friends_record_activity( array(
+                'user_id'           => $friend_user_id,
+                'type'              => 'friendship_accepted',
+                'item_id'           => $friendship_id,
+                'secondary_item_id' => $initiator_user_id,
+        ) );
+}
+add_action( 'friends_friendship_accepted', 'bp_friends_friendship_accepted_activity', 10, 4 );
+
+/**
+ * Add activity stream items when one members request another member to be his friend
+ * for virtual friendship.
+ *
+ * @since BuddyPress (2.2.0)
+ *
+ * @param int $friendship_id
+ * @param int $initiator_user_id
+ * @param int $friend_user_id
+ * @param object $friendship Optional
+ */
+function bp_friends_friendship_requested_activity( $friendship_id, $initiator_user_id, $friend_user_id, $friendship = false ) {
+
+        // Bail if Activity component is not active
+        if ( ! bp_is_active( 'activity' ) ) {
+                return;
+        }
+
+        // Get links to both members profiles
         $initiator_link = bp_core_get_userlink( $initiator_user_id );
-        $friend_link    = bp_core_get_userlink( $friend_user_id    );
 
         // Record in activity streams for the initiator
         friends_record_activity( array(
@@ -256 +296 @@
                 'item_id'           => $friendship_id,
                 'secondary_item_id' => $friend_user_id
         ) );
+}
+add_action( 'friends_friendship_requested', 'bp_friends_friendship_requested_activity', 10, 4 );
 
-        // 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
-        ) );
+/**
+ * Check the friendship exists before deleting all activities related to this friendship
+ *
+ * @since BuddyPress (2.2.0)
+ *
+ * @param int $friendship_id
+ * @param object $friendship Optional
+ */
+function bp_friends_friendship_rejected_activity( $friendship_id, $friendship = null ) {
+        if ( empty( $friendship_id ) )  {
+                return;
+        }
+
+        // Remove the activity stream items about the friendship id
+        friends_delete_activity( array( 'item_id' => $friendship_id, 'type' => '', 'user_id' => 0 ) );
 }
-add_action( 'friends_friendship_accepted', 'bp_friends_friendship_accepted_activity', 10, 4 );
+add_action( 'friends_friendship_rejected', 'bp_friends_friendship_rejected_activity', 10, 2 );
+
+/**
+ * Remove the activity for the initiator about the friendship he withdrawn
+ *
+ * @since BuddyPress (2.2.0)
+ *
+ * @param int $friendship_id
+ * @param object $friendship
+ */
+function bp_friends_friendship_withdrawn_activity( $friendship_id, $friendship = null ) {
+        if ( empty( $friendship_id ) || empty( $friendship->initiator_user_id ) )  {
+                return;
+        }
+
+        // Remove the activity stream items about the friendship id
+        friends_delete_activity( array( 'item_id' => $friendship_id, 'type' => 'friendship_created', 'user_id' => $friendship->initiator_user_id ) );
+}
+add_action( 'friends_friendship_withdrawn', 'bp_friends_friendship_withdrawn_activity', 10, 2 );

src/bp-friends/bp-friends-functions.php

@@ -111 +111 @@
          */
         do_action( 'friends_before_friendship_delete', $friendship_id, $initiator_userid, $friend_userid );
 
-        // Remove the activity stream item for the user who canceled the friendship
-        friends_delete_activity( array( 'item_id' => $friendship_id, 'type' => 'friendship_accepted', 'user_id' => bp_displayed_user_id() ) );
+        // Remove the activity stream items about the friendship id
+        friends_delete_activity( array( 'item_id' => $friendship_id, 'type' => '', 'user_id' => 0 ) );
 
         /**
          * Fires before the friendship connection is removed.
@@ -751 +751 @@
                 'friends' => $results,
         ) );
 }
-add_action( 'bp_activity_mentions_prime_results', 'bp_friends_prime_mentions_results' );
- No newline at end of file
+add_action( 'bp_activity_mentions_prime_results', 'bp_friends_prime_mentions_results' );

tests/phpunit/testcases/friends/activity.php

@@ -20 +20 @@
                         'secondary_item_id' => $u2,
                 ) );
 
-                $expected = sprintf( __( '%1$s and %2$s are now friends', 'buddypress' ), bp_core_get_userlink( $u1 ), bp_core_get_userlink( $u2 ) );
+                $expected = sprintf( __( '%1$s accepted %2$s to be their friend', 'buddypress' ), bp_core_get_userlink( $u1 ), bp_core_get_userlink( $u2 ) );
 
                 $a_obj = new BP_Activity_Activity( $a );
 
@@ -42 +42 @@
                         'secondary_item_id' => $u2,
                 ) );
 
+                $expected = sprintf( __( '%1$s requested %2$s to be their friend', 'buddypress' ), bp_core_get_userlink( $u1 ), bp_core_get_userlink( $u2 ) );
+
+                $a_obj = new BP_Activity_Activity( $a );
+
+                $this->assertSame( $expected, $a_obj->action );
+        }
+
+        /**
+         * @group activity_action
+         * @group bp_friends_format_activity_action_friendship_accepted
+         * @ticket BP6040
+         */
+        public function test_bp_friends_format_activity_action_friendship_accepted_is_user() {
+                $bp = buddypress();
+                $displayed_user = $bp->displayed_user;
+
+                $u1 = $this->factory->user->create();
+                $u2 = $this->factory->user->create();
+
+                $a = $this->factory->activity->create( array(
+                        'component' => buddypress()->friends->id,
+                        'type' => 'friendship_accepted',
+                        'user_id' => $u1,
+                        'secondary_item_id' => $u2,
+                ) );
+
+                $bp->displayed_user->id = $u1;
+
+                // Use directly the class to avoid another activity to be created
+                // Maybe a new BP_UnitTest_Factory_For_Friends class would be better
+                $friendship = new BP_Friends_Friendship;
+                $friendship->initiator_user_id = $u2;
+                $friendship->friend_user_id    = $u1;
+                $friendship->is_confirmed      = 1;
+                $friendship->date_created      = bp_core_current_time();
+                $friendship->save();
+
+                $expected = sprintf( __( '%1$s and %2$s are now friends', 'buddypress' ), bp_core_get_userlink( $u1 ), bp_core_get_userlink( $u2 ) );
+
+                $a_obj = new BP_Activity_Activity( $a );
+
+                $this->assertSame( $expected, $a_obj->action );
+
+                // Reset the friendship
+                $friendship->delete();
+
+                // Reset displayed user
+                $bp->displayed_user = $displayed_user;
+        }
+
+        /**
+         * @group activity_action
+         * @group bp_friends_format_activity_action_friendship_created
+         * @ticket BP6040
+         */
+        public function test_bp_friends_format_activity_action_friendship_created_is_user() {
+                $bp = buddypress();
+                $displayed_user = $bp->displayed_user;
+
+                $u1 = $this->factory->user->create();
+                $u2 = $this->factory->user->create();
+
+                $a = $this->factory->activity->create( array(
+                        'component' => buddypress()->friends->id,
+                        'type' => 'friendship_created',
+                        'user_id' => $u1,
+                        'secondary_item_id' => $u2,
+                ) );
+
+                $bp->displayed_user->id = $u1;
+
+                // Use directly the class to avoid another activity to be created
+                // Maybe a new BP_UnitTest_Factory_For_Friends class would be better
+                $friendship = new BP_Friends_Friendship;
+                $friendship->initiator_user_id = $u1;
+                $friendship->friend_user_id    = $u2;
+                $friendship->is_confirmed      = 1;
+                $friendship->date_created      = bp_core_current_time();
+                $friendship->save();
+
                 $expected = sprintf( __( '%1$s and %2$s are now friends', 'buddypress' ), bp_core_get_userlink( $u1 ), bp_core_get_userlink( $u2 ) );
 
                 $a_obj = new BP_Activity_Activity( $a );
 
                 $this->assertSame( $expected, $a_obj->action );
+
+                // Reset the friendship
+                $friendship->delete();
+
+                // Reset displayed user
+                $bp->displayed_user = $displayed_user;
+        }
+
+        /**
+         * @group bp_friends_friendship_requested_activity
+         * @ticket BP6040
+         */
+        public function test_bp_friends_friendship_requested_activity() {
+                $u1 = $this->factory->user->create();
+                $u2 = $this->factory->user->create();
+
+                friends_add_friend( $u2, $u1 );
+                $friendship_id = friends_get_friendship_id( $u2, $u1 );
+
+                $fr_act = bp_activity_get( array(
+                        'component'   => buddypress()->friends->id,
+                        'item_id'     => $friendship_id,
+                        'filter'      => array( 'action' => array( 'friendship_created' ) ),
+                ) );
+
+                $this->assertTrue( count( $fr_act['activities'] ) == 1, 'An activity should be created when a friendship is requested' );
+
+                $friendship = new BP_Friends_Friendship( $friendship_id );
+                // Reset the friendship
+                $friendship->delete();
+        }
+
+        /**
+         * @group bp_friends_friendship_accepted_activity
+         * @ticket BP6040
+         */
+        public function test_bp_friends_friendship_accepted_activity() {
+                $u1 = $this->factory->user->create();
+                $u2 = $this->factory->user->create();
+
+                // Force the friendship to be accepted
+                friends_add_friend( $u2, $u1, true );
+                $friendship_id = friends_get_friendship_id( $u2, $u1 );
+
+                $fa_act = bp_activity_get( array(
+                        'component'   => buddypress()->friends->id,
+                        'item_id'     => $friendship_id,
+                        'filter'      => array( 'action' => array( 'friendship_accepted' ) ),
+                ) );
+
+                $this->assertTrue( count( $fa_act['activities'] ) == 1, 'An activity should be created when a friendship is accepted' );
+
+                $friendship = new BP_Friends_Friendship( $friendship_id );
+                // Reset the friendship
+                $friendship->delete();
+        }
+
+        /**
+         * @group bp_friends_friendship_withdrawn_activity
+         * @ticket BP6040
+         */
+        public function test_bp_friends_friendship_withdrawn_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 );
+
+                $fr_act = bp_activity_get( array(
+                        'component'   => buddypress()->friends->id,
+                        'item_id'     => $friendship_id,
+                        'filter'      => array( 'action' => array( 'friendship_created' ) ),
+                        'user_id'     => $u2,
+                ) );
+
+                $this->assertTrue( count( $fr_act['activities'] ) == 1, 'An activity should be created when a friendship is requested' );
+
+                // Set current user to u2 to make sure the friendship can be withdrawn
+                $this->set_current_user( $u2 );
+
+                // Withdraw the friendship
+                friends_withdraw_friendship( $u2, $u1 );
+
+                // Reset the current user
+                $this->set_current_user( $old_user );
+
+                $fw_act = bp_activity_get( array(
+                        'component'   => buddypress()->friends->id,
+                        'item_id'     => $friendship_id,
+                        'filter'      => array( 'action' => array( 'friendship_created' ) ),
+                        'user_id'     => $u2,
+                ) );
+
+                $this->assertTrue( count( $fw_act['activities'] ) == 0, 'The friendship_created activity should be deleted when a friendship is withdrawn' );
+        }
+
+        /**
+         * @group bp_friends_friendship_rejected_activity
+         * @ticket BP6040
+         */
+        public function test_bp_friends_friendship_rejected_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 make sure the friendship can be rejected
+                $this->set_current_user( $u1 );
+
+                // Withdraw the friendship
+                friends_reject_friendship( $friendship_id );
+
+                // Reset the current user
+                $this->set_current_user( $friendship_id );
+
+                $fj_act = bp_activity_get( array(
+                        'component'   => buddypress()->friends->id,
+                        'item_id'     => $friendship_id,
+                ) );
+
+                $this->assertTrue( count( $fj_act['activities'] ) == 0, 'Activities about a friendship should be deleted when a friendship is rejected' );
+        }
+
+        /**
+         * @group friends_delete_activity
+         * @ticket BP6040
+         */
+        public function test_friends_delete_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 );
+
+                // Random activities
+                $au1 = $this->factory->activity->create( array( 'user_id' => $u1 ) );
+                $au2 = $this->factory->activity->create( array( 'user_id' => $u2 ) );
+
+                $fc_act = bp_activity_get( array(
+                        'component'   => buddypress()->friends->id,
+                        'item_id'     => $friendship_id,
+                        'filter'      => array( 'action' => array( 'friendship_accepted', 'friendship_created' ) ), // friendship_accepted is no more used in BuddyPress since 1.1
+                        'show_hidden' => true
+                ) );
+
+                $this->assertTrue( count( $fc_act['activities'] ) == 2, '2 activities should be created when a friendship is confirmed' );
+
+                // Remove the friendship
+                friends_remove_friend( $u2, $u1 );
+
+                $this->assertFalse( friends_check_friendship( $u2, $u1 ), '2 users should not be friend once the friendship is removed' );
+
+                $fd_act = bp_activity_get( array(
+                        'component'   => buddypress()->friends->id,
+                        'item_id'     => $friendship_id,
+                        'filter'      => array( 'action' => array( 'friendship_accepted', 'friendship_created' ) ), // friendship_accepted is no more used in BuddyPress since 1.1
+                        'show_hidden' => true
+                ) );
+
+                $this->assertTrue( count( $fd_act['activities'] ) == 0, 'friends_delete_activity() should remove activities about a deleted friendship' );
         }
 }