<!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][12912] trunk/src/bp-core: BP_Optouts: Improve unsubscribe behavior.</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/12912">12912</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/12912","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-28 23:49:18 +0000 (Wed, 28 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_Optouts: Improve unsubscribe behavior.
Improve unsubscribe link behavior when user is not
a site member, meaning that the unsubscribe is an
opt-out request.
{U+2022} Introduce `bp_user_has_opted_out()` as convenience
function for checking an email address's status
{U+2022} Build `bp_email_get_unsubscribe_link()` for
non-member case.
{U+2022} `bp_email_unsubscribe_handler()` handles
non-member case and uses `wp_die()` screen
to display message.
{U+2022} Fix unsusbscribe headers for opt-out links.
Props imath.
See <a href="http://buddypress.trac.wordpress.org/ticket/8448">#8448</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpcorebpcorefiltersphp">trunk/src/bp-core/bp-core-filters.php</a></li>
<li><a href="#trunksrcbpcorebpcorefunctionsphp">trunk/src/bp-core/bp-core-functions.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpcorebpcorefiltersphp"></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/bp-core-filters.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-core/bp-core-filters.php 2021-04-28 23:49:06 UTC (rev 12911)
+++ trunk/src/bp-core/bp-core-filters.php 2021-04-28 23:49:18 UTC (rev 12912)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1067,13 +1067,22 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Add 'List-Unsubscribe' header if applicable.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! empty( $tokens['unsubscribe'] ) && $tokens['unsubscribe'] !== wp_login_url() ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $user = get_user_by( 'email', $tokens['recipient.email'] );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $user = get_user_by( 'email', $tokens['recipient.email'] );
+ $user_id = isset( $user->ID ) ? $user->ID : 0;
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $link = bp_email_get_unsubscribe_link( array(
- 'user_id' => $user->ID,
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $args = array(
+ 'user_id' => $user_id,
</ins><span class="cx" style="display: block; padding: 0 10px"> 'notification_type' => $email->get( 'type' ),
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // If this email is not to a current member, include the nonmember's email address and the Inviter ID.
+ if ( ! $user_id ) {
+ $args['email_address'] = $tokens['recipient.email'];
+ $args['member_id'] = bp_loggedin_user_id();
+ }
+
+ $link = bp_email_get_unsubscribe_link( $args );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( ! empty( $link ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $headers['List-Unsubscribe'] = sprintf( '<%s>', esc_url_raw( $link ) );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunksrcbpcorebpcorefunctionsphp"></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/bp-core-functions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-core/bp-core-functions.php 2021-04-28 23:49:06 UTC (rev 12911)
+++ trunk/src/bp-core/bp-core-functions.php 2021-04-28 23:49:18 UTC (rev 12912)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -4049,10 +4049,19 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $raw_email_type = ! empty( $_GET['nt'] ) ? $_GET['nt'] : '';
</span><span class="cx" style="display: block; padding: 0 10px"> $raw_hash = ! empty( $_GET['nh'] ) ? $_GET['nh'] : '';
</span><span class="cx" style="display: block; padding: 0 10px"> $raw_user_id = ! empty( $_GET['uid'] ) ? absint( $_GET['uid'] ) : 0;
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $new_hash = hash_hmac( 'sha1', "{$raw_email_type}:{$raw_user_id}", bp_email_get_salt() );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $raw_user_email = ! empty( $_GET['uem'] ) ? $_GET['uem'] : '';
+ $raw_member_id = ! empty( $_GET['mid'] ) ? absint( $_GET['mid'] ) : 0;
+ $redirect_to = '';
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $new_hash = '';
+ if ( ! empty( $raw_user_id ) ) {
+ $new_hash = hash_hmac( 'sha1', "{$raw_email_type}:{$raw_user_id}", bp_email_get_salt() );
+ } else if ( ! empty( $raw_user_email ) ) {
+ $new_hash = hash_hmac( 'sha1', "{$raw_email_type}:{$raw_user_email}", bp_email_get_salt() );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // Check required values.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( ! $raw_user_id || ! $raw_email_type || ! $raw_hash || ! array_key_exists( $raw_email_type, $emails ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ( ! $raw_user_id && ! $raw_user_email ) || ! $raw_email_type || ! $raw_hash || ! array_key_exists( $raw_email_type, $emails ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $redirect_to = wp_login_url();
</span><span class="cx" style="display: block; padding: 0 10px"> $result_msg = __( 'Something has gone wrong.', 'buddypress' );
</span><span class="cx" style="display: block; padding: 0 10px"> $unsub_msg = __( 'Please log in and go to your settings to unsubscribe from notification emails.', 'buddypress' );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -4078,6 +4087,25 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $redirect_to = bp_core_get_user_domain( get_current_user_id() );
</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">+ // This is an unsubscribe request from a nonmember.
+ } else if ( $raw_user_email ) {
+ // Unsubscribe.
+ if ( bp_user_has_opted_out() ) {
+ $result_msg = $emails[ $raw_email_type ]['unsubscribe']['message'];
+ $unsub_msg = __( 'You have already unsubscribed from all communication from this site.', 'buddypress' );
+ } else {
+ $optout_args = array(
+ 'email_address' => $raw_user_email,
+ 'user_id' => $raw_member_id,
+ 'email_type' => $raw_email_type,
+ 'date_modified' => bp_core_current_time(),
+ );
+ bp_add_optout( $optout_args );
+ $result_msg = $emails[ $raw_email_type ]['unsubscribe']['message'];
+ $unsub_msg = __( 'You have been unsubscribed.', 'buddypress' );
+ }
+
+ // This is an unsubscribe request from a current member.
</ins><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( bp_is_active( 'settings' ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $redirect_to = sprintf(
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -4097,17 +4125,29 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $unsub_msg = __( 'You can change this or any other email notification preferences in your email settings.', 'buddypress' );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $message = sprintf(
- '%1$s <a href="%2$s">%3$s</a>',
- $result_msg,
- esc_url( $redirect_to ),
- esc_html( $unsub_msg )
- );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( $raw_user_id && $redirect_to ) {
+ $message = sprintf(
+ '%1$s <a href="%2$s">%3$s</a>',
+ $result_msg,
+ esc_url( $redirect_to ),
+ esc_html( $unsub_msg )
+ );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- bp_core_add_message( $message );
- bp_core_redirect( bp_core_get_user_domain( $raw_user_id ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Template notices are only displayed on BP pages.
+ bp_core_add_message( $message );
+ bp_core_redirect( bp_core_get_user_domain( $raw_user_id ) );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- exit;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ exit;
+ } else {
+ wp_die(
+ sprintf( '%1$s %2$s', esc_html( $unsub_msg ), esc_html( $result_msg ) ),
+ esc_html( $unsub_msg ),
+ array(
+ 'link_url' => home_url(),
+ 'link_text' => __( 'Go to website\'s home page.', 'buddypress' ),
+ )
+ );
+ }
</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"> /**
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -4141,16 +4181,35 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return '';
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $link = add_query_arg(
- array(
- 'action' => 'unsubscribe',
- 'nh' => hash_hmac( 'sha1', "{$email_type}:{$user_id}", bp_email_get_salt() ),
- 'nt' => $args['notification_type'],
- 'uid' => $user_id,
- ),
- $redirect_to
- );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $link = '';
+ // Case where the recipient is a member of the site.
+ if ( ! empty( $user_id ) ) {
+ $link = add_query_arg(
+ array(
+ 'action' => 'unsubscribe',
+ 'nh' => hash_hmac( 'sha1', "{$email_type}:{$user_id}", bp_email_get_salt() ),
+ 'nt' => $args['notification_type'],
+ 'uid' => $user_id,
+ ),
+ $redirect_to
+ );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Case where the recipient is not a member of the site.
+ } else if ( ! empty( $args['email_address'] ) ) {
+ $email_address = $args['email_address'];
+ $member_id = (int) $args['member_id'];
+ $link = add_query_arg(
+ array(
+ 'action' => 'unsubscribe',
+ 'nh' => hash_hmac( 'sha1', "{$email_type}:{$email_address}", bp_email_get_salt() ),
+ 'nt' => $args['notification_type'],
+ 'mid' => $member_id,
+ 'uem' => $email_address,
+ ),
+ $redirect_to
+ );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Filters the unsubscribe link.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -4361,6 +4420,24 @@
</span><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"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Check an email address to see if that individual has opted out.
+ *
+ * @since 8.0.0
+ *
+ * @param string $email_address Email address to check.
+ * @return bool True if the user has opted out, false otherwise.
+ */
+function bp_user_has_opted_out( $email_address = '' ) {
+ $optout_class = new BP_Optout();
+ $optout_id = $optout_class->optout_exists(
+ array(
+ 'email_address' => $email_address,
+ )
+ );
+ return (bool) $optout_id;
+}
+
+/**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Delete a BP_Optout by ID.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 8.0.0
</span></span></pre>
</div>
</div>
</body>
</html>