<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[BuddyPress][12903] trunk: BP_Optout: Ensure email_address is always lowercase.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="http://buddypress.trac.wordpress.org/changeset/12903">12903</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"http://buddypress.trac.wordpress.org/changeset/12903","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>dcavins</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2021-04-21 19:10:20 +0000 (Wed, 21 Apr 2021)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>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 <a href="http://buddypress.trac.wordpress.org/ticket/8448">#8448</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpcoreclassesclassbpoptoutphp">trunk/src/bp-core/classes/class-bp-optout.php</a></li>
<li><a href="#trunktestsphpunittestcasescoreoptoutsphp">trunk/tests/phpunit/testcases/core/optouts.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpcoreclassesclassbpoptoutphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-core/classes/class-bp-optout.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-core/classes/class-bp-optout.php 2021-04-21 14:53:57 UTC (rev 12902)
+++ trunk/src/bp-core/classes/class-bp-optout.php 2021-04-21 19:10:20 UTC (rev 12903)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -212,8 +212,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> protected static function _insert( $data = array(), $data_format = array() ) {
</span><span class="cx" style="display: block; padding: 0 10px"> global $wpdb;
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // We must hash the email address at insert.
- $data['email_address_hash'] = wp_hash( $data['email_address_hash'] );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // We must lowercase and hash the email address at insert.
+ $email = strtolower( $data['email_address_hash'] );
+ $data['email_address_hash'] = wp_hash( $email );
</ins><span class="cx" style="display: block; padding: 0 10px"> return $wpdb->insert( BP_Optout::get_table_name(), $data, $data_format );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -237,9 +238,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> protected static function _update( $data = array(), $where = array(), $data_format = array(), $where_format = array() ) {
</span><span class="cx" style="display: block; padding: 0 10px"> global $wpdb;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Ensure that a passed email address is hashed.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Ensure that a passed email address is lowercased and hashed.
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( ! empty( $data['email_address_hash'] ) && is_email( $data['email_address_hash'] ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $data['email_address_hash'] = wp_hash( $data['email_address_hash'] );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $email = strtolower( $data['email_address_hash'] );
+ $data['email_address_hash'] = wp_hash( $email );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> return $wpdb->update( BP_Optout::get_table_name(), $data, $where, $data_format, $where_format );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -296,6 +298,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $email_clean = array();
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $emails as $email ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $email = strtolower( $email );
</ins><span class="cx" style="display: block; padding: 0 10px"> $email_hash = wp_hash( $email );
</span><span class="cx" style="display: block; padding: 0 10px"> $email_clean[] = $wpdb->prepare( '%s', $email_hash );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -330,6 +333,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // search_terms.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! empty( $args['search_terms'] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> // Matching email_address is an exact match because of the hashing.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $args['search_terms'] = strtolower( $args['search_terms'] );
</ins><span class="cx" style="display: block; padding: 0 10px"> $search_terms_like = wp_hash( $args['search_terms'] );
</span><span class="cx" style="display: block; padding: 0 10px"> $where_conditions['search_terms'] = $wpdb->prepare( '( email_address_hash LIKE %s )', $search_terms_like );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunktestsphpunittestcasescoreoptoutsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/testcases/core/optouts.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/testcases/core/optouts.php 2021-04-21 14:53:57 UTC (rev 12902)
+++ trunk/tests/phpunit/testcases/core/optouts.php 2021-04-21 19:10:20 UTC (rev 12903)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -100,4 +100,85 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->set_current_user( $old_current_user );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 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 );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>