1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168
|
<?php
/**
* External authentication with external MediaWiki database.
*
* Copyright © 2009 Aryeh Gregor
*
* 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
*/
/**
* 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.
*
* @ingroup ExternalUser
*/
class ExternalUser_MediaWiki extends ExternalUser {
private $mRow;
/**
* @var DatabaseBase
*/
private $mDb;
/**
* @param $name string
* @return bool
*/
protected function initFromName( $name ) {
# We might not need the 'usable' bit, but let's be safe. Theoretically
# this might return wrong results for old versions, but it's probably
# good enough.
$name = User::getCanonicalName( $name, 'usable' );
if ( !is_string( $name ) ) {
return false;
}
return $this->initFromCond( array( 'user_name' => $name ) );
}
/**
* @param $id int
* @return bool
*/
protected function initFromId( $id ) {
return $this->initFromCond( array( 'user_id' => $id ) );
}
/**
* @param $cond array
* @return bool
*/
private function initFromCond( $cond ) {
global $wgExternalAuthConf;
$this->mDb = DatabaseBase::factory( $wgExternalAuthConf['DBtype'],
array(
'host' => $wgExternalAuthConf['DBserver'],
'user' => $wgExternalAuthConf['DBuser'],
'password' => $wgExternalAuthConf['DBpassword'],
'dbname' => $wgExternalAuthConf['DBname'],
'tablePrefix' => $wgExternalAuthConf['DBprefix'],
)
);
$row = $this->mDb->selectRow(
'user',
array(
'user_name', 'user_id', 'user_password', 'user_email',
'user_email_authenticated'
),
$cond,
__METHOD__
);
if ( !$row ) {
return false;
}
$this->mRow = $row;
return true;
}
# TODO: Implement initFromCookie().
public function getId() {
return $this->mRow->user_id;
}
/**
* @return string
*/
public function getName() {
return $this->mRow->user_name;
}
public function authenticate( $password ) {
# This might be wrong if anyone actually uses the UserComparePasswords hook
# (on either end), so don't use this if you those are incompatible.
return User::comparePasswords( $this->mRow->user_password, $password,
$this->mRow->user_id );
}
public function getPref( $pref ) {
# @todo FIXME: Return other prefs too. Lots of global-riddled code that does
# this normally.
if ( $pref === 'emailaddress'
&& $this->row->user_email_authenticated !== null ) {
return $this->mRow->user_email;
}
return null;
}
/**
* @return array
*/
public function getGroups() {
# @todo FIXME: Untested.
$groups = array();
$res = $this->mDb->select(
'user_groups',
'ug_group',
array( 'ug_user' => $this->mRow->user_id ),
__METHOD__
);
foreach ( $res as $row ) {
$groups[] = $row->ug_group;
}
return $groups;
}
# TODO: Implement setPref().
}
|