This class supports authentication against an external MediaWiki database, probably any version back to 1.5 or something. More...
Public Member Functions | |
| authenticate ($password) | |
| Is the given password valid for the external user? The password is provided in plaintext. | |
| getGroups () | |
| getId () | |
| This must return some identifier that stably, uniquely identifies the user. | |
| getName () | |
| getPref ($pref) | |
| Retrieve the value corresponding to the given preference key. | |
Protected Member Functions | |
| initFromId ($id) | |
| initFromName ($name) | |
Private Member Functions | |
| initFromCond ($cond) | |
Private Attributes | |
| DatabaseBase | $mDb |
| $mRow | |
Detailed Description
This class supports authentication against an external MediaWiki database, probably any version back to 1.5 or something.
Example configuration:
$wgExternalAuthType = 'ExternalUser_MediaWiki'; $wgExternalAuthConf = array( 'DBtype' => 'mysql', 'DBserver' => 'localhost', 'DBname' => 'wikidb', 'DBuser' => 'quasit', 'DBpassword' => 'a5Cr:yf9u-6[{`g', 'DBprefix' => '', );
All fields must be present. These mean the same things as $wgDBtype, $wgDBserver, etc. This implementation is quite crude; it could easily support multiple database servers, for instance, and memcached, and it probably has bugs. Kind of hard to reuse code when things might rely on who knows what configuration globals.
If either wiki uses the UserComparePasswords hook, password authentication might fail unexpectedly unless they both do the exact same validation. There may be other corner cases like this where this will fail, but it should be unlikely.
Definition at line 52 of file MediaWiki.php.
Member Function Documentation
| ExternalUser_MediaWiki::authenticate | ( | $ | password | ) |
Is the given password valid for the external user? The password is provided in plaintext.
- Parameters:
-
$password string
- Returns:
- bool
Reimplemented from ExternalUser.
Definition at line 131 of file MediaWiki.php.
References User\comparePasswords().
This must return some identifier that stably, uniquely identifies the user.
In a typical web application, this could be an integer representing the "user id". In other cases, it might be a string. In any event, the return value should be a string between 1 and 255 characters in length; must uniquely identify the user in the foreign database; and, if at all possible, should be permanent.
This will only ever be used to reconstruct this ExternalUser object via newFromId(). The resulting object in that case should correspond to the same user, even if details have changed in the interim (e.g., renames or preference changes).
- Returns:
- string
Reimplemented from ExternalUser.
Definition at line 120 of file MediaWiki.php.
| ExternalUser_MediaWiki::getPref | ( | $ | pref | ) |
Retrieve the value corresponding to the given preference key.
The most important values are:
- emailaddress
- language
The value must meet MediaWiki's requirements for values of this type, and will be checked for validity before use. If the preference makes no sense for the backend, or it makes sense but is unset for this user, or is unrecognized, return null.
$pref will never equal 'password', since passwords are usually hashed and cannot be directly retrieved. authenticate() is used for this instead.
TODO: Currently this is only called for 'emailaddress'; generalize! Add some config option to decide which values are grabbed on user initialization.
- Parameters:
-
$pref string
- Returns:
- mixed
Reimplemented from ExternalUser.
Definition at line 138 of file MediaWiki.php.
| ExternalUser_MediaWiki::initFromCond | ( | $ | cond | ) | [private] |
| ExternalUser_MediaWiki::initFromId | ( | $ | id | ) | [protected] |
- Parameters:
-
$id int
- Returns:
- bool
Reimplemented from ExternalUser.
Definition at line 80 of file MediaWiki.php.
| ExternalUser_MediaWiki::initFromName | ( | $ | name | ) | [protected] |
- Parameters:
-
$name string
- Returns:
- bool
Reimplemented from ExternalUser.
Definition at line 63 of file MediaWiki.php.
Member Data Documentation
DatabaseBase ExternalUser_MediaWiki::$mDb [private] |
Definition at line 57 of file MediaWiki.php.
ExternalUser_MediaWiki::$mRow [private] |
Definition at line 53 of file MediaWiki.php.
The documentation for this class was generated from the following file:
- includes/extauth/MediaWiki.php
