<?php
/**
- * @package MediaWiki
*/
# Copyright (C) 2004 Brion Vibber <brion@pobox.com>
# http://www.mediawiki.org/
#
# 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.
+# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
# http://www.gnu.org/copyleft/gpl.html
/**
* 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 {
/**
* you might need to munge it (for instance, for lowercase initial
* letters).
*
- * @param string $username
+ * @param $username String: username.
* @return bool
- * @access public
+ * @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
+ * @public
*/
function authenticate( $username, $password ) {
# Override this!
return false;
}
-
+
/**
* Modify options in the login template.
*
- * @param UserLoginTemplate $template
- * @access public
+ * @param $template UserLoginTemplate object.
+ * @public
*/
function modifyUITemplate( &$template ) {
# Override this!
/**
* Set the domain this plugin is supposed to use when authenticating.
*
- * @param string $domain
- * @access public
+ * @param $domain String: authentication domain.
+ * @public
*/
function setDomain( $domain ) {
$this->domain = $domain;
/**
* Check to see if the specific domain is a valid domain.
*
- * @param string $domain
+ * @param $domain String: authentication domain.
* @return bool
- * @access public
+ * @public
*/
function validDomain( $domain ) {
# Override this!
* forget the & on your function declaration.
*
* @param User $user
- * @access public
+ * @public
*/
function updateUser( &$user ) {
# Override this and do something
* This is just a question, and shouldn't perform any actions.
*
* @return bool
- * @access public
+ * @public
*/
function autoCreate() {
return false;
}
-
+
+ /**
+ * Can users change their passwords?
+ *
+ * @return bool
+ */
+ 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 string $password
+ * @param $user User object.
+ * @param $password String: password.
* @return bool
- * @access public
+ * @public
*/
- function setPassword( $password ) {
+ function setPassword( $user, $password ) {
return true;
}
* Update user information in the external authentication database.
* Return true if successful.
*
- * @param User $user
+ * @param $user User object.
* @return bool
- * @access public
+ * @public
*/
function updateExternalDB( $user ) {
return true;
* Check to see if external accounts can be created.
* Return true if external accounts can be created.
* @return bool
- * @access public
+ * @public
*/
function canCreateAccounts() {
return false;
* Add a user to the external authentication database.
* Return true if successful.
*
- * @param User $user
+ * @param User $user - only the name should be assumed valid at this point
* @param string $password
+ * @param string $email
+ * @param string $realname
* @return bool
- * @access public
+ * @public
*/
- function addUser( $user, $password ) {
+ function addUser( $user, $password, $email='', $realname='' ) {
return true;
}
* This is just a question, and shouldn't perform any actions.
*
* @return bool
- * @access public
+ * @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 bool
+ * @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
* 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 bool True if user is being autocreated on login
+ * @public
*/
- function initUser( &$user ) {
+ 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.
}
}
-?>
+
dépôts / lhc / web / wiklou.git / blobdiff