<!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][9711] trunk: Improve parameter sanitization in `xprofile_insert_field()`.</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/9711">9711</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/9711","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-04-07 00:54:07 +0000 (Tue, 07 Apr 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 parameter sanitization in `xprofile_insert_field()`.
The overzealous `empty()` checks meant that it was impossible to set certain
values on existing fields to falsey values.
Fixes <a href="http://buddypress.trac.wordpress.org/ticket/6354">#6354</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpxprofilebpxprofilefunctionsphp">trunk/src/bp-xprofile/bp-xprofile-functions.php</a></li>
<li><a href="#trunktestsphpunittestcasesxprofilefunctionsphp">trunk/tests/phpunit/testcases/xprofile/functions.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpxprofilebpxprofilefunctionsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-xprofile/bp-xprofile-functions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-xprofile/bp-xprofile-functions.php 2015-04-07 00:38:10 UTC (rev 9710)
+++ trunk/src/bp-xprofile/bp-xprofile-functions.php 2015-04-07 00:54:07 UTC (rev 9711)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -230,6 +230,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'order_by' => '',
</span><span class="cx" style="display: block; padding: 0 10px"> 'is_default_option' => false,
</span><span class="cx" style="display: block; padding: 0 10px"> 'option_order' => null,
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'field_order' => null,
</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"> // field_group_id is required
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -237,7 +238,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return false;
</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">- // Check this is a valid field type
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Check this is a non-empty, valid field type.
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( ! in_array( $r['type'], (array) buddypress()->profile->field_types ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return false;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -250,45 +251,22 @@
</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"> $field->group_id = $r['field_group_id'];
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $field->type = $r['type'];
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( ! empty( $r['parent_id'] ) ) {
- $field->parent_id = $r['parent_id'];
- }
-
- if ( ! empty( $r['type'] ) ) {
- $field->type = $r['type'];
- }
-
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // The 'name' field cannot be empty.
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( ! empty( $r['name'] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $field->name = $r['name'];
</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">- if ( ! empty( $r['description'] ) ) {
- $field->description = $r['description'];
- }
-
- if ( ! empty( $r['is_required'] ) ) {
- $field->is_required = $r['is_required'];
- }
-
- if ( ! empty( $r['can_delete'] ) ) {
- $field->can_delete = $r['can_delete'];
- }
-
- if ( ! empty( $r['field_order'] ) ) {
- $field->field_order = $r['field_order'];
- }
-
- if ( ! empty( $r['order_by'] ) ) {
- $field->order_by = $r['order_by'];
- }
-
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $field->description = $r['description'];
+ $field->order_by = $r['order_by'];
+ $field->parent_id = (int) $r['parent_id'];
+ $field->field_order = (int) $r['field_order'];
+ $field->option_order = (int) $r['option_order'];
+ $field->is_required = (bool) $r['is_required'];
+ $field->can_delete = (bool) $r['can_delete'];
</ins><span class="cx" style="display: block; padding: 0 10px"> $field->is_default_option = (bool) $r['is_default_option'];
</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 ( ! empty( $r['option_order'] ) ) {
- $field->option_order = $r['option_order'];
- }
-
</del><span class="cx" style="display: block; padding: 0 10px"> return $field->save();
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre></div>
<a id="trunktestsphpunittestcasesxprofilefunctionsphp"></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/xprofile/functions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/testcases/xprofile/functions.php 2015-04-07 00:38:10 UTC (rev 9710)
+++ trunk/tests/phpunit/testcases/xprofile/functions.php 2015-04-07 00:54:07 UTC (rev 9711)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -645,7 +645,66 @@
</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"> * @group xprofile_insert_field
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @ticket BP6354
</ins><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_xprofile_insert_field_should_process_falsey_values_for_boolean_params_on_existing_fields() {
+ $g = $this->factory->xprofile_group->create();
+ $f = xprofile_insert_field( array(
+ 'field_group_id' => $g,
+ 'type' => 'textbox',
+ 'name' => 'Foo',
+ 'is_required' => true,
+ 'can_delete' => true,
+ 'is_default_option' => true,
+ 'parent_id' => 13,
+ 'field_order' => 5,
+ 'option_order' => 8,
+ 'description' => 'foo',
+ 'order_by' => 'custom',
+ ) );
+
+ $this->assertNotEmpty( $f );
+
+ $field = new BP_XProfile_Field( $f );
+ $this->assertEquals( 1, $field->is_required );
+ $this->assertEquals( 1, $field->can_delete );
+ $this->assertEquals( 1, $field->is_default_option );
+ $this->assertEquals( 13, $field->parent_id );
+ $this->assertEquals( 5, $field->field_order );
+ $this->assertEquals( 8, $field->option_order );
+ $this->assertEquals( 'foo', $field->description );
+ $this->assertEquals( 'custom', $field->order_by );
+
+ $f = xprofile_insert_field( array(
+ 'field_group_id' => $g,
+ 'type' => 'textbox',
+ 'name' => 'Foo',
+ 'is_required' => false,
+ 'can_delete' => false,
+ 'is_default_option' => false,
+ 'parent_id' => 0,
+ 'field_order' => 0,
+ 'option_order' => 0,
+ 'description' => '',
+ 'order_by' => '',
+ ) );
+
+ $this->assertNotEmpty( $f );
+
+ $field = new BP_XProfile_Field( $f );
+ $this->assertEquals( 0, $field->is_required );
+ $this->assertEquals( 0, $field->can_delete );
+ $this->assertEquals( 0, $field->is_default_option );
+ $this->assertEquals( 0, $field->parent_id );
+ $this->assertEquals( 0, $field->field_order );
+ $this->assertEquals( 0, $field->option_order );
+ $this->assertEquals( '', $field->description );
+ $this->assertEquals( '', $field->order_by );
+ }
+
+ /**
+ * @group xprofile_insert_field
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> public function test_xprofile_insert_field_type_option_option_order() {
</span><span class="cx" style="display: block; padding: 0 10px"> $g = $this->factory->xprofile_group->create();
</span><span class="cx" style="display: block; padding: 0 10px"> $parent = $this->factory->xprofile_field->create( array(
</span></span></pre>
</div>
</div>
</body>
</html>