Changeset 12903

Timestamp:

04/21/2021 07:10:20 PM (3 years ago)

Author:

dcavins

Message:

BP_Optout: Ensure email_address is always lowercase.

When adding, updating, or fetching opt-outs,
be sure that the email address string has
been converted to lowercase, else the comparisons
of the hashed values will fail.

See #8448.

Location:

trunk

Files:

• src/bp-core/classes/class-bp-optout.php (modified) (4 diffs)
• tests/phpunit/testcases/core/optouts.php (modified) (1 diff)

trunk/src/bp-core/classes/class-bp-optout.php

@@ -213 +213 @@
     protected static function _insert( $data = array(), $data_format = array() ) {
         global $wpdb;
-        // We must hash the email address at insert.
-        $data['email_address_hash'] = wp_hash( $data['email_address_hash'] );
+        // We must lowercase and hash the email address at insert.
+        $email                      = strtolower( $data['email_address_hash'] );
+        $data['email_address_hash'] = wp_hash( $email );
         return $wpdb->insert( BP_Optout::get_table_name(), $data, $data_format );
     }
@@ -238 +239 @@
         global $wpdb;
 
-        // Ensure that a passed email address is hashed.
+        // Ensure that a passed email address is lowercased and hashed.
         if ( ! empty( $data['email_address_hash'] ) && is_email( $data['email_address_hash'] ) ) {
-            $data['email_address_hash'] = wp_hash( $data['email_address_hash'] );
+            $email                      = strtolower( $data['email_address_hash'] );
+            $data['email_address_hash'] = wp_hash( $email );
         }
 
@@ -297 +299 @@
             $email_clean = array();
             foreach ( $emails as $email ) {
+                $email         = strtolower( $email );
                 $email_hash    = wp_hash( $email );
                 $email_clean[] = $wpdb->prepare( '%s', $email_hash );
@@ -331 +334 @@
         if ( ! empty( $args['search_terms'] ) ) {
             // Matching email_address is an exact match because of the hashing.
+            $args['search_terms']             = strtolower( $args['search_terms'] );
             $search_terms_like                = wp_hash( $args['search_terms'] );
             $where_conditions['search_terms'] = $wpdb->prepare( '( email_address_hash LIKE %s )', $search_terms_like );

trunk/tests/phpunit/testcases/core/optouts.php

@@ -101 +101 @@
     }
 
+    public function test_bp_optouts_get_by_email_address_mismatched_case() {
+        $old_current_user = get_current_user_id();
+
+        $u1 = $this->factory->user->create();
+        $this->set_current_user( $u1 );
+
+        // Create a couple of optouts.
+        $args = array(
+            'email_address'     => 'ONE@wpfrost.org',
+            'user_id'           => $u1,
+            'email_type'        => 'annoyance'
+        );
+        $i1 = bp_add_optout( $args );
+        $args['email_address'] = 'two@WP.org';
+        $i2 = bp_add_optout( $args );
+
+        $get_args = array(
+            'email_address'  => 'one@WPfrost.org',
+            'fields'         => 'ids',
+        );
+        $optouts = bp_get_optouts( $get_args );
+        $this->assertEqualSets( array( $i1 ), $optouts );
+
+        $this->set_current_user( $old_current_user );
+    }
+
+    public function test_bp_optouts_get_by_search_terms_mismatched_case() {
+        $old_current_user = get_current_user_id();
+
+        $u1 = $this->factory->user->create();
+        $this->set_current_user( $u1 );
+
+        // Create a couple of optouts.
+        $args = array(
+            'email_address'     => 'ONE@wpfrost.org',
+            'user_id'           => $u1,
+            'email_type'        => 'annoyance'
+        );
+        $i1 = bp_add_optout( $args );
+        $args['email_address'] = 'two@WP.org';
+        $i2 = bp_add_optout( $args );
+
+        $get_args = array(
+            'search_terms'   => 'one@wpfrost.org',
+            'fields'         => 'ids',
+        );
+        $optouts = bp_get_optouts( $get_args );
+        $this->assertEqualSets( array( $i1 ), $optouts );
+
+        $this->set_current_user( $old_current_user );
+    }
+
+
+    public function test_bp_optouts_get_by_email_address_mismatched_case_after_update() {
+        $old_current_user = get_current_user_id();
+
+        $u1 = $this->factory->user->create();
+        $this->set_current_user( $u1 );
+
+        // Create an opt-out.
+        $args = array(
+            'email_address'     => 'ONE@wpfrost.org',
+            'user_id'           => $u1,
+            'email_type'        => 'annoyance'
+        );
+        $i1 = bp_add_optout( $args );
+        // Update it.
+        $oo_class                = new BP_Optout( $i1 );
+        $oo_class->email_address = 'One@wpFrost.org';
+        $oo_class->save();
+
+        $get_args = array(
+            'email_address'  => 'one@WPfrost.org',
+            'fields'         => 'ids',
+        );
+        $optouts = bp_get_optouts( $get_args );
+        $this->assertEqualSets( array( $i1 ), $optouts );
+
+        $this->set_current_user( $old_current_user );
+    }
+
 }