/**
* Pluggable Authentication plugins base class
- *
+ *
* By default, the session cookie is used
*
*/
// get_extra_roles - add new roles not necessarily stored in the database
// restrict_roles - filter out unwanted roles
// close_auth_session - terminate an authentication session
-
+
$this->saved_user = NULL;
}
}
// Default mechanisms
-
-
+
+
/**
* Current forge user
- *
+ *
* @var object GFUser
*/
protected $saved_user;
-
+
/**
* Is there a valid session?
- *
+ *
* @param unknown_type $params
* @return FORGE_AUTH_AUTHORITATIVE_ACCEPT, FORGE_AUTH_AUTHORITATIVE_REJECT or FORGE_AUTH_NOT_AUTHORITATIVE
* TODO : document 'auth_token' param
/**
* What GFUser is logged in?
- *
+ *
* This will generate a valid forge user (by default, it was generated and cached already in saved_user)
- *
+ *
* @param unknown_type $params
* @return array $params['results'] containing user object
*/
function getExtraRoles(&$params) {
// $params['new_roles'][] = RBACEngine::getInstance()->getRoleById(123);
}
-
+
/**
* Filter out unwanted roles
* @param unknown_type $params
function restrictRoles(&$params) {
// $params['dropped_roles'][] = RBACEngine::getInstance()->getRoleById(123);
}
-
+
// Helper functions for individual plugins
// FIXME : where is $this->cookie_name set ?
protected $cookie_name;
/**
* Returns the session cookie name for the auth plugin (by default forge_session_AUTHPLUGINNAME)
- *
+ *
* @return string
*/
protected function getCookieName() {
$params['username'] = $username;
$params['event'] = 'login';
plugin_hook('sync_account_info', $params);
- $user = user_get_object_by_name($username);
+ $user = user_get_object_by_name_or_email($username);
$this->saved_user = $user;
$this->setSessionCookie();
return $user;
$events = array();
break;
}
-
+
return in_array($event, $events);
}