<!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][10332] branches/2.2: Improve sanitization of email notification settings.</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 { 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/10332">10332</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/10332","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>boonebgorges</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2015-11-11 03:35:47 +0000 (Wed, 11 Nov 2015)</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'>Improve sanitization of email notification settings.
Port of <a href="http://buddypress.trac.wordpress.org/changeset/10329">[10329]</a> to the 2.2 branch.
Props boonebgorges, johnjamesjacoby, imath, dcavins.
See <a href="http://buddypress.trac.wordpress.org/ticket/6707">#6707</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#branches22srcbpsettingsbpsettingsactionsphp">branches/2.2/src/bp-settings/bp-settings-actions.php</a></li>
<li><a href="#branches22srcbpsettingsbpsettingsfunctionsphp">branches/2.2/src/bp-settings/bp-settings-functions.php</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li>branches/2.2/tests/phpunit/testcases/settings/</li>
<li><a href="#branches22testsphpunittestcasessettingsbpSettingsSanitizeNotificationSettingsphp">branches/2.2/tests/phpunit/testcases/settings/bpSettingsSanitizeNotificationSettings.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="branches22srcbpsettingsbpsettingsactionsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: branches/2.2/src/bp-settings/bp-settings-actions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/2.2/src/bp-settings/bp-settings-actions.php 2015-11-11 03:28:49 UTC (rev 10331)
+++ branches/2.2/src/bp-settings/bp-settings-actions.php 2015-11-11 03:35:47 UTC (rev 10332)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -294,11 +294,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> check_admin_referer( 'bp_settings_notifications' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( isset( $_POST['notifications'] ) ) {
- foreach ( (array) $_POST['notifications'] as $key => $value ) {
- bp_update_user_meta( (int) bp_displayed_user_id(), $key, $value );
- }
- }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ bp_settings_update_notification_settings( bp_displayed_user_id(), (array) $_POST['notifications'] );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Switch feedback for super admins
</span><span class="cx" style="display: block; padding: 0 10px"> if ( bp_is_my_profile() ) {
</span></span></pre></div>
<a id="branches22srcbpsettingsbpsettingsfunctionsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: branches/2.2/src/bp-settings/bp-settings-functions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/2.2/src/bp-settings/bp-settings-functions.php 2015-11-11 03:28:49 UTC (rev 10331)
+++ branches/2.2/src/bp-settings/bp-settings-functions.php 2015-11-11 03:35:47 UTC (rev 10332)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -9,3 +9,97 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Exit if accessed directly
</span><span class="cx" style="display: block; padding: 0 10px"> defined( 'ABSPATH' ) || exit;
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+/**
+ * Update email notification settings for a specific user.
+ *
+ * @since 2.2.4
+ *
+ * @param int $user_id ID of the user whose settings are being updated.
+ * @param array $settings Settings array.
+ */
+function bp_settings_update_notification_settings( $user_id, $settings ) {
+ $user_id = (int) $user_id;
+
+ $settings = bp_settings_sanitize_notification_settings( $settings );
+ foreach ( $settings as $setting_key => $setting_value ) {
+ bp_update_user_meta( $user_id, $setting_key, $setting_value );
+ }
+}
+
+/**
+ * Sanitize email notification settings as submitted by a user.
+ *
+ * @since 2.2.4
+ *
+ * @param array $settings Array of settings.
+ * @return array Sanitized settings.
+ */
+function bp_settings_sanitize_notification_settings( $settings = array() ) {
+ $sanitized_settings = array();
+
+ if ( empty( $settings ) ) {
+ return $sanitized_settings;
+ }
+
+ // Get registered notification keys.
+ $registered_notification_settings = bp_settings_get_registered_notification_keys();
+
+ /*
+ * We sanitize values for core notification keys.
+ *
+ * @todo use register_meta()
+ */
+ $core_notification_settings = array(
+ 'notification_messages_new_message',
+ 'notification_activity_new_mention',
+ 'notification_activity_new_reply',
+ 'notification_groups_invite',
+ 'notification_groups_group_updated',
+ 'notification_groups_admin_promotion',
+ 'notification_groups_membership_request',
+ 'notification_membership_request_completed',
+ 'notification_friends_friendship_request',
+ 'notification_friends_friendship_accepted',
+ );
+
+ foreach ( (array) $settings as $key => $value ) {
+ // Skip if not a registered setting.
+ if ( ! in_array( $key, $registered_notification_settings, true ) ) {
+ continue;
+ }
+
+ // Force core keys to 'yes' or 'no' values.
+ if ( in_array( $key, $core_notification_settings, true ) ) {
+ $value = 'yes' === $value ? 'yes' : 'no';
+ }
+
+ $sanitized_settings[ $key ] = $value;
+ }
+
+ return $sanitized_settings;
+}
+
+/**
+ * Build a dynamic whitelist of notification keys, based on what's hooked to 'bp_notification_settings'.
+ *
+ * @since 2.2.4
+ *
+ * @return array
+ */
+function bp_settings_get_registered_notification_keys() {
+
+ ob_start();
+ do_action( 'bp_notification_settings' );
+ $screen = ob_get_clean();
+
+ $matched = preg_match_all( '/<input[^>]+name="notifications\[([^\]]+)\]/', $screen, $matches );
+
+ if ( $matched && isset( $matches[1] ) ) {
+ $key_whitelist = $matches[1];
+ } else {
+ $key_whitelist = array();
+ }
+
+ return $key_whitelist;
+}
</ins></span></pre></div>
<a id="branches22testsphpunittestcasessettingsbpSettingsSanitizeNotificationSettingsphp"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: branches/2.2/tests/phpunit/testcases/settings/bpSettingsSanitizeNotificationSettings.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/2.2/tests/phpunit/testcases/settings/bpSettingsSanitizeNotificationSettings.php (rev 0)
+++ branches/2.2/tests/phpunit/testcases/settings/bpSettingsSanitizeNotificationSettings.php 2015-11-11 03:35:47 UTC (rev 10332)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,83 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+
+/**
+ * @group settings
+ */
+class BP_Tests_Settings_BpSettingsSanitizeNotificationSettings extends BP_UnitTestCase {
+ protected $core_notification_settings = array(
+ 'notification_messages_new_message',
+ 'notification_activity_new_mention',
+ 'notification_activity_new_reply',
+ 'notification_groups_invite',
+ 'notification_groups_group_updated',
+ 'notification_groups_admin_promotion',
+ 'notification_groups_membership_request',
+ 'notification_friends_friendship_request',
+ 'notification_friends_friendship_accepted',
+ );
+
+ public function test_should_ignore_setting_not_added_via_bp_notification_settings_callback() {
+ $settings = array(
+ 'foo' => 'yes',
+ );
+
+ $sanitized = bp_settings_sanitize_notification_settings( $settings );
+
+ $this->assertArrayNotHasKey( 'foo', $sanitized );
+ }
+
+ public function test_should_accept_setting_added_via_bp_notification_settings_callback() {
+ $settings = array(
+ 'foo' => 'yes',
+ );
+
+ add_action( 'bp_notification_settings', array( $this, 'add_custom_notification_setting' ) );
+ $sanitized = bp_settings_sanitize_notification_settings( $settings );
+ remove_action( 'bp_notification_settings', array( $this, 'add_custom_notification_setting' ) );
+
+ $this->assertArrayHasKey( 'foo', $sanitized );
+ $this->assertSame( 'yes', $sanitized['foo'] );
+ }
+
+ public function test_should_sanitize_invalid_values_to_no_for_core_settings() {
+
+ $settings = array();
+ foreach ( $this->core_notification_settings as $key ) {
+ $settings[ $key ] = 'foo';
+ }
+
+ add_action( 'bp_notification_settings', array( $this, 'add_core_notification_settings' ) );
+ $sanitized = bp_settings_sanitize_notification_settings( $settings );
+ remove_action( 'bp_notification_settings', array( $this, 'add_core_notification_settings' ) );
+
+ $expected = array();
+ foreach ( $this->core_notification_settings as $key ) {
+ $expected[ $key ] = 'no';
+ }
+
+ $this->assertEqualSets( $expected, $sanitized );
+ }
+
+ public function test_should_not_sanitize_values_for_custom_setting() {
+ $settings = array(
+ 'foo' => 'bar',
+ );
+
+ add_action( 'bp_notification_settings', array( $this, 'add_custom_notification_setting' ) );
+ $sanitized = bp_settings_sanitize_notification_settings( $settings );
+ remove_action( 'bp_notification_settings', array( $this, 'add_custom_notification_setting' ) );
+
+ $this->assertArrayHasKey( 'foo', $sanitized );
+ $this->assertSame( 'bar', $sanitized['foo'] );
+ }
+
+ public function add_custom_notification_setting() {
+ echo '<input name="notifications[foo]" value="yes" />';
+ }
+
+ public function add_core_notification_settings() {
+ foreach ( $this->core_notification_settings as $key ) {
+ echo '<input name="notifications[' . $key . ']" value="yes" />';
+ }
+ }
+}
</ins></span></pre>
</div>
</div>
</body>
</html>