<!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][9879] trunk/src/bp-xprofile/classes/class-bp-xprofile-field.php: XProfile: Improve field validation in `BP_Profile_Field::admin_validate()`.</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/9879">9879</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/9879","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>johnjamesjacoby</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2015-05-19 17:02:11 +0000 (Tue, 19 May 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'>XProfile: Improve field validation in `BP_Profile_Field::admin_validate()`.
* Break inline conditions apart into multiple specific ones to improve logical flow of field validation
* Introduce more helpful `$message` feedback for each new condition, including the field-type name where possible
* Replace `empty()` checks with `! isset()` to allow "0" values as names and options
* Remove `field_file` check, as the "file" field type was removed when avatar uploads were refactored in 1.0
* Much more appropriate field-option validation using `sanitize_text_field` to
* Properly escape gettext output
* Tests introduced in <a href="http://buddypress.trac.wordpress.org/changeset/9878">r9878</a>
See <a href="http://buddypress.trac.wordpress.org/ticket/6443">#6443</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpxprofileclassesclassbpxprofilefieldphp">trunk/src/bp-xprofile/classes/class-bp-xprofile-field.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpxprofileclassesclassbpxprofilefieldphp"></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/classes/class-bp-xprofile-field.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-xprofile/classes/class-bp-xprofile-field.php 2015-05-19 16:52:49 UTC (rev 9878)
+++ trunk/src/bp-xprofile/classes/class-bp-xprofile-field.php 2015-05-19 17:02:11 UTC (rev 9879)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -588,19 +588,61 @@
</span><span class="cx" style="display: block; padding: 0 10px"> public static function admin_validate() {
</span><span class="cx" style="display: block; padding: 0 10px"> global $message;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Validate Form
- if ( empty( $_POST['title'] ) || ! isset( $_POST['required'] ) || empty( $_POST['fieldtype'] ) ) {
- $message = __( 'Please make sure you fill out all required fields.', 'buddypress' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Check field name
+ if ( ! isset( $_POST['title'] ) || ( '' === $_POST['title'] ) ) {
+ $message = esc_html__( 'Profile fields must have a name.', 'buddypress' );
</ins><span class="cx" style="display: block; padding: 0 10px"> return false;
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- } elseif ( empty( $_POST['field_file'] ) ) {
- $field_type = bp_xprofile_create_field_type( $_POST['fieldtype'] );
- $option_name = "{$_POST['fieldtype']}_option";
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Check field requirement
+ if ( ! isset( $_POST['required'] ) ) {
+ $message = esc_html__( 'Profile field requirement is missing.', 'buddypress' );
+ return false;
+ }
</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( $field_type->supports_options ) && isset( $_POST[ $option_name ] ) && empty( $_POST[ $option_name ][1] ) ) {
- $message = __( 'This field type requires at least one option. Please add options below.', 'buddypress' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Check field type
+ if ( empty( $_POST['fieldtype'] ) ) {
+ $message = esc_html__( 'Profile field type is missing.', 'buddypress' );
+ return false;
+ }
+
+ // Check that field is of valid type
+ if ( ! in_array( $_POST['fieldtype'], array_keys( bp_xprofile_get_field_types() ), true ) ) {
+ $message = sprintf( esc_html__( 'The profile field type %s is not registered.', 'buddypress' ), '<code>' . esc_attr( $_POST['fieldtype'] ) . '</code>' );
+ return false;
+ }
+
+ // Get field type so we can check for and lavidate any field options
+ $field_type = bp_xprofile_create_field_type( $_POST['fieldtype'] );
+
+ // Field type requires options
+ if ( true === $field_type->supports_options ) {
+
+ // Build the field option key
+ $option_name = sanitize_key( $_POST['fieldtype'] ) . '_option';
+
+ // Check for missing or malformed options
+ if ( empty( $_POST[ $option_name ] ) || ! is_array( $_POST[ $option_name ] ) ) {
+ $message = esc_html__( 'These field options are invalid.', 'buddypress' );
</ins><span class="cx" style="display: block; padding: 0 10px"> return false;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ // Trim out empty field options
+ $field_values = array_values( $_POST[ $option_name ] );
+ $field_options = array_map( 'sanitize_text_field', $field_values );
+ $field_count = count( $field_options );
+
+ // Check for missing or malformed options
+ if ( 0 === $field_count ) {
+ $message = sprintf( esc_html__( '%s require at least one option.', 'buddypress' ), $field_type->name );
+ return false;
+ }
+
+ // If only one option exists, it cannot be an empty string
+ if ( ( 1 === $field_count ) && ( '' === $field_options[0] ) ) {
+ $message = sprintf( esc_html__( '%s require at least one option.', 'buddypress' ), $field_type->name );
+ return false;
+ }
</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 true;
</span></span></pre>
</div>
</div>
</body>
</html>