X-Git-Url: https://git.heureux-cyclage.org/?a=blobdiff_plain;f=includes%2FAuthPlugin.php;h=2fdba797186ab3a37f2cd06824d239952b4aa706;hb=276e8149a53c934216c40880f71b739cc4816f05;hp=894b0964ad3d96eae02b7e410473a64c08ae82a1;hpb=2104f62734f5f16f9f6d78e9782db2375c0805ad;p=lhc%2Fweb%2Fwiklou.git diff --git a/includes/AuthPlugin.php b/includes/AuthPlugin.php index 894b0964ad..2fdba79718 100644 --- a/includes/AuthPlugin.php +++ b/includes/AuthPlugin.php @@ -1,24 +1,27 @@ + * http://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 + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License along + * with this program; if not, write to the Free Software Foundation, Inc., + * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + * http://www.gnu.org/copyleft/gpl.html + * + * @file */ -# Copyright (C) 2004 Brion Vibber -# http://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 -# the Free Software Foundation; either version 2 of the License, or -# (at your option) any later version. -# -# This program is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License along -# with this program; if not, write to the Free Software Foundation, Inc., -# 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. -# http://www.gnu.org/copyleft/gpl.html /** * Authentication plugin interface. Instantiate a subclass of AuthPlugin @@ -29,11 +32,6 @@ * 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. - * - * This interface is new, and might change a bit before 1.4.0 final is - * done... - * - * @package MediaWiki */ class AuthPlugin { /** @@ -42,58 +40,195 @@ class AuthPlugin { * you might need to munge it (for instance, for lowercase initial * letters). * - * @param string $username + * @param $username String: username. * @return bool - * @access public */ - function userExists( $username ) { + public function userExists( $username ) { # Override this! return false; } - + /** * Check if a username+password pair is a valid login. * The name will be normalized to MediaWiki's requirements, so * you might need to munge it (for instance, for lowercase initial * letters). * - * @param string $username - * @param string $password + * @param $username String: username. + * @param $password String: user password. * @return bool - * @access public */ - function authenticate( $username, $password ) { + public function authenticate( $username, $password ) { # Override this! return false; } - + + /** + * Modify options in the login template. + * + * @param $template UserLoginTemplate object. + * @param $type String 'signup' or 'login'. Added in 1.16. + */ + public function modifyUITemplate( &$template, &$type ) { + # Override this! + $template->set( 'usedomain', false ); + } + + /** + * Set the domain this plugin is supposed to use when authenticating. + * + * @param $domain String: authentication domain. + */ + public function setDomain( $domain ) { + $this->domain = $domain; + } + + /** + * Check to see if the specific domain is a valid domain. + * + * @param $domain String: authentication domain. + * @return bool + */ + public function validDomain( $domain ) { + # Override this! + return true; + } + + /** + * When a user logs in, optionally fill in preferences and such. + * For instance, you might pull the email address or real name from the + * external user database. + * + * The User object is passed by reference so it can be modified; don't + * forget the & on your function declaration. + * + * @param $user User object + */ + public function updateUser( &$user ) { + # Override this and do something + return true; + } + /** * Return true if the wiki should create a new local account automatically * when asked to login a user who doesn't exist locally but does in the * external auth database. * + * If you don't automatically create accounts, you must still create + * accounts in some way. It's not possible to authenticate without + * a local account. + * * This is just a question, and shouldn't perform any actions. * + * @return Boolean + */ + public function autoCreate() { + return false; + } + + /** + * Allow a property change? Properties are the same as preferences + * and use the same keys. 'Realname' 'Emailaddress' and 'Nickname' + * all reference this. + * + * @param $prop string + * + * @return Boolean + */ + public function allowPropChange( $prop = '' ) { + if ( $prop == 'realname' && is_callable( array( $this, 'allowRealNameChange' ) ) ) { + return $this->allowRealNameChange(); + } elseif ( $prop == 'emailaddress' && is_callable( array( $this, 'allowEmailChange' ) ) ) { + return $this->allowEmailChange(); + } elseif ( $prop == 'nickname' && is_callable( array( $this, 'allowNickChange' ) ) ) { + return $this->allowNickChange(); + } else { + return true; + } + } + + /** + * Can users change their passwords? + * + * @return bool + */ + public function allowPasswordChange() { + return true; + } + + /** + * Set the given password in the authentication database. + * As a special case, the password may be set to null to request + * locking the password to an unusable value, with the expectation + * that it will be set later through a mail reset or other method. + * + * Return true if successful. + * + * @param $user User object. + * @param $password String: password. * @return bool - * @access public */ - function autoCreate() { + public function setPassword( $user, $password ) { + return true; + } + + /** + * Update user information in the external authentication database. + * Return true if successful. + * + * @param $user User object. + * @return Boolean + */ + public function updateExternalDB( $user ) { + return true; + } + + /** + * Check to see if external accounts can be created. + * Return true if external accounts can be created. + * @return Boolean + */ + 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 + */ + public function addUser( $user, $password, $email = '', $realname = '' ) { + return true; + } + /** * Return true to prevent logins that don't authenticate here from being * checked against the local database's password fields. * * This is just a question, and shouldn't perform any actions. * - * @return bool - * @access public + * @return Boolean + */ + 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 */ - function strict() { + public function strictUserAuth( $username ) { return false; } - + /** * When creating a user account, optionally fill in preferences and such. * For instance, you might pull the email address or real name from the @@ -102,12 +237,64 @@ class AuthPlugin { * The User object is passed by reference so it can be modified; don't * forget the & on your function declaration. * - * @param User $user - * @access public + * @param $user User object. + * @param $autocreate Boolean: True if user is being autocreated on login */ - function initUser( &$user ) { + 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. + */ + public function getCanonicalName( $username ) { + return $username; + } + + /** + * Get an instance of a User object + * + * @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 array(); + } } -?> \ No newline at end of file +class AuthPluginUser { + function __construct( $user ) { + # Override this! + } + + public function getId() { + # Override this! + return -1; + } + + public function isLocked() { + # Override this! + return false; + } + + public function isHidden() { + # Override this! + return false; + } + + public function resetAuthToken() { + # Override this! + return true; + } +}