Changeset 9326

Timestamp:

01/09/2015 08:56:45 AM (12 years ago)

Author:

imath

Message:

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 #6040

props boonebgorges, r-a-y

Location:

trunk

Files:

• src/bp-core/bp-core-update.php (modified) (3 diffs)
• src/bp-friends/bp-friends-activity.php (modified) (2 diffs)
• tests/phpunit/testcases/friends/activity.php (modified) (1 diff)

trunk/src/bp-core/bp-core-update.php

@@ -400 +400 @@
  * - Add messages meta table
  * - Update the component field of the 'new members' activity type
+ * - Clean up hidden friendship activities
  *
  * @since BuddyPress (2.2.0)
@@ -410 +411 @@
         if ( bp_is_active( 'activity' ) ) {
                 bp_migrate_new_member_activity_component();
+
+                if ( bp_is_active( 'friends' ) ) {
+                        bp_cleanup_friendship_activities();
+                }
         }
 }
@@ -450 +455 @@
 
 /**
+ * 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,
+        ) );
+ }
+
+/**
  * Redirect user to BP's What's New page on first page load after activation.
  *

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

@@ -272 +272 @@
 
 /**
+ * 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 );
+
+/**
  * Add activity stream items when one members accepts another members request
  * for virtual friendship.
@@ -294 +354 @@
                 'secondary_item_id' => $friend_user_id
         ) );
-
-        // 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
-        ) );
 }
 add_action( 'friends_friendship_accepted', 'bp_friends_friendship_accepted_activity', 10, 4 );

trunk/tests/phpunit/testcases/friends/activity.php

@@ -96 +96 @@
                 $this->assertTrue( count( $fd_act['activities'] ) == 0, 'friends_delete_activity() should remove "friendship_created" activities about a deleted friendship' );
         }
+
+        /**
+         * @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 );
+        }
 }