Add nickname suggestion capability for use during autoregistration.

This commit is contained in:
Craig Andrews 2010-01-14 19:43:03 -05:00
parent c82c43d5ee
commit a27aef9206
2 changed files with 60 additions and 12 deletions

View File

@ -92,6 +92,19 @@ abstract class AuthenticationPlugin extends Plugin
return false; return false;
} }
/**
* Given a username, suggest what the nickname should be
* Used during autoregistration
* Useful if your usernames are ugly, and you want to suggest
* nice looking nicknames when users initially sign on
* @param username
* @return string nickname
*/
function suggestNicknameForUsername($username)
{
return $username;
}
//------------Below are the methods that connect StatusNet to the implementing Auth plugin------------\\ //------------Below are the methods that connect StatusNet to the implementing Auth plugin------------\\
function onInitializePlugin(){ function onInitializePlugin(){
if(!isset($this->provider_name)){ if(!isset($this->provider_name)){
@ -108,13 +121,25 @@ abstract class AuthenticationPlugin extends Plugin
function onAutoRegister($nickname, $provider_name, &$user) function onAutoRegister($nickname, $provider_name, &$user)
{ {
if($provider_name == $this->provider_name && $this->autoregistration){ if($provider_name == $this->provider_name && $this->autoregistration){
$user = $this->autoregister($nickname); $suggested_nickname = $this->suggestNicknameForUsername($nickname);
$test_user = User::staticGet('nickname', $suggested_nickname);
if($test_user) {
//someone already exists with the suggested nickname, so used the passed nickname
$suggested_nickname = $nickname;
}
$test_user = User::staticGet('nickname', $suggested_nickname);
if($test_user) {
//someone already exists with the suggested nickname
//not much else we can do
}else{
$user = $this->autoregister($suggested_nickname);
if($user){ if($user){
User_username::register($user,$nickname,$this->provider_name); User_username::register($user,$nickname,$this->provider_name);
return false; return false;
} }
} }
} }
}
function onStartCheckPassword($nickname, $password, &$authenticatedUser){ function onStartCheckPassword($nickname, $password, &$authenticatedUser){
//map the nickname to a username //map the nickname to a username
@ -122,23 +147,30 @@ abstract class AuthenticationPlugin extends Plugin
$user_username->username=$nickname; $user_username->username=$nickname;
$user_username->provider_name=$this->provider_name; $user_username->provider_name=$this->provider_name;
if($user_username->find() && $user_username->fetch()){ if($user_username->find() && $user_username->fetch()){
$username = $user_username->username; $authenticated = $this->checkPassword($user_username->username, $password);
$authenticated = $this->checkPassword($username, $password);
if($authenticated){ if($authenticated){
$authenticatedUser = User::staticGet('id', $user_username->user_id); $authenticatedUser = User::staticGet('id', $user_username->user_id);
return false; return false;
} }
}else{ }else{
$user = User::staticGet('nickname', $nickname); //$nickname is the username used to login
//$suggested_nickname is the nickname the auth provider suggests for that username
$suggested_nickname = $this->suggestNicknameForUsername($nickname);
$user = User::staticGet('nickname', $suggested_nickname);
if($user){ if($user){
//make sure a different provider isn't handling this nickname //make sure this user isn't claimed
$user_username = new User_username(); $user_username = new User_username();
$user_username->username=$nickname; $user_username->user_id=$user->id;
if(!$user_username->find()){ $we_can_handle = false;
//no other provider claims this username, so it's safe for us to handle it if($user_username->find()){
//either this provider, or another one, has already claimed this user
//so we cannot. Let another plugin try.
return;
}else{
//no other provider claims this user, so it's safe for us to handle it
$authenticated = $this->checkPassword($nickname, $password); $authenticated = $this->checkPassword($nickname, $password);
if($authenticated){ if($authenticated){
$authenticatedUser = User::staticGet('nickname', $nickname); $authenticatedUser = $user;
User_username::register($authenticatedUser,$nickname,$this->provider_name); User_username::register($authenticatedUser,$nickname,$this->provider_name);
return false; return false;
} }

View File

@ -154,6 +154,22 @@ class LdapAuthenticationPlugin extends AuthenticationPlugin
return false; return false;
} }
function suggestNicknameForUsername($username)
{
$entry = $this->ldap_get_user($username, $this->attributes);
if(!$entry){
//this really shouldn't happen
return $username;
}else{
$nickname = $entry->getValue($this->attributes['nickname'],'single');
if($nickname){
return $nickname;
}else{
return $username;
}
}
}
//---utility functions---// //---utility functions---//
function ldap_get_config(){ function ldap_get_config(){
$config = array(); $config = array();