<!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][6072] trunk/bp-members/bp-members-functions.php: Cleans up the authentication checks for spammers and inactive users</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, #logmsg > ol { margin-left: 0; 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/6072">6072</a></dd>
<dt>Author</dt> <dd>boonebgorges</dd>
<dt>Date</dt> <dd>2012-06-11 21:20:17 +0000 (Mon, 11 Jun 2012)</dd>
</dl>
<h3>Log Message</h3>
<pre>Cleans up the authentication checks for spammers and inactive users
* Saves a lookup by examining the $auth_obj passed from the 'authenticate' hook
instead of looking the user up by $username, in both bp_core_boot_spammer()
and bp_core_signup_disable_inactive()
* Updates documentation for the relevant functions
Fixes <a href="http://buddypress.trac.wordpress.org/ticket/4245">#4245</a>
Props r-a-y</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkbpmembersbpmembersfunctionsphp">trunk/bp-members/bp-members-functions.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkbpmembersbpmembersfunctionsphp"></a>
<div class="modfile"><h4>Modified: trunk/bp-members/bp-members-functions.php (6071 => 6072)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/bp-members/bp-members-functions.php 2012-06-09 15:36:12 UTC (rev 6071)
+++ trunk/bp-members/bp-members-functions.php 2012-06-11 21:20:17 UTC (rev 6072)
</span><span class="lines">@@ -846,24 +846,25 @@
</span><span class="cx"> * When a user logs in, check if they have been marked as a spammer. If yes then simply
</span><span class="cx"> * redirect them to the home page and stop them from logging in.
</span><span class="cx"> *
</span><del>- * @package BuddyPress Core
- * @param $auth_obj The WP authorization object
- * @param $username The username of the user logging in.
- * @uses get_user_by() Get the userdata object for a user based on their username
- * @uses bp_core_redirect() Safe redirect to a page
- * @return $auth_obj If the user is not a spammer, return the authorization object
</del><ins>+ * @param obj $user Either the WP_User object or the WP_Error object
+ * @return obj If the user is not a spammer, return the WP_User object. Otherwise a new WP_Error object.
+ *
+ * @since 1.1.2
</ins><span class="cx"> */
</span><del>-function bp_core_boot_spammer( $auth_obj, $username ) {
</del><ins>+function bp_core_boot_spammer( $user ) {
+ // check to see if the $user has already failed logging in, if so return $user as-is
+ if ( is_wp_error( $user ) || empty( $user ) )
+ return $user;
</ins><span class="cx">
</span><del>- if ( !$user = get_user_by( 'login', $username ) )
- return $auth_obj;
</del><ins>+ // the user exists; now do a check to see if the user is a spammer
+ // if the user is a spammer, stop them in their tracks!
+ if ( is_a( $user, 'WP_User' ) && ( ( is_multisite() && (int) $user->spam ) || 1 == $user->user_status ) )
+ return new WP_Error( 'invalid_username', __( '<strong>ERROR</strong>: Your account has been marked as a spammer.', 'buddypress' ) );
</ins><span class="cx">
</span><del>- if ( ( is_multisite() && (int) $user->spam ) || 1 == (int) $user->user_status )
- return new WP_Error( 'invalid_username', __( '<strong>ERROR</strong>: Your account has been marked as a spammer.', 'buddypress' ) );
- else
- return $auth_obj;
</del><ins>+ // user is good to go!
+ return $user;
</ins><span class="cx"> }
</span><del>-add_filter( 'authenticate', 'bp_core_boot_spammer', 30, 2 );
</del><ins>+add_filter( 'authenticate', 'bp_core_boot_spammer', 30 );
</ins><span class="cx">
</span><span class="cx"> /**
</span><span class="cx"> * Deletes usermeta for the user when the user is deleted.
</span><span class="lines">@@ -1271,23 +1272,37 @@
</span><span class="cx"> do_action( 'bp_core_sent_user_validation_email', $subject, $message, $user_id, $user_email, $key );
</span><span class="cx"> }
</span><span class="cx">
</span><del>-// Stop user accounts logging in that have not been activated (user_status = 2)
-function bp_core_signup_disable_inactive( $auth_obj, $username ) {
- global $wpdb;
</del><ins>+/**
+ * Stop user accounts logging in that have not been activated yet (user_status = 2).
+ *
+ * Note: This is only applicable for single site WordPress installs.
+ * Multisite has their own DB table - 'wp_signups' - dedicated for unactivated users.
+ * See {@link wpmu_signup_user()} and {@link wpmu_validate_user_signup()}.
+ *
+ * @param obj $user Either the WP_User object or the WP_Error object
+ * @return obj If the user is not a spammer, return the WP_User object. Otherwise a new WP_Error object.
+ *
+ * @since 1.2.2
+ */
+function bp_core_signup_disable_inactive( $user ) {
+ // check to see if the $user has already failed logging in, if so return $user as-is
+ if ( is_wp_error( $user ) || empty( $user ) )
+ return $user;
</ins><span class="cx">
</span><del>- if ( !$user_id = bp_core_get_userid( $username ) )
- return $auth_obj;
</del><ins>+ // the user exists; now do a check to see if the user has activated their account or not
+ // NOTE: this is only applicable for single site WordPress installs!
+ // if unactivated, stop the login now!
+ if ( is_a( $user, 'WP_User' ) && 2 == $user->user_status )
+ return new WP_Error( 'bp_account_not_activated', __( '<strong>ERROR</strong>: Your account has not been activated. Check your email for the activation link.', 'buddypress' ) );
</ins><span class="cx">
</span><del>- $user_status = (int) $wpdb->get_var( $wpdb->prepare( "SELECT user_status FROM $wpdb->users WHERE ID = %d", $user_id ) );
-
- if ( 2 == $user_status )
- return new WP_Error( 'bp_account_not_activated', __( '<strong>ERROR</strong>: Your account has not been activated. Check your email for the activation link.', 'buddypress' ) );
- else
- return $auth_obj;
</del><ins>+ // user has activated their account! all clear!
+ return $user;
</ins><span class="cx"> }
</span><del>-add_filter( 'authenticate', 'bp_core_signup_disable_inactive', 30, 2 );
</del><ins>+add_filter( 'authenticate', 'bp_core_signup_disable_inactive', 30 );
</ins><span class="cx">
</span><del>-// Kill the wp-signup.php if custom registration signup templates are present
</del><ins>+/**
+ * Kill the wp-signup.php if custom registration signup templates are present
+ */
</ins><span class="cx"> function bp_core_wpsignup_redirect() {
</span><span class="cx"> $action = !empty( $_GET['action'] ) ? $_GET['action'] : '';
</span><span class="cx">
</span></span></pre>
</div>
</div>
</body>
</html>