Changeset 8100

Timestamp:

03/09/2014 07:59:01 PM (11 years ago)

Author:

boonebgorges

Message:

Disable duplicate notification creation by default, and introduce 'allow_duplicate' param for override

Generally, it's undesirable to have duplicate notifications for a given
user-item-secondary_item-component-action combination (as when, say, someone
mentions you many times in a single message thread). This changeset introduces
duplicate protection, which can be overridden by passing the 'allow_duplicate'
param to bp_notifications_add_notification().

Fixes #5297

Location:

trunk

Files:

• bp-notifications/bp-notifications-functions.php (modified) (1 diff)
• tests/testcases/notifications/functions.php (modified) (1 diff)

trunk/bp-notifications/bp-notifications-functions.php

@@ -43 +43 @@
         'date_notified'     => bp_core_current_time(),
         'is_new'            => 1,
+        'allow_duplicate'   => false,
     ) );
+
+    // Check for existing duplicate notifications
+    if ( ! $r['allow_duplicate'] ) {
+        // date_notified, allow_duplicate don't count toward
+        // duplicate status
+        $existing = BP_Notifications_Notification::get( array(
+            'user_id'           => $r['user_id'],
+            'item_id'           => $r['item_id'],
+            'secondary_item_id' => $r['secondary_item_id'],
+            'component_name'    => $r['component_name'],
+            'component_action'  => $r['component_action'],
+            'is_new'            => $r['is_new'],
+        ) );
+
+        if ( ! empty( $existing ) ) {
+            return false;
+        }
+    }
 
     // Setup the new notification

trunk/tests/testcases/notifications/functions.php

@@ -53 +53 @@
         $this->assertFalse( wp_cache_get( 'all_for_user_' . $u, 'bp_notifications' ) );
     }
+
+    /**
+     * @group bp_notifications_add_notification
+     */
+    public function test_bp_notifications_add_notification_no_dupes() {
+        $args = array(
+            'user_id' => 5,
+            'item_id' => 10,
+            'secondary_item_id' => 25,
+            'component_name' => 'messages',
+            'component_action' => 'new_message',
+        );
+
+        $n = $this->factory->notification->create( $args );
+
+        $this->assertFalse( bp_notifications_add_notification( $args ) );
+    }
+
+    /**
+     * @group bp_notifications_add_notification
+     */
+    public function test_bp_notifications_add_notification_allow_duplicate() {
+        $args = array(
+            'user_id' => 5,
+            'item_id' => 10,
+            'secondary_item_id' => 25,
+            'component_name' => 'messages',
+            'component_action' => 'new_message',
+        );
+
+        $n = $this->factory->notification->create( $args );
+
+        $args['allow_duplicate'] = true;
+
+        $this->assertNotEmpty( bp_notifications_add_notification( $args ) );
+    }
 }