<!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][7469] trunk: Sanitize more gently in component *_update_meta() functions</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">
<dt>Revision</dt> <dd><a href="http://buddypress.trac.wordpress.org/changeset/7469">7469</a></dd>
<dt>Author</dt> <dd>boonebgorges</dd>
<dt>Date</dt> <dd>2013-10-23 18:47:16 +0000 (Wed, 23 Oct 2013)</dd>
</dl>
<h3>Log Message</h3>
<pre>Sanitize more gently in component *_update_meta() functions
Previous sanitization techniques resulted in double-sanitization. Recent
changes in how WP's SQL sanitization routines work have surfaced this problem,
in particular as regards line breaks. By removing the extraneous call to
esc_sql(), we ensure that line breaks are preserved, and sanitization is left
to $wpdb->prepare().
Change applied in update_meta() functions through bp-groups, bp-activity, and
bp-xprofile. Also adds corresponding unit tests.
Fixes <a href="http://buddypress.trac.wordpress.org/ticket/5180">#5180</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkbpactivitybpactivityfunctionsphp">trunk/bp-activity/bp-activity-functions.php</a></li>
<li><a href="#trunkbpgroupsbpgroupsfunctionsphp">trunk/bp-groups/bp-groups-functions.php</a></li>
<li><a href="#trunkbpxprofilebpxprofilefunctionsphp">trunk/bp-xprofile/bp-xprofile-functions.php</a></li>
<li><a href="#trunkteststestcasesactivityfunctionsphp">trunk/tests/testcases/activity/functions.php</a></li>
<li><a href="#trunkteststestcasesgroupsfunctionsphp">trunk/tests/testcases/groups/functions.php</a></li>
<li><a href="#trunkteststestcasesxprofilefunctionsphp">trunk/tests/testcases/xprofile/functions.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkbpactivitybpactivityfunctionsphp"></a>
<div class="modfile"><h4>Modified: trunk/bp-activity/bp-activity-functions.php (7468 => 7469)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/bp-activity/bp-activity-functions.php 2013-10-23 18:47:12 UTC (rev 7468)
+++ trunk/bp-activity/bp-activity-functions.php 2013-10-23 18:47:16 UTC (rev 7469)
</span><span class="lines">@@ -680,8 +680,9 @@
</span><span class="cx"> $meta_key = preg_replace( '|[^a-z0-9_]|i', '', $meta_key );
</span><span class="cx">
</span><span class="cx"> // Sanitize value
</span><del>- if ( is_string( $meta_value ) )
- $meta_value = stripslashes( esc_sql( $meta_value ) );
</del><ins>+ if ( is_string( $meta_value ) ) {
+ $meta_value = stripslashes( $meta_value );
+ }
</ins><span class="cx">
</span><span class="cx"> // Maybe, just maybe... serialize
</span><span class="cx"> $meta_value = maybe_serialize( $meta_value );
</span></span></pre></div>
<a id="trunkbpgroupsbpgroupsfunctionsphp"></a>
<div class="modfile"><h4>Modified: trunk/bp-groups/bp-groups-functions.php (7468 => 7469)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/bp-groups/bp-groups-functions.php 2013-10-23 18:47:12 UTC (rev 7468)
+++ trunk/bp-groups/bp-groups-functions.php 2013-10-23 18:47:16 UTC (rev 7469)
</span><span class="lines">@@ -1055,8 +1055,9 @@
</span><span class="cx">
</span><span class="cx"> $meta_key = preg_replace( '|[^a-z0-9_]|i', '', $meta_key );
</span><span class="cx">
</span><del>- if ( is_string( $meta_value ) )
- $meta_value = stripslashes( esc_sql( $meta_value ) );
</del><ins>+ if ( is_string( $meta_value ) ) {
+ $meta_value = stripslashes( $meta_value );
+ }
</ins><span class="cx">
</span><span class="cx"> $meta_value = maybe_serialize( $meta_value );
</span><span class="cx">
</span></span></pre></div>
<a id="trunkbpxprofilebpxprofilefunctionsphp"></a>
<div class="modfile"><h4>Modified: trunk/bp-xprofile/bp-xprofile-functions.php (7468 => 7469)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/bp-xprofile/bp-xprofile-functions.php 2013-10-23 18:47:12 UTC (rev 7468)
+++ trunk/bp-xprofile/bp-xprofile-functions.php 2013-10-23 18:47:16 UTC (rev 7469)
</span><span class="lines">@@ -588,8 +588,9 @@
</span><span class="cx">
</span><span class="cx"> $meta_key = preg_replace( '|[^a-z0-9_]|i', '', $meta_key );
</span><span class="cx">
</span><del>- if ( is_string( $meta_value ) )
- $meta_value = stripslashes( esc_sql( $meta_value ) );
</del><ins>+ if ( is_string( $meta_value ) ) {
+ $meta_value = stripslashes( $meta_value );
+ }
</ins><span class="cx">
</span><span class="cx"> $meta_value = maybe_serialize( $meta_value );
</span><span class="cx">
</span></span></pre></div>
<a id="trunkteststestcasesactivityfunctionsphp"></a>
<div class="modfile"><h4>Modified: trunk/tests/testcases/activity/functions.php (7468 => 7469)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/tests/testcases/activity/functions.php 2013-10-23 18:47:12 UTC (rev 7468)
+++ trunk/tests/testcases/activity/functions.php 2013-10-23 18:47:16 UTC (rev 7469)
</span><span class="lines">@@ -86,4 +86,18 @@
</span><span class="cx"> $this->assertEquals( false, $m2 );
</span><span class="cx"> $this->assertEquals( false, $m3 );
</span><span class="cx"> }
</span><ins>+
+ /**
+ * @group bp_activity_update_meta
+ * @ticket BP5180
+ */
+ public function test_bp_activity_update_meta_with_line_breaks() {
+ $a = $this->factory->activity->create();
+ $meta_value = 'Foo!
+
+
+Bar!';
+ bp_activity_update_meta( $a, 'linebreak_test', $meta_value );
+ $this->assertEquals( $meta_value, bp_activity_get_meta( $a, 'linebreak_test' ) );
+ }
</ins><span class="cx"> }
</span></span></pre></div>
<a id="trunkteststestcasesgroupsfunctionsphp"></a>
<div class="modfile"><h4>Modified: trunk/tests/testcases/groups/functions.php (7468 => 7469)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/tests/testcases/groups/functions.php 2013-10-23 18:47:12 UTC (rev 7468)
+++ trunk/tests/testcases/groups/functions.php 2013-10-23 18:47:16 UTC (rev 7469)
</span><span class="lines">@@ -269,4 +269,18 @@
</span><span class="cx">
</span><span class="cx"> $this->assertEquals( 1, groups_get_groupmeta( $g, 'total_member_count' ) );
</span><span class="cx"> }
</span><ins>+
+ /**
+ * @group groupmeta
+ * @ticket BP5180
+ */
+ public function test_groups_update_groupmeta_with_line_breaks() {
+ $g = $this->factory->group->create();
+ $meta_value = 'Foo!
+
+Bar!';
+ groups_update_groupmeta( $g, 'linebreak_test', $meta_value );
+
+ $this->assertEquals( $meta_value, groups_get_groupmeta( $g, 'linebreak_test' ) );
+ }
</ins><span class="cx"> }
</span></span></pre></div>
<a id="trunkteststestcasesxprofilefunctionsphp"></a>
<div class="modfile"><h4>Modified: trunk/tests/testcases/xprofile/functions.php (7468 => 7469)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/tests/testcases/xprofile/functions.php 2013-10-23 18:47:12 UTC (rev 7468)
+++ trunk/tests/testcases/xprofile/functions.php 2013-10-23 18:47:16 UTC (rev 7469)
</span><span class="lines">@@ -62,4 +62,22 @@
</span><span class="cx"> $this->revoke_bp_moderate( $cuser );
</span><span class="cx"> $this->set_current_user( $old_current_user );
</span><span class="cx"> }
</span><ins>+
+ /**
+ * @group bp_xprofile_update_meta
+ * @ticket BP5180
+ */
+ public function test_bp_xprofile_update_meta_with_line_breaks() {
+ $g = $this->factory->xprofile_group->create();
+ $f = $this->factory->xprofile_field->create( array(
+ 'field_group_id' => $g->id,
+ 'type' => 'textbox',
+ ) );
+
+ $meta_value = 'Foo!
+
+Bar!';
+ bp_xprofile_update_meta( $f->id, 'field', 'linebreak_field', $meta_value );
+ $this->assertEquals( $meta_value, bp_xprofile_get_meta( $f->id, 'field', 'linebreak_field' ) );
+ }
</ins><span class="cx"> }
</span></span></pre>
</div>
</div>
</body>
</html>