Changeset 7570 for trunk/bp-activity/bp-activity-functions.php

Timestamp:

11/14/2013 03:43:43 PM (13 years ago)

Author:

boonebgorges

Message:

Remove BuddyPress's restriction spaces in user_login

BuddyPress has historically enforced a no-spaces rule on user_login during
user registration. Originally this was rooted in WPMU's own peculiar character
restrictions, and when the MU requirement was dropped, the same restrictions
were carried over to WordPress Single.

However, these restrictions have caused various problems. BP enforced the "no
spaces" rule during registration by simply swapping out spaces with hyphens and
not telling users. This caused immense confusion. Moreover, the restriction
caused problems when bypassing BP's native user registration, as when
integrating with an external authentication service; these external usernames
*can* sometimes have spaces, and certain areas of BuddyPress were not equipped
to deal with them.

This changeset removes the no-spaces restriction from BuddyPress, and hands
off user_login validation to WordPress Multisite when possible (meaning that on
MS, spaces will still not be allowed during native registration). It also
makes the necessary adjustments throughout BuddyPress to ensure that spaces
in user_login will not break related functionality. On a normal setup, BP (and
WP) only use user_login for authentication, but several changes were necessary
to account for "username compatibility mode", where the user_login is displayed
publicly:

• Refactor the way that activity @-mentions work in username compatibility mode. We now have functions for converting user IDs to "mentionname" (and vice versa) which will produce @-mention-safe versions of user_nicename or user_login, as appropriate.
• Use proper URL encoding when building and parsing URLs that contain usernames when compatibility mode is enabled.
• Fix private messaging autocomplete to work with spaces.

See #4622

Fixes #5185

File:

• trunk/bp-activity/bp-activity-functions.php (modified) (2 diffs)

trunk/bp-activity/bp-activity-functions.php

@@ -73 +73 @@
     // We've found some mentions! Check to see if users exist
     foreach( (array) $usernames as $key => $username ) {
-        if ( bp_is_username_compatibility_mode() ) {
-            $user_id = username_exists( $username );
-        } else {
-            $user_id = bp_core_get_userid_from_nicename( $username );
-        }
+        $user_id = bp_activity_get_userid_from_mentionname( $username );
 
         // user ID exists, so let's add it to our array
@@ -246 +242 @@
 
     return $return;
+}
+
+/**
+ * Determine a user's "mentionname", the name used for that user in @-mentions.
+ *
+ * @since BuddyPress (1.9.0)
+ *
+ * @return string User name appropriate for @-mentions.
+ */
+function bp_activity_get_user_mentionname( $user_id ) {
+    $mentionname = '';
+
+    $userdata = bp_core_get_core_userdata( $user_id );
+
+    if ( $userdata ) {
+        if ( bp_is_username_compatibility_mode() ) {
+            $mentionname = str_replace( ' ', '-', $userdata->user_login );
+        } else {
+            $mentionname = $userdata->user_nicename;
+        }
+    }
+
+    return $mentionname;
+}
+
+/**
+ * Get a user ID from a "mentionname", the name used for a user in @-mentions.
+ *
+ * @since BuddyPress (1.9.0)
+ *
+ * @return int|bool ID of the user, if one is found. Otherwise false.
+ */
+function bp_activity_get_userid_from_mentionname( $mentionname ) {
+    $user_id = false;
+
+    // In username compatibility mode, hyphens are ambiguous between
+    // actual hyphens and converted spaces.
+    //
+    // @todo There is the potential for username clashes between 'foo bar'
+    // and 'foo-bar' in compatibility mode. Come up with a system for
+    // unique mentionnames.
+    if ( bp_is_username_compatibility_mode() ) {
+        // First, try the raw username
+        $userdata = get_user_by( 'login', $mentionname );
+
+        // Doing a direct query to use proper regex. Necessary to
+        // account for hyphens + spaces in the same user_login.
+        if ( empty( $userdata ) || ! is_a( $userdata, 'WP_User' ) ) {
+            global $wpdb;
+            $regex   = esc_sql( str_replace( '-', '[ \-]', $mentionname ) );
+            $user_id = $wpdb->get_var( "SELECT ID FROM {$wpdb->users} WHERE user_login REGEXP '{$regex}'" );
+        } else {
+            $user_id = $userdata->ID;
+        }
+
+    // When username compatibility mode is disabled, the mentionname is
+    // the same as the nicename
+    } else {
+        $user_id = bp_core_get_userid_from_nicename( $mentionname );
+    }
+
+
+    return $user_id;
 }