* Authentication plugin interface
*
* Copyright © 2004 Brion Vibber <brion@pobox.com>
- * http://www.mediawiki.org/
+ * https://www.mediawiki.org/
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* accounts authenticate externally, or use it only as a fallback; also
* you can transparently create internal wiki accounts the first time
* someone logs in who can be authenticated externally.
+ *
+ * @deprecated since 1.27
*/
class AuthPlugin {
+ /**
+ * @var string
+ */
+ protected $domain;
+
/**
* Check whether there exists a user account with the given name.
* The name will be normalized to MediaWiki's requirements, so
* you might need to munge it (for instance, for lowercase initial
* letters).
*
- * @param $username String: username.
+ * @param string $username Username.
* @return bool
*/
public function userExists( $username ) {
* you might need to munge it (for instance, for lowercase initial
* letters).
*
- * @param $username String: username.
- * @param $password String: user password.
+ * @param string $username Username.
+ * @param string $password User password.
* @return bool
*/
public function authenticate( $username, $password ) {
/**
* Modify options in the login template.
*
- * @param $template UserLoginTemplate object.
- * @param $type String 'signup' or 'login'.
+ * @param BaseTemplate &$template
+ * @param string &$type 'signup' or 'login'. Added in 1.16.
*/
public function modifyUITemplate( &$template, &$type ) {
# Override this!
/**
* Set the domain this plugin is supposed to use when authenticating.
*
- * @param $domain String: authentication domain.
+ * @param string $domain Authentication domain.
*/
public function setDomain( $domain ) {
$this->domain = $domain;
}
+ /**
+ * Get the user's domain
+ *
+ * @return string
+ */
+ public function getDomain() {
+ if ( isset( $this->domain ) ) {
+ return $this->domain;
+ } else {
+ return 'invaliddomain';
+ }
+ }
+
/**
* Check to see if the specific domain is a valid domain.
*
- * @param $domain String: authentication domain.
+ * @param string $domain Authentication domain.
* @return bool
*/
public function validDomain( $domain ) {
* The User object is passed by reference so it can be modified; don't
* forget the & on your function declaration.
*
- * @param $user User object
+ * @deprecated since 1.26, use the UserLoggedIn hook instead. And assigning
+ * a different User object to $user is no longer supported.
+ * @param User &$user
+ * @return bool
*/
public function updateUser( &$user ) {
# Override this and do something
*
* This is just a question, and shouldn't perform any actions.
*
- * @return Boolean
+ * @return bool
*/
public function autoCreate() {
return false;
* and use the same keys. 'Realname' 'Emailaddress' and 'Nickname'
* all reference this.
*
- * @return Boolean
+ * @param string $prop
+ *
+ * @return bool
*/
public function allowPropChange( $prop = '' ) {
- if ( $prop == 'realname' && is_callable( array( $this, 'allowRealNameChange' ) ) ) {
+ if ( $prop == 'realname' && is_callable( [ $this, 'allowRealNameChange' ] ) ) {
return $this->allowRealNameChange();
- } elseif ( $prop == 'emailaddress' && is_callable( array( $this, 'allowEmailChange' ) ) ) {
+ } elseif ( $prop == 'emailaddress' && is_callable( [ $this, 'allowEmailChange' ] ) ) {
return $this->allowEmailChange();
- } elseif ( $prop == 'nickname' && is_callable( array( $this, 'allowNickChange' ) ) ) {
+ } elseif ( $prop == 'nickname' && is_callable( [ $this, 'allowNickChange' ] ) ) {
return $this->allowNickChange();
} else {
return true;
return true;
}
+ /**
+ * Should MediaWiki store passwords in its local database?
+ *
+ * @return bool
+ */
+ public function allowSetLocalPassword() {
+ return true;
+ }
+
/**
* Set the given password in the authentication database.
* As a special case, the password may be set to null to request
*
* Return true if successful.
*
- * @param $user User object.
- * @param $password String: password.
+ * @param User $user
+ * @param string $password Password.
* @return bool
*/
public function setPassword( $user, $password ) {
* Update user information in the external authentication database.
* Return true if successful.
*
- * @param $user User object.
- * @return Boolean
+ * @deprecated since 1.26, use the UserSaveSettings hook instead.
+ * @param User $user
+ * @return bool
*/
public function updateExternalDB( $user ) {
return true;
}
+ /**
+ * Update user groups in the external authentication database.
+ * Return true if successful.
+ *
+ * @deprecated since 1.26, use the UserGroupsChanged hook instead.
+ * @param User $user
+ * @param array $addgroups Groups to add.
+ * @param array $delgroups Groups to remove.
+ * @return bool
+ */
+ public function updateExternalDBGroups( $user, $addgroups, $delgroups = [] ) {
+ return true;
+ }
+
/**
* Check to see if external accounts can be created.
* Return true if external accounts can be created.
- * @return Boolean
+ * @return bool
*/
public function canCreateAccounts() {
return false;
* Add a user to the external authentication database.
* Return true if successful.
*
- * @param $user User: only the name should be assumed valid at this point
- * @param $password String
- * @param $email String
- * @param $realname String
- * @return Boolean
+ * @param User $user Only the name should be assumed valid at this point
+ * @param string $password
+ * @param string $email
+ * @param string $realname
+ * @return bool
*/
public function addUser( $user, $password, $email = '', $realname = '' ) {
return true;
*
* This is just a question, and shouldn't perform any actions.
*
- * @return Boolean
+ * @return bool
*/
public function strict() {
return false;
* Check if a user should authenticate locally if the global authentication fails.
* If either this or strict() returns true, local authentication is not used.
*
- * @param $username String: username.
- * @return Boolean
+ * @param string $username Username.
+ * @return bool
*/
public function strictUserAuth( $username ) {
return false;
* The User object is passed by reference so it can be modified; don't
* forget the & on your function declaration.
*
- * @param $user User object.
- * @param $autocreate Boolean: True if user is being autocreated on login
+ * @deprecated since 1.26, use the UserLoggedIn hook instead. And assigning
+ * a different User object to $user is no longer supported.
+ * @param User &$user
+ * @param bool $autocreate True if user is being autocreated on login
*/
public function initUser( &$user, $autocreate = false ) {
# Override this to do something.
/**
* If you want to munge the case of an account name before the final
* check, now is your chance.
+ * @param string $username
+ * @return string
*/
public function getCanonicalName( $username ) {
return $username;
/**
* Get an instance of a User object
*
- * @param $user User
+ * @param User &$user
+ *
+ * @return AuthPluginUser
*/
public function getUserInstance( User &$user ) {
return new AuthPluginUser( $user );
}
+
+ /**
+ * Get a list of domains (in HTMLForm options format) used.
+ *
+ * @return array
+ */
+ public function domainList() {
+ return [];
+ }
}
+/**
+ * @deprecated since 1.27
+ */
class AuthPluginUser {
function __construct( $user ) {
# Override this!
return -1;
}
+ /**
+ * Indicate whether the user is locked
+ * @deprecated since 1.26, use the UserIsLocked hook instead.
+ * @return bool
+ */
public function isLocked() {
# Override this!
return false;
}
+ /**
+ * Indicate whether the user is hidden
+ * @deprecated since 1.26, use the UserIsHidden hook instead.
+ * @return bool
+ */
public function isHidden() {
# Override this!
return false;
}
+ /**
+ * @deprecated since 1.28, use SessionManager::invalidateSessionForUser() instead.
+ * @return bool
+ */
public function resetAuthToken() {
# Override this!
return true;
scripts.mit.edu / autoinstallsdev / mediawiki.git / blobdiff