auth cas/db/ldap: MDL-18689 Fix typos in auth/{cas,db,ldap}/auth.php
[moodle.git] / auth / db / auth.php
CommitLineData
b9ddb2d5 1<?php
2
3/**
4 * @author Martin Dougiamas
5 * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
6 * @package moodle multiauth
7 *
8 * Authentication Plugin: External Database Authentication
9 *
10 * Checks against an external database.
11 *
12 * 2006-08-28 File created.
13 */
14
8ae42b8d 15if (!defined('MOODLE_INTERNAL')) {
16 die('Direct access to this script is forbidden.'); /// It must be included from a Moodle page
17}
b9ddb2d5 18
6bc1e5d5 19require_once($CFG->libdir.'/authlib.php');
e7721485 20require_once($CFG->libdir.'/adodb/adodb.inc.php');
6bc1e5d5 21
b9ddb2d5 22/**
23 * External database authentication plugin.
24 */
6bc1e5d5 25class auth_plugin_db extends auth_plugin_base {
b9ddb2d5 26
27 /**
28 * Constructor.
29 */
30 function auth_plugin_db() {
6bc1e5d5 31 $this->authtype = 'db';
b9ddb2d5 32 $this->config = get_config('auth/db');
8ae42b8d 33 if (empty($this->config->extencoding)) {
34 $this->config->extencoding = 'utf-8';
35 }
b9ddb2d5 36 }
37
38 /**
39 * Returns true if the username and password work and false if they are
40 * wrong or don't exist.
41 *
576c063b 42 * @param string $username The username
43 * @param string $password The password
8ae42b8d 44 *
45 * @return bool Authentication success or failure.
b9ddb2d5 46 */
139ebfdb 47 function user_login($username, $password) {
576c063b 48 global $CFG, $DB;
b9ddb2d5 49
8ae42b8d 50 $textlib = textlib_get_instance();
576c063b 51 $extusername = $textlib->convert($username, 'utf-8', $this->config->extencoding);
52 $extpassword = $textlib->convert($password, 'utf-8', $this->config->extencoding);
8ae42b8d 53
139ebfdb 54 $authdb = $this->db_init();
b9ddb2d5 55
8ae42b8d 56 if ($this->config->passtype === 'internal') {
b9ddb2d5 57 // lookup username externally, but resolve
58 // password locally -- to support backend that
59 // don't track passwords
8ae42b8d 60 $rs = $authdb->Execute("SELECT * FROM {$this->config->table}
61 WHERE {$this->config->fielduser} = '".$this->ext_addslashes($extusername)."' ");
b9ddb2d5 62 if (!$rs) {
03cedd62 63 $authdb->Close();
2b06294b 64 print_error('auth_dbcantconnect','auth_db');
b9ddb2d5 65 return false;
66 }
8ae42b8d 67
03cedd62 68 if ( !$rs->EOF ) {
69 $rs->Close();
70 $authdb->Close();
b9ddb2d5 71 // user exists exterally
72 // check username/password internally
576c063b 73 if ($user = $DB->get_record('user', array('username'=>$username, 'mnethostid'=>$CFG->mnet_localhost_id))) {
b9ddb2d5 74 return validate_internal_user_password($user, $password);
75 }
76 } else {
03cedd62 77 $rs->Close();
78 $authdb->Close();
b9ddb2d5 79 // user does not exist externally
80 return false;
8ae42b8d 81 }
b9ddb2d5 82
8ae42b8d 83 } else {
b9ddb2d5 84 // normal case: use external db for passwords
85
86 if ($this->config->passtype === 'md5') { // Re-format password accordingly
8ae42b8d 87 $extpassword = md5($extpassword);
88 } else if ($this->config->passtype === 'sha1') {
89 $extpassword = sha1($extpassword);
b9ddb2d5 90 }
91
8ae42b8d 92 $rs = $authdb->Execute("SELECT * FROM {$this->config->table}
93 WHERE {$this->config->fielduser} = '".$this->ext_addslashes($extusername)."'
94 AND {$this->config->fieldpass} = '".$this->ext_addslashes($extpassword)."' ");
b9ddb2d5 95 if (!$rs) {
03cedd62 96 $authdb->Close();
2b06294b 97 print_error('auth_dbcantconnect','auth_db');
b9ddb2d5 98 return false;
99 }
8ae42b8d 100
03cedd62 101 if (!$rs->EOF) {
102 $rs->Close();
103 $authdb->Close();
b9ddb2d5 104 return true;
105 } else {
03cedd62 106 $rs->Close();
107 $authdb->Close();
b9ddb2d5 108 return false;
8ae42b8d 109 }
110
b9ddb2d5 111 }
112 }
113
139ebfdb 114 function db_init() {
93901eb4 115 // Connect to the external database (forcing new connection)
116 $authdb = &ADONewConnection($this->config->type);
8ae42b8d 117 if (!empty($this->config->debugauthdb)) {
118 $authdb->debug = true;
119 ob_start();//start output buffer to allow later use of the page headers
120 }
121 $authdb->Connect($this->config->host, $this->config->user, $this->config->pass, $this->config->name, true);
b9ddb2d5 122 $authdb->SetFetchMode(ADODB_FETCH_ASSOC);
8ae42b8d 123 if (!empty($this->config->setupsql)) {
124 $authdb->Execute($this->config->setupsql);
125 }
b9ddb2d5 126
139ebfdb 127 return $authdb;
128 }
129 /**
130 * retuns user attribute mappings between moodle and ldap
131 *
132 * @return array
133 */
134 function db_attributes() {
139ebfdb 135 $moodleattributes = array();
4105caff 136 foreach ($this->userfields as $field) {
139ebfdb 137 if (!empty($this->config->{"field_map_$field"})) {
138 $moodleattributes[$field] = $this->config->{"field_map_$field"};
0f02788f 139 }
140 }
5261baf1 141 $moodleattributes['username'] = $this->config->fielduser;
139ebfdb 142 return $moodleattributes;
143 }
144
145 /**
146 * Reads any other information for a user from external database,
147 * then returns it in an array
148 *
be544ec3 149 * @param string $username
139ebfdb 150 *
151 * @return array without magic quotes
152 */
153 function get_userinfo($username) {
154
155 global $CFG;
156
157 $textlib = textlib_get_instance();
be544ec3 158 $extusername = $textlib->convert($username, 'utf-8', $this->config->extencoding);
139ebfdb 159
160 $authdb = $this->db_init();
161
162 //Array to map local fieldnames we want, to external fieldnames
163 $selectfields = $this->db_attributes();
164
0f02788f 165 $result = array();
166 //If at least one field is mapped from external db, get that mapped data:
167 if ($selectfields) {
168 $select = '';
169 foreach ($selectfields as $localname=>$externalname) {
170 $select .= ", $externalname AS $localname";
171 }
172 $select = 'SELECT ' . substr($select,1);
173 $sql = $select .
174 " FROM {$this->config->table}" .
8ae42b8d 175 " WHERE {$this->config->fielduser} = '".$this->ext_addslashes($extusername)."'";
0f02788f 176 if ($rs = $authdb->Execute($sql)) {
03cedd62 177 if ( !$rs->EOF ) {
245ac557 178 $fields_obj = $rs->FetchObj();
1ed6ae07 179 $fields_obj = (object)array_change_key_case((array)$fields_obj , CASE_LOWER);
0f02788f 180 foreach ($selectfields as $localname=>$externalname) {
8ae42b8d 181 $result[$localname] = $textlib->convert($fields_obj->{$localname}, $this->config->extencoding, 'utf-8');
0f02788f 182 }
183 }
245ac557 184 $rs->Close();
b9ddb2d5 185 }
186 }
187 $authdb->Close();
b9ddb2d5 188 return $result;
a7e32367 189
b9ddb2d5 190 }
191
192
fb5c7739 193 /**
194 * Change a user's password
195 *
ae040d4b 196 * @param object $user User table object
197 * @param string $newpassword Plaintext password
8ae42b8d 198 *
fb5c7739 199 * @return bool True on success
200 */
da249a30 201 function user_update_password($user, $newpassword) {
b9ddb2d5 202
b7b50143 203 global $CFG;
b9ddb2d5 204 if ($this->config->passtype === 'internal') {
d972bfd0 205 return update_internal_user_password($user, $newpassword);
b9ddb2d5 206 } else {
207 // we should have never been called!
208 return false;
209 }
210 }
211
212 /**
213 * syncronizes user fron external db to moodle user table
214 *
215 * Sync shouid be done by using idnumber attribute, not username.
216 * You need to pass firstsync parameter to function to fill in
217 * idnumbers if they dont exists in moodle user table.
8ae42b8d 218 *
b9ddb2d5 219 * Syncing users removes (disables) users that dont exists anymore in external db.
8ae42b8d 220 * Creates new users and updates coursecreator status of users.
221 *
b9ddb2d5 222 * @param bool $do_updates Optional: set to true to force an update of existing accounts
223 *
224 * This implementation is simpler but less scalable than the one found in the LDAP module.
225 *
226 */
139ebfdb 227 function sync_users($do_updates=false) {
8ae42b8d 228
70ca450a 229 global $CFG, $DB;
b9ddb2d5 230 $pcfg = get_config('auth/db');
231
139ebfdb 232/// list external users
b9ddb2d5 233 $userlist = $this->get_userlist();
294ce987 234 $quoteduserlist = implode("', '", $userlist);
b9ddb2d5 235 $quoteduserlist = "'$quoteduserlist'";
236
139ebfdb 237/// delete obsolete internal users
238 if (!empty($this->config->removeuser)) {
b9ddb2d5 239
139ebfdb 240 // find obsolete users
241 if (count($userlist)) {
59669b63 242 $sql = "SELECT u.id, u.username, u.email, u.auth
70ca450a 243 FROM {user} u
139ebfdb 244 WHERE u.auth='db' AND u.deleted=0 AND u.username NOT IN ($quoteduserlist)";
245 } else {
59669b63 246 $sql = "SELECT u.id, u.username, u.email, u.auth
70ca450a 247 FROM {user} u
139ebfdb 248 WHERE u.auth='db' AND u.deleted=0";
249 }
70ca450a 250 $remove_users = $DB->get_records_sql($sql);
139ebfdb 251
252 if (!empty($remove_users)) {
2b06294b 253 print_string('auth_dbuserstoremove','auth_db', count($remove_users)); echo "\n";
139ebfdb 254
139ebfdb 255 foreach ($remove_users as $user) {
6f87ef52 256 if ($this->config->removeuser == AUTH_REMOVEUSER_FULLDELETE) {
90afcf32 257 if (delete_user($user)) {
2b06294b 258 echo "\t"; print_string('auth_dbdeleteuser', 'auth_db', array($user->username, $user->id)); echo "\n";
139ebfdb 259 } else {
2b06294b 260 echo "\t"; print_string('auth_dbdeleteusererror', 'auth_db', $user->username); echo "\n";
139ebfdb 261 }
6f87ef52 262 } else if ($this->config->removeuser == AUTH_REMOVEUSER_SUSPEND) {
139ebfdb 263 $updateuser = new object();
264 $updateuser->id = $user->id;
265 $updateuser->auth = 'nologin';
70ca450a 266 if ($DB->update_record('user', $updateuser)) {
2b06294b 267 echo "\t"; print_string('auth_dbsuspenduser', 'auth_db', array($user->username, $user->id)); echo "\n";
139ebfdb 268 } else {
2b06294b 269 echo "\t"; print_string('auth_dbsuspendusererror', 'auth_db', $user->username); echo "\n";
139ebfdb 270 }
271 }
b9ddb2d5 272 }
8ae42b8d 273 }
139ebfdb 274 unset($remove_users); // free mem!
8ae42b8d 275 }
b9ddb2d5 276
277 if (!count($userlist)) {
278 // exit right here
279 // nothing else to do
280 return true;
281 }
282
283 ///
284 /// update existing accounts
285 ///
286 if ($do_updates) {
287 // narrow down what fields we need to update
288 $all_keys = array_keys(get_object_vars($this->config));
289 $updatekeys = array();
290 foreach ($all_keys as $key) {
291 if (preg_match('/^field_updatelocal_(.+)$/',$key, $match)) {
292 if ($this->config->{$key} === 'onlogin') {
293 array_push($updatekeys, $match[1]); // the actual key name
294 }
295 }
296 }
297 // print_r($all_keys); print_r($updatekeys);
298 unset($all_keys); unset($key);
299
300 // only go ahead if we actually
301 // have fields to update locally
302 if (!empty($updatekeys)) {
8ae42b8d 303 $sql = 'SELECT u.id, u.username
70ca450a 304 FROM {user} u
b9ddb2d5 305 WHERE u.auth=\'db\' AND u.deleted=\'0\' AND u.username IN (' . $quoteduserlist . ')';
70ca450a 306 if ($update_users = $DB->get_records_sql($sql)) {
139ebfdb 307 print "User entries to update: ". count($update_users). "\n";
8ae42b8d 308
309 foreach ($update_users as $user) {
2b06294b 310 echo "\t"; print_string('auth_dbupdatinguser', 'auth_db', array($user->username, $user->id));
185721a4 311 if (!$this->update_user_record($user->username, $updatekeys)) {
139ebfdb 312 echo " - ".get_string('skipped');
313 }
314 echo "\n";
8ae42b8d 315 }
316 unset($update_users); // free memory
b9ddb2d5 317 }
b9ddb2d5 318 }
319 }
320
321
322 ///
323 /// create missing accounts
324 ///
325 // NOTE: this is very memory intensive
326 // and generally inefficient
8ae42b8d 327 $sql = 'SELECT u.id, u.username
70ca450a 328 FROM {user} u
b9ddb2d5 329 WHERE u.auth=\'db\' AND u.deleted=\'0\'';
330
70ca450a 331 $users = $DB->get_records_sql($sql);
8ae42b8d 332
b9ddb2d5 333 // simplify down to usernames
334 $usernames = array();
2b214bc1 335 if (!empty($users)) {
336 foreach ($users as $user) {
337 array_push($usernames, $user->username);
338 }
339 unset($users);
b9ddb2d5 340 }
b9ddb2d5 341
342 $add_users = array_diff($userlist, $usernames);
343 unset($usernames);
344
345 if (!empty($add_users)) {
2b06294b 346 print_string('auth_dbuserstoadd','auth_db',count($add_users)); echo "\n";
d5a8d9aa 347 $transaction = $DB->start_delegated_transaction();
b9ddb2d5 348 foreach($add_users as $user) {
349 $username = $user;
350 $user = $this->get_userinfo_asobj($user);
8ae42b8d 351
b9ddb2d5 352 // prep a few params
b7b50143 353 $user->username = $username;
354 $user->modified = time();
355 $user->confirmed = 1;
356 $user->auth = 'db';
357 $user->mnethostid = $CFG->mnet_localhost_id;
8ae42b8d 358 if (empty($user->lang)) {
359 $user->lang = $CFG->lang;
360 }
361
b9ddb2d5 362 // maybe the user has been deleted before
70ca450a 363 if ($old_user = $DB->get_record('user', array('username'=>$user->username, 'deleted'=>1, 'mnethostid'=>$user->mnethostid))) {
b9ddb2d5 364 $user->id = $old_user->id;
70ca450a 365 $DB->set_field('user', 'deleted', 0, array('username'=>$user->username));
b8fc9582 366 echo "\t"; print_string('auth_dbreviveduser', 'auth_db', array($user->username, $user->id)); echo "\n";
07ed083e
RW
367
368 //TODO - username required to use PARAM_USERNAME before inserting into user table (MDL-16919)
f67cab32 369 } elseif ($id = $DB->insert_record ('user',$user)) { // it is truly a new user
2b06294b 370 echo "\t"; print_string('auth_dbinsertuser','auth_db',array($user->username, $id)); echo "\n";
b9ddb2d5 371 // if relevant, tag for password generation
372 if ($this->config->passtype === 'internal') {
373 set_user_preference('auth_forcepasswordchange', 1, $id);
374 set_user_preference('create_password', 1, $id);
375 }
376 } else {
2b06294b 377 echo "\t"; print_string('auth_dbinsertusererror', 'auth_db', $user->username); echo "\n";
b9ddb2d5 378 }
b9ddb2d5 379 }
d5a8d9aa 380 $transaction->allow_commit();
b9ddb2d5 381 unset($add_users); // free mem
382 }
383 return true;
384 }
385
139ebfdb 386 function user_exists($username) {
93901eb4 387
a7e32367 388 /// Init result value
389 $result = false;
390
8ae42b8d 391 $textlib = textlib_get_instance();
70ca450a 392 $extusername = $textlib->convert($username, 'utf-8', $this->config->extencoding);
8ae42b8d 393
139ebfdb 394 $authdb = $this->db_init();
b9ddb2d5 395
8ae42b8d 396 $rs = $authdb->Execute("SELECT * FROM {$this->config->table}
397 WHERE {$this->config->fielduser} = '".$this->ext_addslashes($extusername)."' ");
b9ddb2d5 398
399 if (!$rs) {
2b06294b 400 print_error('auth_dbcantconnect','auth_db');
03cedd62 401 } else if ( !$rs->EOF ) {
b9ddb2d5 402 // user exists exterally
03cedd62 403 $result = true;
8ae42b8d 404 }
a7e32367 405
406 $authdb->Close();
407 return $result;
b9ddb2d5 408 }
409
410
411 function get_userlist() {
93901eb4 412
a7e32367 413 /// Init result value
414 $result = array();
415
139ebfdb 416 $authdb = $this->db_init();
b9ddb2d5 417
418 // fetch userlist
419 $rs = $authdb->Execute("SELECT {$this->config->fielduser} AS username
420 FROM {$this->config->table} ");
b9ddb2d5 421
422 if (!$rs) {
2b06294b 423 print_error('auth_dbcantconnect','auth_db');
03cedd62 424 } else if ( !$rs->EOF ) {
245ac557 425 while ($rec = $rs->FetchRow()) {
e9366bf8 426 $rec = (object)array_change_key_case((array)$rec , CASE_LOWER);
427 array_push($result, $rec->username);
b9ddb2d5 428 }
8ae42b8d 429 }
a7e32367 430
431 $authdb->Close();
432 return $result;
b9ddb2d5 433 }
434
435 /**
436 * reads userinformation from DB and return it in an object
437 *
8ae42b8d 438 * @param string $username username (with system magic quotes)
b9ddb2d5 439 * @return array
440 */
441 function get_userinfo_asobj($username) {
442 $user_array = truncate_userinfo($this->get_userinfo($username));
8ae42b8d 443 $user = new object();
b9ddb2d5 444 foreach($user_array as $key=>$value) {
445 $user->{$key} = $value;
446 }
447 return $user;
448 }
449
8ae42b8d 450 /**
451 * will update a local user record from an external source.
452 * is a lighter version of the one in moodlelib -- won't do
b9ddb2d5 453 * expensive ops such as enrolment
454 *
8ae42b8d 455 * If you don't pass $updatekeys, there is a performance hit and
b9ddb2d5 456 * values removed from DB won't be removed from moodle.
8ae42b8d 457 *
185721a4 458 * @param string $username username
b9ddb2d5 459 */
139ebfdb 460 function update_user_record($username, $updatekeys=false) {
185721a4 461 global $CFG, $DB;
b9ddb2d5 462
b9ddb2d5 463 //just in case check text case
464 $username = trim(moodle_strtolower($username));
8ae42b8d 465
b9ddb2d5 466 // get the current user record
185721a4 467 $user = $DB->get_record('user', array('username'=>$username, 'mnethostid'=>$CFG->mnet_localhost_id));
b9ddb2d5 468 if (empty($user)) { // trouble
469 error_log("Cannot update non-existent user: $username");
2b06294b 470 print_error('auth_dbusernotexist','auth_db',$username);
b9ddb2d5 471 die;
472 }
473
b7b50143 474 // Ensure userid is not overwritten
475 $userid = $user->id;
476
b9ddb2d5 477 if ($newinfo = $this->get_userinfo($username)) {
478 $newinfo = truncate_userinfo($newinfo);
8ae42b8d 479
b9ddb2d5 480 if (empty($updatekeys)) { // all keys? this does not support removing values
481 $updatekeys = array_keys($newinfo);
482 }
8ae42b8d 483
b9ddb2d5 484 foreach ($updatekeys as $key) {
b9ddb2d5 485 if (isset($newinfo[$key])) {
486 $value = $newinfo[$key];
b9ddb2d5 487 } else {
488 $value = '';
489 }
8ae42b8d 490
491 if (!empty($this->config->{'field_updatelocal_' . $key})) {
139ebfdb 492 if ($user->{$key} != $value) { // only update if it's changed
185721a4 493 $DB->set_field('user', $key, $value, array('id'=>$userid));
139ebfdb 494 }
b9ddb2d5 495 }
496 }
497 }
185721a4 498 return $DB->get_record('user', array('id'=>$userid, 'deleted'=>0));
139ebfdb 499 }
500
501 /**
502 * Called when the user record is updated.
503 * Modifies user in external database. It takes olduser (before changes) and newuser (after changes)
504 * conpares information saved modified information to external db.
505 *
70ca450a 506 * @param mixed $olduser Userobject before modifications
507 * @param mixed $newuser Userobject new modified userobject
139ebfdb 508 * @return boolean result
509 *
510 */
511 function user_update($olduser, $newuser) {
512 if (isset($olduser->username) and isset($newuser->username) and $olduser->username != $newuser->username) {
513 error_log("ERROR:User renaming not allowed in ext db");
514 return false;
515 }
516
517 if (isset($olduser->auth) and $olduser->auth != 'db') {
518 return true; // just change auth and skip update
519 }
520
521 $curruser = $this->get_userinfo($olduser->username);
522 if (empty($curruser)) {
523 error_log("ERROR:User $olduser->username found in ext db");
524 return false;
525 }
526
527 $textlib = textlib_get_instance();
528 $extusername = $textlib->convert($olduser->username, 'utf-8', $this->config->extencoding);
529
530 $authdb = $this->db_init();
531
532 $update = array();
533 foreach($curruser as $key=>$value) {
534 if ($key == 'username') {
535 continue; // skip this
536 }
537 if (empty($this->config->{"field_updateremote_$key"})) {
538 continue; // remote update not requested
539 }
540 if (!isset($newuser->$key)) {
541 continue;
542 }
70ca450a 543 $nuvalue = $newuser->$key;
139ebfdb 544 if ($nuvalue != $value) {
545 $update[] = $this->config->{"field_map_$key"}."='".$this->ext_addslashes($textlib->convert($nuvalue, 'utf-8', $this->config->extencoding))."'";
546 }
547 }
548 if (!empty($update)) {
549 $authdb->Execute("UPDATE {$this->config->table}
550 SET ".implode(',', $update)."
551 WHERE {$this->config->fielduser}='".$this->ext_addslashes($extusername)."'");
552 }
553 $authdb->Close();
554 return true;
b9ddb2d5 555 }
556
8ae42b8d 557 /**
558 * A chance to validate form data, and last chance to
559 * do stuff before it is inserted in config_plugin
560 */
561 function validate_form(&$form, &$err) {
150b5fb0 562 if ($form->passtype === 'internal') {
b9ddb2d5 563 $this->config->changepasswordurl = '';
564 set_config('changepasswordurl', '', 'auth/db');
565 }
b9ddb2d5 566 }
567
edb5da83
PS
568 function prevent_local_passwords() {
569 if (!isset($this->config->passtype)) {
570 return false;
571 }
572 return ($this->config->passtype != 'internal');
573 }
574
b9ddb2d5 575 /**
576 * Returns true if this authentication plugin is 'internal'.
577 *
139ebfdb 578 * @return bool
b9ddb2d5 579 */
580 function is_internal() {
e79781f7
PS
581 if (!isset($this->config->passtype)) {
582 return true;
583 }
ab6ff8a4 584 return ($this->config->passtype == 'internal');
b9ddb2d5 585 }
586
587 /**
588 * Returns true if this authentication plugin can change the user's
589 * password.
590 *
139ebfdb 591 * @return bool
b9ddb2d5 592 */
593 function can_change_password() {
430759a5 594 return ($this->config->passtype == 'internal' or !empty($this->config->changepasswordurl));
b9ddb2d5 595 }
596
597 /**
430759a5 598 * Returns the URL for changing the user's pw, or empty if the default can
b9ddb2d5 599 * be used.
600 *
430759a5 601 * @return string
b9ddb2d5 602 */
603 function change_password_url() {
430759a5 604 if ($this->config->passtype == 'internal') {
605 // standard form
606 return '';
607 } else {
608 // use custom url
609 return $this->config->changepasswordurl;
610 }
b9ddb2d5 611 }
612
ab6ff8a4 613 /**
614 * Returns true if plugin allows resetting of internal password.
615 *
616 * @return bool
617 */
618 function can_reset_password() {
619 return ($this->config->passtype == 'internal');
620 }
621
b9ddb2d5 622 /**
623 * Prints a form for configuring this authentication plugin.
624 *
625 * This function is called from admin/auth.php, and outputs a full page with
626 * a form for configuring this plugin.
627 *
628 * @param array $page An object containing all the data for this page.
629 */
139ebfdb 630 function config_form($config, $err, $user_fields) {
8ae42b8d 631 include 'config.html';
b9ddb2d5 632 }
633
634 /**
635 * Processes and stores configuration data for this authentication plugin.
636 */
637 function process_config($config) {
638 // set to defaults if undefined
639 if (!isset($config->host)) {
8ae42b8d 640 $config->host = 'localhost';
b9ddb2d5 641 }
642 if (!isset($config->type)) {
8ae42b8d 643 $config->type = 'mysql';
644 }
645 if (!isset($config->sybasequoting)) {
646 $config->sybasequoting = 0;
b9ddb2d5 647 }
648 if (!isset($config->name)) {
8ae42b8d 649 $config->name = '';
b9ddb2d5 650 }
651 if (!isset($config->user)) {
8ae42b8d 652 $config->user = '';
b9ddb2d5 653 }
654 if (!isset($config->pass)) {
8ae42b8d 655 $config->pass = '';
b9ddb2d5 656 }
657 if (!isset($config->table)) {
8ae42b8d 658 $config->table = '';
b9ddb2d5 659 }
660 if (!isset($config->fielduser)) {
8ae42b8d 661 $config->fielduser = '';
b9ddb2d5 662 }
663 if (!isset($config->fieldpass)) {
8ae42b8d 664 $config->fieldpass = '';
b9ddb2d5 665 }
666 if (!isset($config->passtype)) {
8ae42b8d 667 $config->passtype = 'plaintext';
668 }
669 if (!isset($config->extencoding)) {
670 $config->extencoding = 'utf-8';
671 }
672 if (!isset($config->setupsql)) {
673 $config->setupsql = '';
674 }
675 if (!isset($config->debugauthdb)) {
676 $config->debugauthdb = 0;
b9ddb2d5 677 }
139ebfdb 678 if (!isset($config->removeuser)) {
6f87ef52 679 $config->removeuser = AUTH_REMOVEUSER_KEEP;
139ebfdb 680 }
b9ddb2d5 681 if (!isset($config->changepasswordurl)) {
682 $config->changepasswordurl = '';
683 }
684
685 // save settings
8ae42b8d 686 set_config('host', $config->host, 'auth/db');
687 set_config('type', $config->type, 'auth/db');
688 set_config('sybasequoting', $config->sybasequoting, 'auth/db');
689 set_config('name', $config->name, 'auth/db');
690 set_config('user', $config->user, 'auth/db');
691 set_config('pass', $config->pass, 'auth/db');
692 set_config('table', $config->table, 'auth/db');
693 set_config('fielduser', $config->fielduser, 'auth/db');
694 set_config('fieldpass', $config->fieldpass, 'auth/db');
695 set_config('passtype', $config->passtype, 'auth/db');
696 set_config('extencoding', trim($config->extencoding), 'auth/db');
139ebfdb 697 set_config('setupsql', trim($config->setupsql),'auth/db');
8ae42b8d 698 set_config('debugauthdb', $config->debugauthdb, 'auth/db');
139ebfdb 699 set_config('removeuser', $config->removeuser, 'auth/db');
8ae42b8d 700 set_config('changepasswordurl', trim($config->changepasswordurl), 'auth/db');
701
b9ddb2d5 702 return true;
703 }
704
8ae42b8d 705 function ext_addslashes($text) {
706 // using custom made function for now
707 if (empty($this->config->sybasequoting)) {
708 $text = str_replace('\\', '\\\\', $text);
709 $text = str_replace(array('\'', '"', "\0"), array('\\\'', '\\"', '\\0'), $text);
710 } else {
711 $text = str_replace("'", "''", $text);
712 }
713 return $text;
714 }
b9ddb2d5 715}
716
5117d598 717