<!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][8672] trunk/src/bp-xprofile: Introduce BP_XProfile_Field_Type::pre_validate_filter(), and use in URL field type</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/8672">8672</a></dd>
<dt>Author</dt> <dd>boonebgorges</dd>
<dt>Date</dt> <dd>2014-07-23 13:42:48 +0000 (Wed, 23 Jul 2014)</dd>
</dl>
<h3>Log Message</h3>
<pre>Introduce BP_XProfile_Field_Type::pre_validate_filter(), and use in URL field type
The pre_validate_filter() method allows field types to intercept field values,
before they are run through the is_valid() validation routine, and optionally
modify them.
BP_XProfile_Field_Type_URL uses this filter to silently add the 'http://'
protocol to submitted values before run through the validation regex (which
requires the protocol). The result is a smoother UX, as users are not required
to enter the protocol in order to have their field value saved.
To make it possible for protocol-less values to be submitted on the profile
edit form, the 'type' attribute of the URL field was changed from 'url' to
'text' (with a 'url' inputtype). With 'type=url', modern browsers require a
fully-qualified URL before allowing the form to be submitted.
Fixes <a href="http://buddypress.trac.wordpress.org/ticket/5501">#5501</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpxprofilebpxprofileclassesphp">trunk/src/bp-xprofile/bp-xprofile-classes.php</a></li>
<li><a href="#trunksrcbpxprofilebpxprofilefiltersphp">trunk/src/bp-xprofile/bp-xprofile-filters.php</a></li>
<li><a href="#trunksrcbpxprofilebpxprofilefunctionsphp">trunk/src/bp-xprofile/bp-xprofile-functions.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpxprofilebpxprofileclassesphp"></a>
<div class="modfile"><h4>Modified: trunk/src/bp-xprofile/bp-xprofile-classes.php (8671 => 8672)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/bp-xprofile/bp-xprofile-classes.php 2014-07-23 13:42:44 UTC (rev 8671)
+++ trunk/src/bp-xprofile/bp-xprofile-classes.php 2014-07-23 13:42:48 UTC (rev 8672)
</span><span class="lines">@@ -2645,8 +2645,9 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> $r = bp_parse_args( $raw_properties, array(
</span><del>- 'type' => 'url',
- 'value' => esc_url( bp_get_the_profile_field_edit_value() ),
</del><ins>+ 'type' => 'text',
+ 'inputmode' => 'url',
+ 'value' => esc_url( bp_get_the_profile_field_edit_value() ),
</ins><span class="cx"> ) ); ?>
</span><span class="cx">
</span><span class="cx"> <label for="<?php bp_the_profile_field_input_name(); ?>">
</span><span class="lines">@@ -2693,6 +2694,33 @@
</span><span class="cx"> public function admin_new_field_html( BP_XProfile_Field $current_field, $control_type = '' ) {}
</span><span class="cx">
</span><span class="cx"> /**
</span><ins>+ * Modify submitted URL values before validation.
+ *
+ * The URL validation regex requires a http(s) protocol, so that all
+ * values saved in the database are fully-formed URLs. However, we
+ * still want to allow users to enter URLs without a protocol, for a
+ * better user experience. So we catch submitted URL values, and if
+ * the protocol is missing, we prepend 'http://' before passing to
+ * is_valid().
+ *
+ * @since BuddyPress (2.1.0)
+ *
+ * @param string $submitted_value Raw value submitted by the user.
+ * @return string
+ */
+ public static function pre_validate_filter( $submitted_value ) {
+ if ( false === strpos( $submitted_value, ':' )
+ && substr( $submitted_value, 0, 1 ) !== '/'
+ && substr( $submitted_value, 0, 1 ) !== '#'
+ && ! preg_match( '/^[a-z0-9-]+?\.php/i', $submitted_value )
+ ) {
+ $submitted_value = 'http://' . $submitted_value;
+ }
+
+ return $submitted_value;
+ }
+
+ /**
</ins><span class="cx"> * Format URL values for display.
</span><span class="cx"> *
</span><span class="cx"> * @since BuddyPress (2.1.0)
</span><span class="lines">@@ -3064,6 +3092,30 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><ins>+ * Allow field types to modify submitted values before they are validated.
+ *
+ * In some cases, it may be appropriate for a field type to catch
+ * submitted values and modify them before they are passed to the
+ * is_valid() method. For example, URL validation requires the
+ * 'http://' scheme (so that the value saved in the database is always
+ * a fully-formed URL), but in order to allow users to enter a URL
+ * without this scheme, BP_XProfile_Field_Type_URL prepends 'http://'
+ * when it's not present.
+ *
+ * By default, this is a pass-through method that does nothing. Only
+ * override in your own field type if you need this kind of pre-
+ * validation filtering.
+ *
+ * @since BuddyPress (2.1.0)
+ *
+ * @param mixed $submitted_value Submitted value.
+ * @return mixed
+ */
+ public static function pre_validate_filter( $field_value ) {
+ return $field_value;
+ }
+
+ /**
</ins><span class="cx"> * Allow field types to modify the appearance of their values.
</span><span class="cx"> *
</span><span class="cx"> * By default, this is a pass-through method that does nothing. Only
</span></span></pre></div>
<a id="trunksrcbpxprofilebpxprofilefiltersphp"></a>
<div class="modfile"><h4>Modified: trunk/src/bp-xprofile/bp-xprofile-filters.php (8671 => 8672)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/bp-xprofile/bp-xprofile-filters.php 2014-07-23 13:42:44 UTC (rev 8671)
+++ trunk/src/bp-xprofile/bp-xprofile-filters.php 2014-07-23 13:42:48 UTC (rev 8672)
</span><span class="lines">@@ -51,6 +51,7 @@
</span><span class="cx"> add_filter( 'xprofile_get_field_data', 'stripslashes' );
</span><span class="cx"> add_filter( 'xprofile_get_field_data', 'xprofile_filter_format_field_value_by_field_id', 5, 2 );
</span><span class="cx">
</span><ins>+add_filter( 'bp_xprofile_set_field_data_pre_validate', 'xprofile_filter_pre_validate_value_by_field_type', 10, 3 );
</ins><span class="cx"> add_filter( 'xprofile_data_value_before_save', 'xprofile_sanitize_data_value_before_save', 1, 4 );
</span><span class="cx"> add_filter( 'xprofile_filtered_data_value_before_save', 'trim', 2 );
</span><span class="cx">
</span><span class="lines">@@ -177,6 +178,25 @@
</span><span class="cx"> return xprofile_filter_format_field_value_by_type( $field_value, $field->type );
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+/**
+ * Apply pre_validate_filter() filters as defined by the BP_XProfile_Field_Type classes before validating.
+ *
+ * @since BuddyPress (2.1.0)
+ *
+ * @param mixed $value Value passed to the bp_xprofile_set_field_data_pre_validate
+ * filter.
+ * @param BP_XProfile_Field $field Field object.
+ * @param BP_XProfile_Field_Type Field type object.
+ * @return mixed
+ */
+function xprofile_filter_pre_validate_value_by_field_type( $value, $field, $field_type_obj ) {
+ if ( method_exists( $field_type_obj, 'pre_validate_filter' ) ) {
+ $value = call_user_func( array( $field_type_obj, 'pre_validate_filter' ), $value );
+ }
+
+ return $value;
+}
+
</ins><span class="cx"> function xprofile_filter_link_profile_data( $field_value, $field_type = 'textbox' ) {
</span><span class="cx">
</span><span class="cx"> if ( 'datebox' === $field_type ) {
</span></span></pre></div>
<a id="trunksrcbpxprofilebpxprofilefunctionsphp"></a>
<div class="modfile"><h4>Modified: trunk/src/bp-xprofile/bp-xprofile-functions.php (8671 => 8672)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/bp-xprofile/bp-xprofile-functions.php 2014-07-23 13:42:44 UTC (rev 8671)
+++ trunk/src/bp-xprofile/bp-xprofile-functions.php 2014-07-23 13:42:48 UTC (rev 8672)
</span><span class="lines">@@ -293,15 +293,29 @@
</span><span class="cx"> if ( empty( $field_id ) )
</span><span class="cx"> return false;
</span><span class="cx">
</span><ins>+ $field = new BP_XProfile_Field( $field_id );
+ $field_type = BP_XProfile_Field::get_type( $field_id );
+ $field_type_obj = bp_xprofile_create_field_type( $field_type );
+
+ /**
+ * Filter the raw submitted profile field value.
+ *
+ * Use this filter to modify the values submitted by users before
+ * doing field-type-specific validation.
+ *
+ * @since BuddyPress (2.1.0)
+ *
+ * @param mixed $value Value passed to xprofile_set_field_data()
+ * @param BP_XProfile_Field $field Field object.
+ * @param BP_XProfile_Field_Type $field_type_obj Field type object.
+ */
+ $value = apply_filters( 'bp_xprofile_set_field_data_pre_validate', $value, $field, $field_type_obj );
+
</ins><span class="cx"> // Special-case support for integer 0 for the number field type
</span><span class="cx"> if ( $is_required && ! is_integer( $value ) && $value !== '0' && ( empty( $value ) || ! is_array( $value ) && ! strlen( trim( $value ) ) ) ) {
</span><span class="cx"> return false;
</span><span class="cx"> }
</span><span class="cx">
</span><del>- $field = new BP_XProfile_Field( $field_id );
- $field_type = BP_XProfile_Field::get_type( $field_id );
- $field_type_obj = bp_xprofile_create_field_type( $field_type );
-
</del><span class="cx"> /**
</span><span class="cx"> * Certain types of fields (checkboxes, multiselects) may come through empty.
</span><span class="cx"> * Save as empty array so this isn't overwritten by the default on next edit.
</span></span></pre>
</div>
</div>
</body>
</html>