Ticket #5148: 5148.class.01c.patch

bp-activity/bp-activity-notifications.php

@@ -39 +39 @@
  */
 function bp_activity_at_message_notification( $activity_id, $receiver_user_id ) {
 
-        // Don't leave multiple notifications for the same activity item
-        $notifications = BP_Core_Notification::get_all_for_user( $receiver_user_id, 'all' );
-
-        foreach( $notifications as $notification ) {
-                if ( $activity_id == $notification->item_id ) {
-                        return;
-                }
+        // Check to see if an at-mention notification exists for this activity item
+        $notifications = BP_Core_Notification::get( array(
+                'user_id'          => $receiver_user_id,
+                'item_id'          => $notification->item_id,
+                'component_action' => 'new_at_mention'
+        ) );
+
+        // At-mention notification already exists, so stop!
+        if ( ! empty( $notifications ) ) {
+                return;
         }
 
+        // Setup new BP notification
         $activity = new BP_Activity_Activity( $activity_id );
 
         $subject = '';

bp-core/bp-core-classes.php

@@ -1314 +1314 @@
         /**
          * Update or insert notification details into the database.
          *
-         * @global BuddyPress $bp The one true BuddyPress instance
          * @global wpdb $wpdb WordPress database object
          * @return bool Success or failure
          */
         public function save() {
-                global $bp, $wpdb;
+                global $wpdb;
+
+                $bp = buddypress();
+
+                // Allow manipulation before saving
+                do_action_ref_array( 'bp_notification_before_save', array( &$this ) );
+
+                // Make sure there's a user ID before saving. If not, stop now!
+                // This allows plugin devs to bail out of saving notifications if necessary
+                if ( empty( $this->user_id ) ) {
+                        return false;
+                }
 
                 // Update
                 if ( !empty( $this->id ) ) {
-                        $sql = $wpdb->prepare( "UPDATE {$bp->core->table_name_notifications} SET item_id = %d, secondary_item_id = %d, user_id = %d, component_name = %s, component_action = %d, date_notified = %s, is_new = %d ) WHERE id = %d", $this->item_id, $this->secondary_item_id, $this->user_id, $this->component_name, $this->component_action, $this->date_notified, $this->is_new, $this->id );
+                        $sql = $wpdb->prepare( "UPDATE {$bp->core->table_name_notifications} SET item_id = %d, secondary_item_id = %d, user_id = %d, component_name = %s, component_action = %d, date_notified = %s, is_new = %d WHERE id = %d", $this->item_id, $this->secondary_item_id, $this->user_id, $this->component_name, $this->component_action, $this->date_notified, $this->is_new, $this->id );
 
                 // Save
                 } else {
@@ -1335 +1345 @@
 
                 $this->id = $wpdb->insert_id;
 
+                // Allow manipulation after saving
+                do_action_ref_array( 'bp_notification_after_save', array( &$this ) );
+
                 return true;
         }
 
@@ -1343 +1356 @@
         /**
          * Fetches the notification data from the database.
          *
-         * @global BuddyPress $bp The one true BuddyPress instance
          * @global wpdb $wpdb WordPress database object
          */
         public function populate() {
-                global $bp, $wpdb;
+                global $wpdb;
+
+                $bp = buddypress();
 
                 if ( $notification = $wpdb->get_row( $wpdb->prepare( "SELECT * FROM {$bp->core->table_name_notifications} WHERE id = %d", $this->id ) ) ) {
-                        $this->item_id = $notification->item_id;
+                        $this->item_id           = $notification->item_id;
                         $this->secondary_item_id = $notification->secondary_item_id;
                         $this->user_id           = $notification->user_id;
                         $this->component_name    = $notification->component_name;
@@ -1363 +1377 @@
         /** Static Methods ********************************************************/
 
         public static function check_access( $user_id, $notification_id ) {
-                global $wpdb, $bp;
+                global $wpdb;
+
+                $bp = buddypress();
 
                 return $wpdb->get_var( $wpdb->prepare( "SELECT COUNT(id) FROM {$bp->core->table_name_notifications} WHERE id = %d AND user_id = %d", $notification_id, $user_id ) );
         }
 
         /**
+         * Get notifications.
+         *
+         * @since BuddyPress (1.9)
+         *
+         * @param array $args The parameters to get notifications {
+         *      @type int|string $id If integer, the notification ID. If string, list of
+         *       comma-delimited notification IDs.
+         *      @type int $user_id The user ID to filter by
+         *      @type int $item_id The item ID to filter by
+         *      @type int $secondary_item_id The secondary item ID to filter by
+         *      @type string $component_name The component name to filter by
+         *      @type string $component_action The component action to filter by
+         *      @type int $is_new Whether to filter by new notifications. Either 1 or 0.
+         * }
+         */
+        public static function get( $args = array() ) {
+                global $wpdb;
+
+                $bp = buddypress();
+
+                $defaults = array(
+                        'id'                => false,                 // the notificaton ID; can be comma-delimited to grab multiple notifications
+                        'user_id'           => bp_loggedin_user_id(), // the user ID you want to grab notifications for
+                        'item_id'           => false,
+                        'secondary_item_id' => false,
+                        'component_name'    => false,                 // the BP component ID
+                        'component_action'  => false,                 // the notification action
+                        'is_new'            => false,                 // check if the notification is new
+                );
+                
+                $r = wp_parse_args( $args, $defaults );
+
+                // SQL statement begins
+                $select_sql = "SELECT *";
+                $from_sql   = "FROM {$bp->core->table_name_notifications}";
+                $where_sql  = self::get_where_sql( $r );
+
+                // Apply a filter for plugin devs
+                $sql = apply_filters( 'bp_notifications_get_sql',
+                        "{$select_sql} {$from_sql} {$where_sql}",
+                        $r
+                );
+
+                return $wpdb->get_results( $sql );
+        }
+
+        /**
+         * Delete notifications.
+         *
+         * @since BuddyPress (1.9)
+         *
+         * @param int|array If int, the notification ID. Otherwise, an array of parameters to delete notifications {
+         *      @type int|string $id If integer, the notification ID. If string, comma-delimited
+         *       notification IDs.
+         *      @type int $user_id The user ID to filter by
+         *      @type int $item_id The item ID to filter by
+         *      @type int $secondary_item_id The secondary item ID to filter by
+         *      @type string $component_name The component name to filter by
+         *      @type string $component_action The component action to filter by
+         *      @type int $is_new Whether to filter by new notifications. Either 1 or 0.
+         * }
+         */
+        public static function delete( $args = array() ) {
+                global $wpdb;
+
+                $bp = buddypress();
+                
+                // support older integer parameter as referenced in
+                // bp_core_delete_notification()
+                if ( is_numeric( $args ) ) {
+                        $r = array();
+                        $r['id'] = $args;
+
+                // new way of doing things
+                } else {
+                        $defaults = array(
+                                'id'                => false, // the notificaton ID; can be comma-delimited to grab multiple notifications
+                                'user_id'           => false, // the user ID you want to grab notifications for
+                                'item_id'           => false,
+                                'secondary_item_id' => false,
+                                'component_name'    => false, // the BP component ID
+                                'component_action'  => false, // the notification action
+                                'is_new'            => false, // check if the notification is new
+                        );
+
+                        $r = wp_parse_args( $args, $defaults );
+                }
+
+                // generate WHERE sql
+                $where_sql = self::get_where_sql( $r );
+
+                // Apply a filter for plugin devs
+                $sql = apply_filters( 'bp_notifications_delete_sql',
+                        "DELETE FROM {$bp->core->table_name_notifications} {$where_sql}",
+                        $r
+                );
+
+                // Finally remove the group entry from the DB
+                if ( ! $wpdb->query( $sql ) ) {
+                        return false;
+                }
+
+                return true;
+        }
+
+        /**
+         * Utility method to generate the WHERE sql statement used in the
+         * {@link BP_Core_Notication::get()} and {@link BP_Core_Notication::delete()} methods.
+         *
+         * @since BuddyPress (1.9)
+         *
+         * @todo 'date_notified' column is omitted currently.
+         *
+         * @param array $params See BP_Core_Notication::get() for full description.
+         */
+        protected static function get_where_sql( $params = array() ) {
+                global $wpdb;
+
+                $where_conditions = array();
+
+                if ( ! empty( $params['id'] ) ) {
+                        $in = implode( ',', wp_parse_id_list( $in ) );
+                        $where_conditions['id'] = "id IN ({$in})";
+                }
+
+                if ( ! empty( $params['user_id'] ) ) {
+                        $where_conditions['user_id']           =  $wpdb->prepare( "user_id = %d", $params['user_id'] );
+                }
+
+                if ( ! empty( $params['item_id'] ) ) {
+                        $where_conditions['item_id']           = $wpdb->prepare( "item_id = %d", $params['item_id'] );
+                }
+
+                if (  isset( $params['secondary_item_id'] ) && $params['secondary_item_id'] !== false ) {
+                        $where_conditions['secondary_item_id'] = $wpdb->prepare( "secondary_item_id = %d", $params['secondary_item_id'] );
+                }
+
+                if ( ! empty( $params['component_name'] ) ) {
+                        $where_conditions['component_name']    = $wpdb->prepare( "component_name = %s", $params['component_name'] );
+                }
+
+                if ( ! empty( $params['component_action'] ) ) {
+                        $where_conditions['component_action']  = $wpdb->prepare( "component_action = %s", $params['component_action'] );
+                }
+
+                if ( isset( $params['is_new'] ) && $params['is_new'] !== false ) {
+                        $where_conditions['is_new']            = $wpdb->prepare( "is_new = %d", $params['is_new'] );
+                }
+
+                return 'WHERE ' . join( ' AND ', $where_conditions );
+
+        }
+
+        /** Deprecated ************************************************************/
+
+        /**
          * Fetches all the notifications in the database for a specific user.
          *
-         * @global BuddyPress $bp The one true BuddyPress instance
-         * @global wpdb $wpdb WordPress database object
+         * @deprecated 1.9 Use BP_Core_Notification::get() with the 'user_id' and 'is_new'
+         *  parameters instead.
+         *
          * @param integer $user_id User ID
          * @param string $status 'is_new' or 'all'
          * @return array Associative array
          * @static
          */
         public static function get_all_for_user( $user_id, $status = 'is_new' ) {
-                global $bp, $wpdb;
-
-                $is_new = ( 'is_new' == $status ) ? ' AND is_new = 1 ' : '';
+                _deprecated_function( __METHOD__, '1.9', "BP_Core_Notification::get() with the 'user_id' and 'is_new' parameters" );
 
-                return $wpdb->get_results( $wpdb->prepare( "SELECT * FROM {$bp->core->table_name_notifications} WHERE user_id = %d {$is_new}", $user_id ) );
+                return self::get( array(
+                        'user_id' => $user_id,
+                        'is_new'  => ( 'is_new' == $status ) ? 1 : false
+                ) );
         }
 
         /**
-         * Delete all the notifications for a user based on the component name and action.
+         * Delete all the notifications for a user based on the component name and
+         * action.
+         *
+         * @deprecated 1.9 Use BP_Core_Notification::get() with the 'user_id', 'component_name',
+         *  and 'component_action' parameters instead.
          *
-         * @global BuddyPress $bp The one true BuddyPress instance
-         * @global wpdb $wpdb WordPress database object
          * @param integer $user_id
          * @param string $component_name
          * @param string $component_action
          * @static
          */
         public static function delete_for_user_by_type( $user_id, $component_name, $component_action ) {
-                global $bp, $wpdb;
+                _deprecated_function( __METHOD__, '1.9', "BP_Core_Notification::get() with the 'user_id', 'component_name' and 'component_action' parameters" );
 
-                return $wpdb->query( $wpdb->prepare( "DELETE FROM {$bp->core->table_name_notifications} WHERE user_id = %d AND component_name = %s AND component_action = %s", $user_id, $component_name, $component_action ) );
+                return self::delete( array(
+                        'user_id'          => $user_id,
+                        'component_name'   => $component_name,
+                        'component_action' => $component_action
+                ) );
         }
 
         /**
-         * Delete all the notifications that have a specific item id, component name and action.
+         * Delete all the notifications that have a specific item id, component name
+         * and action.
+         *
+         * @deprecated 1.9 Use BP_Core_Notification::get() with the 'user_id', 'item_id',
+         *  'component_name', 'component_action' and 'secondary_item_id' parameters instead.
          *
-         * @global BuddyPress $bp The one true BuddyPress instance
-         * @global wpdb $wpdb WordPress database object
          * @param integer $user_id The ID of the user who the notifications are for.
          * @param integer $item_id The item ID of the notifications we wish to delete.
          * @param string $component_name The name of the component that the notifications we wish to delete.
@@ -1415 +1597 @@
          * @static
          */
         public static function delete_for_user_by_item_id( $user_id, $item_id, $component_name, $component_action, $secondary_item_id = false ) {
-                global $bp, $wpdb;
-
-                $secondary_item_sql = !empty( $secondary_item_id ) ? $wpdb->prepare( " AND secondary_item_id = %d", $secondary_item_id ) : '';
-
-                return $wpdb->query( $wpdb->prepare( "DELETE FROM {$bp->core->table_name_notifications} WHERE user_id = %d AND item_id = %d AND component_name = %s AND component_action = %s{$secondary_item_sql}", $user_id, $item_id, $component_name, $component_action ) );
+                _deprecated_function( __METHOD__, '1.9', "BP_Core_Notification::get() with the 'user_id', 'item_id', 'component_name', 'component_action' and 'secondary_item_id' parameters." );
+
+                return self::delete( array(
+                        'user_id'           => $user_id,
+                        'item_id'           => $item_id,
+                        'component_name'    => $component_name,
+                        'component_action'  => $component_action,
+                        'secondary_item_id' => $secondary_item_id,
+                ) );
         }
 
         /**
-         * Deletes all the notifications sent by a specific user, by component and action.
+         * Deletes all the notifications sent by a specific user, by component and
+         * action.
+         *
+         * @deprecated 1.9 Use BP_Core_Notification::get() with the 'user_id', 'component_name'
+         *  and 'secondary_item_id' parameters instead.
          *
-         * @global BuddyPress $bp The one true BuddyPress instance
-         * @global wpdb $wpdb WordPress database object
          * @param integer $user_id The ID of the user whose sent notifications we wish to delete.
          * @param string $component_name The name of the component the notification was sent from.
          * @param string $component_action The action of the component the notification was sent from.
          * @static
          */
         public static function delete_from_user_by_type( $user_id, $component_name, $component_action ) {
-                global $bp, $wpdb;
+                _deprecated_function( __METHOD__, '1.9', "BP_Core_Notification::get() with the 'user_id', 'component_name' and 'component_action' parameters" );
 
-                return $wpdb->query( $wpdb->prepare( "DELETE FROM {$bp->core->table_name_notifications} WHERE item_id = %d AND component_name = %s AND component_action = %s", $user_id, $component_name, $component_action ) );
+                return self::delete( array(
+                        'user_id'           => $user_id,
+                        'component_name'    => $component_name,
+                        'component_action'  => $component_action
+                ) );
         }
 
         /**
-         * Deletes all the notifications for all users by item id, and optional secondary item id, and component name and action.
+         * Deletes all the notifications for all users by item id, and optional
+         * secondary item id, and component name and action.
+         *
+         * @deprecated 1.9 Use BP_Core_Notification::get() with the 'item_id', 'component_name'
+         *  and 'secondary_item_id' parameters instead.
          *
-         * @global BuddyPress $bp The one true BuddyPress instance
-         * @global wpdb $wpdb WordPress database object
          * @param string $item_id The item id that they notifications are to be for.
          * @param string $component_name The component that the notifications are to be from.
          * @param string $component_action The action that the notificationsa are to be from.
@@ -1450 +1644 @@
          * @static
          */
         public static function delete_all_by_type( $item_id, $component_name, $component_action, $secondary_item_id ) {
-                global $bp, $wpdb;
-
-                if ( $component_action )
-                        $component_action_sql = $wpdb->prepare( "AND component_action = %s", $component_action );
-                else
-                        $component_action_sql = '';
-
-                if ( $secondary_item_id )
-                        $secondary_item_sql = $wpdb->prepare( "AND secondary_item_id = %d", $secondary_item_id );
-                else
-                        $secondary_item_sql = '';
-
-                return $wpdb->query( $wpdb->prepare( "DELETE FROM {$bp->core->table_name_notifications} WHERE item_id = %d AND component_name = %s {$component_action_sql} {$secondary_item_sql}", $item_id, $component_name ) );
+                _deprecated_function( __METHOD__, '1.9', "BP_Core_Notification::get() with the 'item_id', 'component_name', 'component_action' and 'secondary_item_id' parameters" );
+
+                return self::delete( array(
+                        'item_id'           => $item_id,
+                        'component_name'    => $component_name,
+                        'component_action'  => $component_action,
+                        'secondary_item_id' => $secondary_item_id,
+                ) );
         }
 }
 

bp-core/deprecated/1.5.php

@@ -381 +381 @@
  */
 function bp_core_delete_notifications_for_user_by_type( $user_id, $component_name, $component_action ) {
         _deprecated_function( __FUNCTION__, '1.5', 'bp_core_delete_notifications_by_type()' );
-        return BP_Core_Notification::delete_for_user_by_type( $user_id, $component_name, $component_action );
+        return bp_core_delete_notifications_by_type( $user_id, $component_name, $component_action );
 }
 
 function bp_core_delete_notifications_for_user_by_item_id( $user_id, $item_id, $component_name, $component_action, $secondary_item_id = false ) {
         _deprecated_function( __FUNCTION__, '1.5', 'bp_core_delete_notifications_by_item_id()' );
-        return BP_Core_Notification::delete_for_user_by_item_id( $user_id, $item_id, $component_name, $component_action, $secondary_item_id );
+        return bp_core_delete_notifications_by_item_id( $user_id, $item_id, $component_name, $component_action, $secondary_item_id );
 }
 
 /**

bp-members/bp-members-notifications.php

@@ -83 +83 @@
 function bp_core_get_notifications_for_user( $user_id, $format = 'simple' ) {
         global $bp;
 
-        $notifications         = BP_Core_Notification::get_all_for_user( $user_id );
+        $notifications         = BP_Core_Notification::get( array( 'user_id' => $user_id ) );
         $grouped_notifications = array(); // Notification groups
         $renderable            = array(); // Renderable notifications
 
@@ -184 +184 @@
  * @return boolean True on success, false on fail
  */
 function bp_core_delete_notifications_by_type( $user_id, $component_name, $component_action ) {
-        return BP_Core_Notification::delete_for_user_by_type( $user_id, $component_name, $component_action );
+        return BP_Core_Notification::delete( array(
+                'user_id'          => $user_id,
+                'component_name'   => $component_name,
+                'component_action' => $component_action
+        ) );
 }
 
 /**
@@ -200 +204 @@
  * @return boolean True on success, false on fail
  */
 function bp_core_delete_notifications_by_item_id( $user_id, $item_id, $component_name, $component_action, $secondary_item_id = false ) {
-        return BP_Core_Notification::delete_for_user_by_item_id( $user_id, $item_id, $component_name, $component_action, $secondary_item_id );
+        return BP_Core_Notification::delete( array(
+                'user_id'           => $user_id,
+                'item_id'           => $item_id,
+                'component_name'    => $component_name,
+                'component_action'  => $component_action,
+                'secondary_item_id' => $secondary_item_id
+        ) );
 }
 
 /**
@@ -215 +225 @@
  * @return boolean True on success, false on fail
  */
 function bp_core_delete_all_notifications_by_type( $item_id, $component_name, $component_action = false, $secondary_item_id = false ) {
-        return BP_Core_Notification::delete_all_by_type( $item_id, $component_name, $component_action, $secondary_item_id );
+        return BP_Core_Notification::delete( array(
+                'item_id'           => $item_id,
+                'component_name'    => $component_name,
+                'component_action'  => $component_action,
+                'secondary_item_id' => $secondary_item_id
+        ) );
 }
 
 /**
@@ -230 +245 @@
  * @return boolean True on success, false on fail
  */
 function bp_core_delete_notifications_from_user( $user_id, $component_name, $component_action ) {
-        return BP_Core_Notification::delete_from_user_by_type( $user_id, $component_name, $component_action );
+        return BP_Core_Notification::delete( array(
+                'user_id'           => $user_id,
+                'component_name'    => $component_name,
+                'component_action'  => $component_action
+        ) );
 }
 
 /**

tests/testcases/notifications/class-bp-core-notification.php

@@ +1 @@
+<?php
+/**
+ * @group notifications
+ */
+class BP_Tests_BP_Core_Notification_TestCases extends BP_UnitTestCase {
+        public function setUp() {
+                if ( ! method_exists( 'BP_Core_Notification', 'get') ) {
+                        $this->markTestSkipped(
+                                'BP_Core_Notification::get() is only available in BP 1.9.'
+                        );
+
+                }
+
+                parent::setUp();
+
+                add_filter( 'bp_notifications_delete_sql', array( $this, 'save_sql' ), 0 );
+                add_filter( 'bp_notifications_get_sql',    array( $this, 'save_sql' ), 0 );
+        }
+
+        public function tearDown() {
+                parent::tearDown();
+                unset( $this->where_sql );
+        }
+
+        /** TESTS ****************************************************************/
+
+        /**
+         * Tests the WHERE sql statement generated by {@link BP_Core_Notification::get_all_for_user()}.
+         */
+        public function test_get_all_for_user_is_new_sql() {
+                $expected = 'WHERE user_id = 1 AND is_new = 1';
+
+                BP_Core_Notification::get_all_for_user( 1 );
+
+                $this->assertEquals(
+                        $expected,
+                        $this->where_sql
+                );
+        }
+
+        /**
+         * Tests the WHERE sql statement generated by {@link BP_Core_Notification::get_all_for_user()}.
+         */
+        public function test_get_all_for_user_sql() {
+                $expected = 'WHERE user_id = 1';
+
+                BP_Core_Notification::get_all_for_user( 1, 'all' );
+
+                $this->assertEquals(
+                        $expected,
+                        $this->where_sql
+                );
+        }
+
+        /**
+         * Tests the WHERE sql statement generated by {@link bp_core_delete_notifications_by_type()}.
+         */
+        public function test_delete_for_user_by_type_sql() {
+                $expected = "WHERE user_id = 1 AND component_name = 'activity' AND component_action = 'new_at_mention'";
+
+                // emulates call in bp_activity_remove_screen_notifications()
+                bp_core_delete_notifications_by_type( 1, 'activity', 'new_at_mention' );
+
+                $this->assertEquals(
+                        $expected,
+                        $this->where_sql
+                );
+        }
+
+        /**
+         * Tests the WHERE sql statement generated by {@link bp_core_delete_notifications_by_item_id()}.
+         */
+        public function test_delete_for_user_by_item_id_sql() {
+                $expected = "WHERE user_id = 1 AND item_id = 1 AND component_name = 'groups' AND component_action = 'group_invite'";
+
+                // emulates call in groups_accept_invite()
+                bp_core_delete_notifications_by_item_id( 1, 1, 'groups', 'group_invite' );
+
+                $this->assertEquals(
+                        $expected,
+                        $this->where_sql
+                );
+        }
+
+        /**
+         * Tests the WHERE sql statement generated by {@link bp_core_delete_notifications_from_user()}.
+         */
+        public function test_delete_from_user_by_type_sql() {
+                $expected = "WHERE user_id = 1 AND component_name = 'groups' AND component_action = 'new_membership_request'";
+
+                // emulates call in groups_remove_data_for_user()
+                bp_core_delete_notifications_from_user( 1, 'groups', 'new_membership_request' );
+
+                $this->assertEquals(
+                        $expected,
+                        $this->where_sql
+                );
+        }
+
+        /**
+         * Tests the WHERE sql statement generated by {@link bp_core_delete_all_notifications_by_type()}.
+         */
+        public function test_delete_all_by_type_sql() {
+                $expected = "WHERE item_id = 1 AND component_name = 'groups'";
+
+                // emulates call in groups_delete_group()
+                bp_core_delete_all_notifications_by_type( 1, 'groups' );
+
+                $this->assertEquals(
+                        $expected,
+                        $this->where_sql
+                );
+        }
+
+        /** UTILITY **************************************************************/
+
+        /**
+         * Utility method to save the SQL statement before the actual query is run.
+         */
+        public function save_sql( $retval ) {
+                // only get the WHERE sql portion of the statement
+                $this->where_sql = $this->get_where_sql( $retval );
+
+                return $retval;
+        }
+
+        /**
+         * Utility method to return the WHERE sql statement from a given SQL statement.
+         */
+        protected function get_where_sql( $sql ) {
+                $leading_sql = strpos( $sql, 'WHERE' );
+                return substr( $sql, $leading_sql );
+        }
+}