lib/WikiUserNew.php

   1 <?php //-*-php-*-
   2 rcs_id('$Id: WikiUserNew.php,v 1.49 2004-04-07 23:13:18 rurban Exp $');
   3 /* Copyright (C) 2004 $ThePhpWikiProgrammingTeam
   4  */
   5 /**
   6  * This is a complete OOP rewrite of the old WikiUser code with various
   7  * configurable external authentication methods.
   8  *
   9  * There's only one entry point, the function WikiUser which returns
  10  * a WikiUser object, which contains the user's preferences.
  11  * This object might get upgraded during the login step and later also.
  12  * There exist three preferences storage methods: cookie, homepage and db,
  13  * and multiple password checking methods.
  14  * See index.php for $USER_AUTH_ORDER[] and USER_AUTH_POLICY if
  15  * ALLOW_USER_PASSWORDS is defined.
  16  *
  17  * Each user object must define the two preferences methods
  18  *  getPreferences(), setPreferences(),
  19  * and the following 1-4 auth methods
  20  *  checkPass()  must be defined by all classes,
  21  *  userExists() only if USER_AUTH_POLICY'=='strict'
  22  *  mayChangePass()  only if the password is storable.
  23  *  storePass()  only if the password is storable.
  24  *
  25  * WikiUser() given no name, returns an _AnonUser (anonymous user)
  26  * object, who may or may not have a cookie.
  27  * However, if the there's a cookie with the userid or a session,
  28  * the user is upgraded to the matching user object.
  29  * Given a user name, returns a _BogoUser object, who may or may not
  30  * have a cookie and/or PersonalPage, one of the various _PassUser objects
  31  * or an _AdminUser object.
  32  * BTW: A BogoUser is a userid (loginname) as valid WikiWord, who might
  33  * have stored a password or not. If so, his account is secure, if not
  34  * anybody can use it, because the username is visible e.g. in RecentChanges.
  35  *
  36  * Takes care of passwords, all preference loading/storing in the
  37  * user's page and any cookies. lib/main.php will query the user object to
  38  * verify the password as appropriate.
  39  *
  40  * @author: Reini Urban (the tricky parts),
  41  *          Carsten Klapp (started rolling the ball)
  42  *
  43  * Random architectural notes, sorted by date:
  44  * 2004-01-25 rurban
  45  * Test it by defining ENABLE_USER_NEW in index.php
  46  * 1) Now a ForbiddenUser is returned instead of false.
  47  * 2) Previously ALLOW_ANON_USER = false meant that anon users cannot edit,
  48  *    but may browse. Now with ALLOW_ANON_USER = false he may not browse,
  49  *    which is needed to disable browse PagePermissions.
  50  *    I added now ALLOW_ANON_EDIT = true to makes things clear.
  51  *    (which replaces REQUIRE_SIGNIN_BEFORE_EDIT)
  52  * 2004-02-27 rurban:
  53  * 3) Removed pear prepare. Performance hog, and using integers as
  54  *    handler doesn't help. Do simple sprintf as with adodb. And a prepare
  55  *    in the object init is no advantage, because in the init loop a lot of
  56  *    objects are tried, but not used.
  57  * 4) Already gotten prefs are passed to the next object to avoid
  58  *    duplicate getPreferences() calls.
  59  * 2004-03-18 rurban
  60  * 5) Major php-5 problem: $this re-assignment is disallowed by the parser
  61  *    So we cannot just discrimate with
  62  *      if (!check_php_version(5))
  63  *          $this = $user;
  64  *    A /php5-patch.php is provided, which patches the src automatically
  65  *    for php4 and php5. Default is php4.
  66  * 2004-03-24 rurban
  67  * 6) enforced new cookie policy: prefs don't get stored in cookies
  68  *    anymore, only in homepage and/or database, but always in the
  69  *    current session. old pref cookies will get deleted.
  70  * 2004-04-04 rurban
  71  * 7) TODO:
  72  *    Certain themes should be able to extend the predefined list
  73  *    of preferences. Display/editing is done in the theme specific userprefs.tmpl
  74  *    but storage must be extended to the Get/SetPreferences methods.
  75  *    <theme>/themeinfo.php must provide CustomUserPreferences:
  76  *      A list of name => _UserPreference class pairs.
  77  */
  78
  79 define('WIKIAUTH_FORBIDDEN', -1); // Completely not allowed.
  80 define('WIKIAUTH_ANON', 0);       // Not signed in.
  81 define('WIKIAUTH_BOGO', 1);       // Any valid WikiWord is enough.
  82 define('WIKIAUTH_USER', 2);       // Bogo user with a password.
  83 define('WIKIAUTH_ADMIN', 10);     // UserName == ADMIN_USER.
  84
  85 if (!defined('COOKIE_EXPIRATION_DAYS')) define('COOKIE_EXPIRATION_DAYS', 365);
  86 if (!defined('COOKIE_DOMAIN'))          define('COOKIE_DOMAIN', '/');
  87
  88 if (!defined('EDITWIDTH_MIN_COLS'))     define('EDITWIDTH_MIN_COLS',     30);
  89 if (!defined('EDITWIDTH_MAX_COLS'))     define('EDITWIDTH_MAX_COLS',    150);
  90 if (!defined('EDITWIDTH_DEFAULT_COLS')) define('EDITWIDTH_DEFAULT_COLS', 80);
  91
  92 if (!defined('EDITHEIGHT_MIN_ROWS'))     define('EDITHEIGHT_MIN_ROWS',      5);
  93 if (!defined('EDITHEIGHT_MAX_ROWS'))     define('EDITHEIGHT_MAX_ROWS',     80);
  94 if (!defined('EDITHEIGHT_DEFAULT_ROWS')) define('EDITHEIGHT_DEFAULT_ROWS', 22);
  95
  96 define('TIMEOFFSET_MIN_HOURS', -26);
  97 define('TIMEOFFSET_MAX_HOURS',  26);
  98 if (!defined('TIMEOFFSET_DEFAULT_HOURS')) define('TIMEOFFSET_DEFAULT_HOURS', 0);
  99
 100 /**
 101  * There are be the following constants in index.php to
 102  * establish login parameters:
 103  *
 104  * ALLOW_ANON_USER         default true
 105  * ALLOW_ANON_EDIT         default true
 106  * ALLOW_BOGO_LOGIN        default true
 107  * ALLOW_USER_PASSWORDS    default true
 108  * PASSWORD_LENGTH_MINIMUM default 6 ?
 109  *
 110  * To require user passwords for editing:
 111  * ALLOW_ANON_USER  = true
 112  * ALLOW_ANON_EDIT  = false   (before named REQUIRE_SIGNIN_BEFORE_EDIT)
 113  * ALLOW_BOGO_LOGIN = false
 114  * ALLOW_USER_PASSWORDS = true
 115  *
 116  * To establish a COMPLETELY private wiki, such as an internal
 117  * corporate one:
 118  * ALLOW_ANON_USER = false
 119  * (and probably require user passwords as described above). In this
 120  * case the user will be prompted to login immediately upon accessing
 121  * any page.
 122  *
 123  * There are other possible combinations, but the typical wiki (such
 124  * as http://PhpWiki.sf.net/phpwiki) would usually just leave all four
 125  * enabled.
 126  *
 127  */
 128
 129 // The last object in the row is the bad guy...
 130 if (!is_array($USER_AUTH_ORDER))
 131     $USER_AUTH_ORDER = array("Forbidden");
 132 else
 133     $USER_AUTH_ORDER[] = "Forbidden";
 134
 135 // Local convenience functions.
 136 function _isAnonUserAllowed() {
 137     return (defined('ALLOW_ANON_USER') && ALLOW_ANON_USER);
 138 }
 139 function _isBogoUserAllowed() {
 140     return (defined('ALLOW_BOGO_LOGIN') && ALLOW_BOGO_LOGIN);
 141 }
 142 function _isUserPasswordsAllowed() {
 143     return (defined('ALLOW_USER_PASSWORDS') && ALLOW_USER_PASSWORDS);
 144 }
 145
 146 // Possibly upgrade userobject functions.
 147 function _determineAdminUserOrOtherUser($UserName) {
 148     // Sanity check. User name is a condition of the definition of the
 149     // _AdminUser, _BogoUser and _passuser.
 150     if (!$UserName)
 151         return $GLOBALS['ForbiddenUser'];
 152
 153     if ($UserName == ADMIN_USER)
 154         return new _AdminUser($UserName);
 155     else
 156         return _determineBogoUserOrPassUser($UserName);
 157 }
 158
 159 function _determineBogoUserOrPassUser($UserName) {
 160     global $ForbiddenUser;
 161
 162     // Sanity check. User name is a condition of the definition of
 163     // _BogoUser and _PassUser.
 164     if (!$UserName)
 165         return $ForbiddenUser;
 166
 167     // Check for password and possibly upgrade user object.
 168     // $_BogoUser = new _BogoUser($UserName);
 169     if (_isBogoUserAllowed()) {
 170         $_BogoUser = new _BogoLoginPassUser($UserName);
 171         if ($_BogoUser->userExists())
 172             return $_BogoUser;
 173     }
 174     if (_isUserPasswordsAllowed()) {
 175         // PassUsers override BogoUsers if a password is stored
 176         if (isset($_BogoUser) and $_BogoUser->_prefs->get('passwd'))
 177             return new _PassUser($UserName,$_BogoUser->_prefs);
 178         else {
 179             $_PassUser = new _PassUser($UserName,isset($_BogoUser) ? $_BogoUser->_prefs : false);
 180             if ($_PassUser->userExists())
 181                 return $_PassUser;
 182         }
 183     }
 184     // No Bogo- or PassUser exists, or
 185     // passwords are not allowed, and bogo is disallowed too.
 186     // (Only the admin can sign in).
 187     return $ForbiddenUser;
 188 }
 189
 190 /**
 191  * Primary WikiUser function, called by lib/main.php.
 192  *
 193  * This determines the user's type and returns an appropriate user
 194  * object. lib/main.php then querys the resultant object for password
 195  * validity as necessary.
 196  *
 197  * If an _AnonUser object is returned, the user may only browse pages
 198  * (and save prefs in a cookie).
 199  *
 200  * To disable access but provide prefs the global $ForbiddenUser class
 201  * is returned. (was previously false)
 202  *
 203  */
 204 function WikiUser ($UserName = '') {
 205     global $ForbiddenUser;
 206
 207     //Maybe: Check sessionvar for username & save username into
 208     //sessionvar (may be more appropriate to do this in lib/main.php).
 209     if ($UserName) {
 210         $ForbiddenUser = new _ForbiddenUser($UserName);
 211         // Found a user name.
 212         return _determineAdminUserOrOtherUser($UserName);
 213     }
 214     elseif (!empty($_SESSION['userid'])) {
 215         // Found a user name.
 216         $ForbiddenUser = new _ForbiddenUser($_SESSION['userid']);
 217         return _determineAdminUserOrOtherUser($_SESSION['userid']);
 218     }
 219     else {
 220         // Check for autologin pref in cookie and possibly upgrade
 221         // user object to another type.
 222         $_AnonUser = new _AnonUser();
 223         if ($UserName = $_AnonUser->_userid && $_AnonUser->_prefs->get('autologin')) {
 224             // Found a user name.
 225             $ForbiddenUser = new _ForbiddenUser($UserName);
 226             return _determineAdminUserOrOtherUser($UserName);
 227         }
 228         else {
 229             $ForbiddenUser = new _ForbiddenUser();
 230             if (_isAnonUserAllowed())
 231                 return $_AnonUser;
 232             return $ForbiddenUser; // User must sign in to browse pages.
 233         }
 234         return $ForbiddenUser;     // User must sign in with a password.
 235     }
 236     /*
 237     trigger_error("DEBUG: Note: End of function reached in WikiUser." . " "
 238                   . "Unexpectedly, an appropriate user class could not be determined.");
 239     return $ForbiddenUser; // Failsafe.
 240     */
 241 }
 242
 243 /**
 244  * WikiUser.php use the name 'WikiUser'
 245  */
 246 function WikiUserClassname() {
 247     return '_WikiUser';
 248 }
 249
 250
 251 /**
 252  * Upgrade olduser by copying properties from user to olduser.
 253  * We are not sure yet, for which php's a simple $this = $user works reliably,
 254  * (on php4 it works ok, on php5 it's currently disallowed on the parser level)
 255  * that's why try it the hard way.
 256  */
 257 function UpgradeUser ($olduser, $user) {
 258     if (isa($user,'_WikiUser') and isa($olduser,'_WikiUser')) {
 259         // populate the upgraded class $olduser with the values from the new user object
 260         //only _auth_level, _current_method, _current_index,
 261         if (!empty($user->_level) and
 262             $user->_level > $olduser->_level)
 263             $olduser->_level = $user->_level;
 264         if (!empty($user->_current_index) and
 265             $user->_current_index > $olduser->_current_index) {
 266             $olduser->_current_index = $user->_current_index;
 267             $olduser->_current_method = $user->_current_method;
 268         }
 269         if (!empty($user->_authmethod))
 270             $olduser->_authmethod = $user->_authmethod;
 271         /*
 272         foreach (get_object_vars($user) as $k => $v) {
 273             if (!empty($v)) $olduser->$k = $v;
 274         }
 275         */
 276         $olduser->hasHomePage(); // revive db handle, because these don't survive sessions
 277         //$GLOBALS['request']->_user = $olduser;
 278         return $olduser;
 279     } else {
 280         return false;
 281     }
 282 }
 283
 284 /**
 285  * Probably not needed, since we use the various user objects methods so far.
 286  * Anyway, here it is, looping through all available objects.
 287  */
 288 function UserExists ($UserName) {
 289     global $request;
 290     if (!($user = $request->getUser()))
 291         $user = WikiUser($UserName);
 292     if (!$user)
 293         return false;
 294     if ($user->userExists($UserName)) {
 295         $request->_user = $user;
 296         return true;
 297     }
 298     if (isa($user,'_BogoUser'))
 299         $user = new _PassUser($UserName,$user->_prefs);
 300     $class = $user->nextClass();
 301     if ($user = new $class($UserName,$user->_prefs)) {
 302         return $user->userExists($UserName);
 303     }
 304     $request->_user = $GLOBALS['ForbiddenUser'];
 305     return false;
 306 }
 307
 308 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
 309
 310 /**
 311  * Base WikiUser class.
 312  */
 313 class _WikiUser
 314 {
 315      var $_userid = '';
 316      var $_level = WIKIAUTH_FORBIDDEN;
 317      var $_prefs = false;
 318      var $_HomePagehandle = false;
 319
 320     // constructor
 321     function _WikiUser($UserName='', $prefs=false) {
 322
 323         $this->_userid = $UserName;
 324         $this->_HomePagehandle = false;
 325         if ($UserName) {
 326             $this->hasHomePage();
 327         }
 328         $this->_level = WIKIAUTH_FORBIDDEN;
 329         if (empty($this->_prefs)) {
 330             if ($prefs) $this->_prefs = $prefs;
 331             else $this->getPreferences();
 332         }
 333     }
 334
 335     function UserName() {
 336         if (!empty($this->_userid))
 337             return $this->_userid;
 338     }
 339
 340     function getPreferences() {
 341         trigger_error("DEBUG: Note: undefined _WikiUser class trying to load prefs." . " "
 342                       . "New subclasses of _WikiUser must override this function.");
 343         return false;
 344     }
 345
 346     function setPreferences($prefs, $id_only) {
 347         trigger_error("DEBUG: Note: undefined _WikiUser class trying to save prefs." . " "
 348                       . "New subclasses of _WikiUser must override this function.");
 349         return false;
 350     }
 351
 352     function userExists() {
 353         return $this->hasHomePage();
 354     }
 355
 356     function checkPass($submitted_password) {
 357         // By definition, an undefined user class cannot sign in.
 358         trigger_error("DEBUG: Warning: undefined _WikiUser class trying to sign in." . " "
 359                       . "New subclasses of _WikiUser must override this function.");
 360         return false;
 361     }
 362
 363     // returns page_handle to user's home page or false if none
 364     function hasHomePage() {
 365         if ($this->_userid) {
 366             if (!empty($this->_HomePagehandle) and is_object($this->_HomePagehandle)) {
 367                 return $this->_HomePagehandle->exists();
 368             }
 369             else {
 370                 // check db again (maybe someone else created it since
 371                 // we logged in.)
 372                 global $request;
 373                 $this->_HomePagehandle = $request->getPage($this->_userid);
 374                 return $this->_HomePagehandle->exists();
 375             }
 376         }
 377         // nope
 378         return false;
 379     }
 380
 381     // innocent helper: case-insensitive position in _auth_methods
 382     function array_position ($string, $array) {
 383         $string = strtolower($string);
 384         for ($found = 0; $found < count($array); $found++) {
 385             if (strtolower($array[$found]) == $string)
 386                 return $found;
 387         }
 388         return false;
 389     }
 390
 391     function nextAuthMethodIndex() {
 392         if (empty($this->_auth_methods))
 393             $this->_auth_methods = $GLOBALS['USER_AUTH_ORDER'];
 394         if (empty($this->_current_index)) {
 395             if (get_class($this) != '_passuser') {
 396                 $this->_current_method = substr(get_class($this),1,-8);
 397                 $this->_current_index = $this->array_position($this->_current_method,
 398                                                               $this->_auth_methods);
 399             } else {
 400                 $this->_current_index = -1;
 401             }
 402         }
 403         $this->_current_index++;
 404         if ($this->_current_index >= count($this->_auth_methods))
 405             return false;
 406         $this->_current_method = $this->_auth_methods[$this->_current_index];
 407         return $this->_current_index;
 408     }
 409
 410     function AuthMethod($index = false) {
 411         return $this->_auth_methods[ $index === false ? 0 : $index];
 412     }
 413
 414     // upgrade the user object
 415     function nextClass() {
 416         if (($next = $this->nextAuthMethodIndex()) !== false) {
 417             $method = $this->AuthMethod($next);
 418             return "_".$method."PassUser";
 419             /*
 420             if ($user = new $class($this->_userid)) {
 421                 // prevent from endless recursion.
 422                 //$user->_current_method = $this->_current_method;
 423                 //$user->_current_index = $this->_current_index;
 424                 $user = UpgradeUser($user, $this);
 425             }
 426             return $user;
 427             */
 428         }
 429         return "_ForbiddenPassUser";
 430     }
 431
 432     //Fixme: for _HttpAuthPassUser
 433     function PrintLoginForm (&$request, $args, $fail_message = false,
 434                              $seperate_page = true) {
 435         include_once('lib/Template.php');
 436         // Call update_locale in case the system's default language is not 'en'.
 437         // (We have no user pref for lang at this point yet, no one is logged in.)
 438         update_locale(DEFAULT_LANGUAGE);
 439         $userid = $this->_userid;
 440         $require_level = 0;
 441         extract($args); // fixme
 442
 443         $require_level = max(0, min(WIKIAUTH_ADMIN, (int)$require_level));
 444
 445         $pagename = $request->getArg('pagename');
 446         $nocache = 1;
 447         $login = new Template('login', $request,
 448                               compact('pagename', 'userid', 'require_level',
 449                                       'fail_message', 'pass_required', 'nocache'));
 450         if ($seperate_page) {
 451             $top = new Template('html', $request,
 452                                 array('TITLE' => _("Sign In")));
 453             return $top->printExpansion($login);
 454         } else {
 455             return $login;
 456         }
 457     }
 458
 459     /** Signed in but probably not password checked.
 460      */
 461     function isSignedIn() {
 462         return (isa($this,'_BogoUser') or isa($this,'_PassUser'));
 463     }
 464
 465     /** This is password checked for sure.
 466      */
 467     function isAuthenticated () {
 468         //return isa($this,'_PassUser');
 469         //return isa($this,'_BogoUser') || isa($this,'_PassUser');
 470         return $this->_level >= WIKIAUTH_BOGO; // hmm.
 471     }
 472
 473     function isAdmin () {
 474         return $this->_level == WIKIAUTH_ADMIN;
 475     }
 476
 477     /** Name or IP for a signed user. UserName could come from a cookie e.g.
 478      */
 479     function getId () {
 480         return ( $this->UserName()
 481                  ? $this->UserName()
 482                  : $GLOBALS['request']->get('REMOTE_ADDR') ); // FIXME: globals
 483     }
 484
 485     /** Name for an authenticated user. No IP here.
 486      */
 487     function getAuthenticatedId() {
 488         return ( $this->isAuthenticated()
 489                  ? $this->_userid
 490                  : ''); //$GLOBALS['request']->get('REMOTE_ADDR') ); // FIXME: globals
 491     }
 492
 493     function hasAuthority ($require_level) {
 494         return $this->_level >= $require_level;
 495     }
 496
 497     /**
 498      * Called on an auth_args POST request, such as login, logout or signin.
 499      */
 500     function AuthCheck ($postargs) {
 501         // Normalize args, and extract.
 502         $keys = array('userid', 'passwd', 'require_level', 'login', 'logout',
 503                       'cancel');
 504         foreach ($keys as $key)
 505             $args[$key] = isset($postargs[$key]) ? $postargs[$key] : false;
 506         extract($args);
 507         $require_level = max(0, min(WIKIAUTH_ADMIN, (int)$require_level));
 508
 509         if ($logout) { // Log out
 510             $GLOBALS['request']->_user = new _AnonUser();
 511             return $GLOBALS['request']->_user;
 512         } elseif ($cancel)
 513             return false;        // User hit cancel button.
 514         elseif (!$login && !$userid)
 515             return false;       // Nothing to do?
 516
 517         $authlevel = $this->checkPass($passwd === false ? '' : $passwd);
 518         if (!$authlevel)
 519             return _("Invalid password or userid.");
 520         elseif ($authlevel < $require_level)
 521             return _("Insufficient permissions.");
 522
 523         // Successful login.
 524         //$user = $GLOBALS['request']->_user;
 525         if (!empty($this->_current_method) and
 526             strtolower(get_class($this)) == '_passuser')
 527         {
 528             // upgrade class
 529             $class = "_" . $this->_current_method . "PassUser";
 530             $user = new $class($userid,$this->_prefs);
 531             /*PHP5 patch*/$this = $user;
 532             $this->_level = $authlevel;
 533             return UpgradeUser($user,$this);
 534         }
 535         $this->_userid = $userid;
 536         $this->_level = $authlevel;
 537         return $this;
 538     }
 539
 540 }
 541
 542 /**
 543  * Not authenticated in user, but he may be signed in. Basicly with view access only.
 544  * prefs are stored in cookies, but only the userid.
 545  */
 546 class _AnonUser
 547 extends _WikiUser
 548 {
 549     var $_level = WIKIAUTH_ANON;        // var in php-5.0.0RC1 deprecated
 550
 551     /** Anon only gets to load and save prefs in a cookie, that's it.
 552      */
 553     function getPreferences() {
 554         global $request;
 555
 556         if (empty($this->_prefs))
 557             $this->_prefs = new UserPreferences;
 558         $UserName = $this->UserName();
 559
 560         // Try to read deprecated 1.3.x style cookies
 561         if ($cookie = $request->cookies->get_old(WIKI_NAME)) {
 562             if (! $unboxedcookie = $this->_prefs->retrieve($cookie)) {
 563                 trigger_error(_("Empty Preferences or format of UserPreferences cookie not recognised.")
 564                               . "\n"
 565                               . sprintf("%s='%s'", WIKI_NAME, $cookie)
 566                               . "\n"
 567                               . _("Default preferences will be used."),
 568                               E_USER_NOTICE);
 569             }
 570             /**
 571              * Only set if it matches the UserName who is
 572              * signing in or if this really is an Anon login (no
 573              * username). (Remember, _BogoUser and higher inherit this
 574              * function too!).
 575              */
 576             if (! $UserName || $UserName == @$unboxedcookie['userid']) {
 577                 $updated = $this->_prefs->updatePrefs($unboxedcookie);
 578                 //$this->_prefs = new UserPreferences($unboxedcookie);
 579                 $UserName = @$unboxedcookie['userid'];
 580                 if (is_string($UserName) and (substr($UserName,0,2) != 's:'))
 581                     $this->_userid = $UserName;
 582                 else
 583                     $UserName = false;
 584             }
 585             // v1.3.8 policy: don't set PhpWiki cookies, only plaintext WIKI_ID cookies
 586             $request->deleteCookieVar(WIKI_NAME);
 587         }
 588         // Try to read deprecated 1.3.4 style cookies
 589         if (! $UserName and ($cookie = $request->cookies->get_old("WIKI_PREF2"))) {
 590             if (! $unboxedcookie = $this->_prefs->retrieve($cookie)) {
 591                 if (! $UserName || $UserName == $unboxedcookie['userid']) {
 592                     $updated = $this->_prefs->updatePrefs($unboxedcookie);
 593                     //$this->_prefs = new UserPreferences($unboxedcookie);
 594                     $UserName = $unboxedcookie['userid'];
 595                     if (is_string($UserName) and (substr($UserName,0,2) != 's:'))
 596                         $this->_userid = $UserName;
 597                     else
 598                         $UserName = false;
 599                 }
 600                 $request->deleteCookieVar("WIKI_PREF2");
 601             }
 602         }
 603         if (! $UserName ) {
 604             // Try reading userid from old PhpWiki cookie formats:
 605             if ($cookie = $request->cookies->get_old('WIKI_ID')) {
 606                 if (is_string($cookie) and (substr($cookie,0,2) != 's:'))
 607                     $UserName = $cookie;
 608                 elseif (is_array($cookie) and !empty($cookie['userid']))
 609                     $UserName = $cookie['userid'];
 610             }
 611             if (! $UserName )
 612                 $request->deleteCookieVar("WIKI_ID");
 613             else
 614                 $this->_userid = $UserName;
 615         }
 616
 617         // initializeTheme() needs at least an empty object
 618         /*
 619          if (empty($this->_prefs))
 620             $this->_prefs = new UserPreferences;
 621         */
 622         return $this->_prefs;
 623     }
 624
 625     /** _AnonUser::setPreferences(): Save prefs in a cookie and session and update all global vars
 626      *
 627      * Allow for multiple wikis in same domain. Encode only the
 628      * _prefs array of the UserPreference object. Ideally the
 629      * prefs array should just be imploded into a single string or
 630      * something so it is completely human readable by the end
 631      * user. In that case stricter error checking will be needed
 632      * when loading the cookie.
 633      */
 634     function setPreferences($prefs, $id_only=false) {
 635         if (!is_object($prefs)) {
 636             if (is_object($this->_prefs)) {
 637                 $updated = $this->_prefs->updatePrefs($prefs);
 638                 $prefs =& $this->_prefs;
 639             } else {
 640                 // update the prefs values from scratch. This could leed to unnecessary
 641                 // side-effects: duplicate emailVerified, ...
 642                 $this->_prefs = new UserPreferences($prefs);
 643                 $updated = true;
 644             }
 645         } else {
 646             if (!isset($this->_prefs))
 647                 $this->_prefs =& $prefs;
 648             else
 649                 $updated = $this->_prefs->isChanged($prefs);
 650         }
 651         if ($updated) {
 652             if ($id_only) {
 653                 global $request;
 654                 // new 1.3.8 policy: no array cookies, only plain userid string as in
 655                 // the pre 1.3.x versions.
 656                 // prefs should be stored besides the session in the homepagehandle or in a db.
 657                 $request->setCookieVar('WIKI_ID', $this->_userid,
 658                                        COOKIE_EXPIRATION_DAYS, COOKIE_DOMAIN);
 659                 //$request->setCookieVar(WIKI_NAME, array('userid' => $prefs->get('userid')),
 660                 //                       COOKIE_EXPIRATION_DAYS, COOKIE_DOMAIN);
 661             }
 662         }
 663         $packed = $prefs->store();
 664         $unpacked = $prefs->unpack($packed);
 665         if (count($unpacked)) {
 666             foreach (array('_method','_select','_update') as $param) {
 667                 if (!empty($this->_prefs->{$param}))
 668                     $prefs->{$param} = $this->_prefs->{$param};
 669             }
 670             $this->_prefs = $prefs;
 671             //FIXME! The following must be done in $request->_setUser(), not here,
 672             // to be able to iterate over multiple users, without tampering the current user.
 673             if (0) {
 674                 global $request;
 675                 $request->_prefs =& $this->_prefs;
 676                 $request->_user->_prefs =& $this->_prefs;
 677                 if (isset($request->_user->_auth_dbi)) {
 678                     $user = $request->_user;
 679                     unset($user->_auth_dbi);
 680                     $request->setSessionVar('wiki_user', $user);
 681                 } else {
 682                     //$request->setSessionVar('wiki_prefs', $this->_prefs);
 683                     $request->setSessionVar('wiki_user', $request->_user);
 684                 }
 685             }
 686         }
 687         return $updated;
 688     }
 689
 690     function userExists() {
 691         return true;
 692     }
 693
 694     function checkPass($submitted_password) {
 695         return false;
 696         // this might happen on a old-style signin button.
 697
 698         // By definition, the _AnonUser does not HAVE a password
 699         // (compared to _BogoUser, who has an EMPTY password).
 700         trigger_error("DEBUG: Warning: _AnonUser unexpectedly asked to checkPass()." . " "
 701                       . "Check isa(\$user, '_PassUser'), or: isa(\$user, '_AdminUser') etc. first." . " "
 702                       . "New subclasses of _WikiUser must override this function.");
 703         return false;
 704     }
 705
 706 }
 707
 708 /**
 709  * Helper class to finish the PassUser auth loop.
 710  * This is added automatically to USER_AUTH_ORDER.
 711  */
 712 class _ForbiddenUser
 713 extends _AnonUser
 714 {
 715     var $_level = WIKIAUTH_FORBIDDEN;
 716
 717     function checkPass($submitted_password) {
 718         return WIKIAUTH_FORBIDDEN;
 719     }
 720
 721     function userExists() {
 722         if ($this->_HomePagehandle) return true;
 723         return false;
 724     }
 725 }
 726 /**
 727  * The PassUser name gets created automatically.
 728  * That's why this class is empty, but must exist.
 729  */
 730 class _ForbiddenPassUser
 731 extends _ForbiddenUser
 732 {
 733     function dummy() {
 734         return;
 735     }
 736 }
 737
 738 /**
 739  * Do NOT extend _BogoUser to other classes, for checkPass()
 740  * security. (In case of defects in code logic of the new class!)
 741  * The intermediate step between anon and passuser.
 742  * We also have the _BogoLoginPassUser class with stricter
 743  * password checking, which fits into the auth loop.
 744  * Note: This class is not called anymore by WikiUser()
 745  */
 746 class _BogoUser
 747 extends _AnonUser
 748 {
 749     function userExists() {
 750         if (isWikiWord($this->_userid)) {
 751             $this->_level = WIKIAUTH_BOGO;
 752             return true;
 753         } else {
 754             $this->_level = WIKIAUTH_ANON;
 755             return false;
 756         }
 757     }
 758
 759     function checkPass($submitted_password) {
 760         // By definition, BogoUser has an empty password.
 761         $this->userExists();
 762         return $this->_level;
 763     }
 764 }
 765
 766 class _PassUser
 767 extends _AnonUser
 768 /**
 769  * Called if ALLOW_USER_PASSWORDS and Anon and Bogo failed.
 770  *
 771  * The classes for all subsequent auth methods extend from this class.
 772  * This handles the auth method type dispatcher according $USER_AUTH_ORDER,
 773  * the three auth method policies first-only, strict and stacked
 774  * and the two methods for prefs: homepage or database,
 775  * if $DBAuthParams['pref_select'] is defined.
 776  *
 777  * Default is PersonalPage auth and prefs.
 778  *
 779  * TODO: email verification
 780  *
 781  * @author: Reini Urban
 782  * @tables: pref
 783  */
 784 {
 785     var $_auth_dbi, $_prefs;
 786     var $_current_method, $_current_index;
 787
 788     // check and prepare the auth and pref methods only once
 789     function _PassUser($UserName='', $prefs=false) {
 790         global $DBAuthParams, $DBParams;
 791         if ($UserName) {
 792             $this->_userid = $UserName;
 793             if ($this->hasHomePage())
 794                 $this->_HomePagehandle = $GLOBALS['request']->getPage($this->_userid);
 795         }
 796         $this->_authmethod = substr(get_class($this),1,-8);
 797         if ($this->_authmethod == 'a') $this->_authmethod = 'admin';
 798         if (! $this->_prefs) {
 799             if ($prefs) $this->_prefs = $prefs;
 800             else $this->getPreferences();
 801         }
 802
 803         // Check the configured Prefs methods
 804         if ( !isset($this->_prefs->_select) and !empty($DBAuthParams['pref_select'])
 805              and in_array($DBParams['dbtype'],array('SQL','ADODB'))) {
 806             $this->_prefs->_method = $DBParams['dbtype'];
 807             $this->getAuthDbh();
 808             // preparate the SELECT statement
 809             $this->_prefs->_select = str_replace('"$userid"','%s',$DBAuthParams['pref_select']);
 810         //} else {
 811         //    unset($this->_prefs->_select);
 812         } else {
 813             $this->_prefs->_method = 'HomePage';
 814         }
 815         if (  !isset($this->_prefs->_update) and !empty($DBAuthParams['pref_update'])
 816              and in_array($DBParams['dbtype'],array('SQL','ADODB'))) {
 817             $this->_prefs->_method = $DBParams['dbtype'];
 818             $this->getAuthDbh();
 819             // preparate the SELECT statement
 820             $this->_prefs->_update = str_replace(array('"$userid"','"$pref_blob"'),
 821                                                  array('%s','%s'),
 822                                              $DBAuthParams['pref_update']);
 823         }
 824
 825         // Upgrade to the next parent _PassUser class. Avoid recursion.
 826         if ( strtolower(get_class($this)) === '_passuser' ) {
 827             //auth policy: Check the order of the configured auth methods
 828             // 1. first-only: Upgrade the class here in the constructor
 829             // 2. old:       ignore USER_AUTH_ORDER and try to use all available methods as
 830             ///              in the previous PhpWiki releases (slow)
 831             // 3. strict:    upgrade the class after checking the user existance in userExists()
 832             // 4. stacked:   upgrade the class after the password verification in checkPass()
 833             // Methods: PersonalPage, HttpAuth, DB, Ldap, Imap, File
 834             if (!defined('USER_AUTH_POLICY')) define('USER_AUTH_POLICY','old');
 835             if (defined('USER_AUTH_POLICY')) {
 836                 // policy 1: only pre-define one method for all users
 837                 if (USER_AUTH_POLICY === 'first-only') {
 838                     $class = $this->nextClass();
 839                     return new $class($UserName,$this->_prefs);
 840                 }
 841                 // use the default behaviour from the previous versions:
 842                 elseif (USER_AUTH_POLICY === 'old') {
 843                     // default: try to be smart
 844                     // On php5 we can directly return and upgrade the Object,
 845                     // before we have to upgrade it manually.
 846                     if (!empty($GLOBALS['PHP_AUTH_USER'])) {
 847                         if (check_php_version(5))
 848                             return new _HttpAuthPassUser($UserName,$this->_prefs);
 849                         else {
 850                             $user = new _HttpAuthPassUser($UserName,$this->_prefs);
 851                             //todo: with php5 comment the following line.
 852                             /*PHP5 patch*/$this = $user;
 853                             return UpgradeUser($user,$this);
 854                         }
 855                     } elseif (!empty($DBAuthParams['auth_check']) and
 856                               (!empty($DBAuthParams['auth_dsn']) or !empty($GLOBALS ['DBParams']['dsn']))) {
 857                         if (check_php_version(5))
 858                             return new _DbPassUser($UserName,$this->_prefs);
 859                         else {
 860                             $user = new _DbPassUser($UserName,$this->_prefs);
 861                             //todo: with php5 comment the following line.
 862                             /*PHP5 patch*/$this = $user;
 863                             return UpgradeUser($user,$this);
 864                         }
 865                     } elseif (defined('LDAP_AUTH_HOST') and defined('LDAP_BASE_DN') and function_exists('ldap_open')) {
 866                         if (check_php_version(5))
 867                             return new _LDAPPassUser($UserName,$this->_prefs);
 868                         else {
 869                             $user = new _LDAPPassUser($UserName,$this->_prefs);
 870                             //todo: with php5 comment the following line.
 871                             /*PHP5 patch*/$this = $user;
 872                             return UpgradeUser($user,$this);
 873                         }
 874                     } elseif (defined('IMAP_AUTH_HOST') and function_exists('imap_open')) {
 875                         if (check_php_version(5))
 876                             return new _IMAPPassUser($UserName,$this->_prefs);
 877                         else {
 878                             $user = new _IMAPPassUser($UserName,$this->_prefs);
 879                             //todo: with php5 comment the following line.
 880                             /*PHP5 patch*/$this = $user;
 881                             return UpgradeUser($user,$this);
 882                         }
 883                     } elseif (defined('AUTH_USER_FILE')) {
 884                         if (check_php_version(5))
 885                             return new _FilePassUser($UserName,$this->_prefs);
 886                         else {
 887                             $user = new _FilePassUser($UserName,$this->_prefs);
 888                             //todo: with php5 comment the following line.
 889                             /*PHP5 patch*/$this = $user;
 890                             return UpgradeUser($user,$this);
 891                         }
 892                     } else {
 893                         if (check_php_version(5))
 894                             return new _PersonalPagePassUser($UserName,$this->_prefs);
 895                         else {
 896                             $user = new _PersonalPagePassUser($UserName,$this->_prefs);
 897                             //todo: with php5 comment the following line.
 898                             /*PHP5 patch*/$this = $user;
 899                             return UpgradeUser($user,$this);
 900                         }
 901                     }
 902                 }
 903                 else
 904                     // else use the page methods defined in _PassUser.
 905                     return $this;
 906             }
 907         }
 908     }
 909
 910     function getAuthDbh () {
 911         global $request, $DBParams, $DBAuthParams;
 912
 913         // session restauration doesn't re-connect to the database automatically, so dirty it here.
 914         if (($DBParams['dbtype'] == 'SQL') and isset($this->_auth_dbi) and
 915              empty($this->_auth_dbi->connection))
 916             unset($this->_auth_dbi);
 917         if (($DBParams['dbtype'] == 'ADODB') and isset($this->_auth_dbi) and
 918              empty($this->_auth_dbi->_connectionID))
 919             unset($this->_auth_dbi);
 920
 921         if (empty($this->_auth_dbi)) {
 922             if ($DBParams['dbtype'] != 'SQL' and $DBParams['dbtype'] != 'ADODB')
 923                 return false;
 924             if (empty($DBAuthParams))
 925                 return false;
 926             if (empty($DBAuthParams['auth_dsn'])) {
 927                 $dbh = $request->getDbh(); // use phpwiki database
 928             } elseif ($DBAuthParams['auth_dsn'] == $DBParams['dsn']) {
 929                 $dbh = $request->getDbh(); // same phpwiki database
 930             } else { // use another external database handle. needs PHP >= 4.1
 931                 $local_params = array_merge($DBParams,$DBAuthParams);
 932                 $local_params['dsn'] = $local_params['auth_dsn'];
 933                 $dbh = WikiDB::open($local_params);
 934             }
 935             $this->_auth_dbi =& $dbh->_backend->_dbh;
 936         }
 937         return $this->_auth_dbi;
 938     }
 939
 940     // not used anymore. have to do the prefix fixing somewhere else
 941     function prepare ($stmt, $variables) {
 942         global $DBParams, $request;
 943         // preparate the SELECT statement, for ADODB and PearDB (MDB not)
 944         $this->getAuthDbh();
 945         $place = ($DBParams['dbtype'] == 'ADODB') ? '%s' : '?';
 946         if (is_array($variables)) {
 947             $new = array();
 948             foreach ($variables as $v) { $new[] = $place; }
 949         } else {
 950             $new = $place;
 951         }
 952         // probably prefix table names if in same database
 953         if (!empty($DBParams['prefix']) and
 954             $this->_auth_dbi === $request->_dbi->_backend->_dbh) {
 955             if (!stristr($DBParams['prefix'],$stmt)) {
 956                 //Do it automatically for the lazy admin? Esp. on sf.net it's nice to have
 957                 trigger_error("TODO: Need to prefix the DBAuthParam tablename in index.php: $stmt",
 958                               E_USER_WARNING);
 959                 $stmt = str_replace(array(" user "," pref "," member "),
 960                                     array(" ".$prefix."user ",
 961                                           " ".$prefix."prefs ",
 962                                           " ".$prefix."member "),$stmt);
 963             }
 964         }
 965         return $this->_auth_dbi->prepare(str_replace($variables,$new,$stmt));
 966     }
 967
 968     function getPreferences() {
 969         if (!empty($this->_prefs->_method)) {
 970             if ($this->_prefs->_method == 'ADODB') {
 971                 _AdoDbPassUser::_AdoDbPassUser($this->_userid,$this->_prefs);
 972                 return _AdoDbPassUser::getPreferences();
 973             } elseif ($this->_prefs->_method == 'SQL') {
 974                 _PearDbPassUser::_PearDbPassUser($this->_userid,$this->_prefs);
 975                 return _PearDbPassUser::getPreferences();
 976             }
 977         }
 978
 979         // We don't necessarily have to read the cookie first. Since
 980         // the user has a password, the prefs stored in the homepage
 981         // cannot be arbitrarily altered by other Bogo users.
 982         _AnonUser::getPreferences();
 983         // User may have deleted cookie, retrieve from his
 984         // PersonalPage if there is one.
 985         if ($this->_HomePagehandle) {
 986             if ($restored_from_page = $this->_prefs->retrieve($this->_HomePagehandle->get('pref'))) {
 987                 $updated = $this->_prefs->updatePrefs($restored_from_page,'init');
 988                 //$this->_prefs = new UserPreferences($restored_from_page);
 989                 return $this->_prefs;
 990             }
 991         }
 992         return $this->_prefs;
 993     }
 994
 995     function setPreferences($prefs, $id_only=false) {
 996         if (!empty($this->_prefs->_method)) {
 997             if ($this->_prefs->_method == 'ADODB') {
 998                 _AdoDbPassUser::_AdoDbPassUser($this->_userid,$prefs);
 999                 return _AdoDbPassUser::setPreferences($prefs, $id_only);
1000             }
1001             elseif ($this->_prefs->_method == 'SQL') {
1002                 _PearDbPassUser::_PearDbPassUser($this->_userid,$prefs);
1003                 return _PearDbPassUser::setPreferences($prefs, $id_only);
1004             }
1005         }
1006         if (_AnonUser::setPreferences($prefs, $id_only)) {
1007             // Encode only the _prefs array of the UserPreference object
1008             if ($this->_HomePagehandle and !$id_only) {
1009                 $this->_HomePagehandle->set('pref', $this->_prefs->store());
1010             }
1011         }
1012         return;
1013     }
1014
1015     function mayChangePass() {
1016         return true;
1017     }
1018
1019     //The default method is getting the password from prefs.
1020     // child methods obtain $stored_password from external auth.
1021     function userExists() {
1022         //if ($this->_HomePagehandle) return true;
1023         $class = $this->nextClass();
1024         while ($user = new $class($this->_userid,$this->_prefs)) {
1025             //todo: with php5 comment the following line:
1026             /*PHP5 patch*/$this = $user;
1027             UpgradeUser($this,$user);
1028             if ($user->userExists()) {
1029                 return true;
1030             }
1031             // prevent endless loop. does this work on all PHP's?
1032             // it just has to set the classname, what it correctly does.
1033             $class = $user->nextClass();
1034             if ($class == "_ForbiddenPassUser")
1035                 return false;
1036         }
1037         return false;
1038     }
1039
1040     //The default method is getting the password from prefs.
1041     // child methods obtain $stored_password from external auth.
1042     function checkPass($submitted_password) {
1043         $stored_password = $this->_prefs->get('passwd');
1044         if ($this->_checkPass($submitted_password, $stored_password)) {
1045             $this->_level = WIKIAUTH_USER;
1046             return $this->_level;
1047         } else {
1048             return $this->_tryNextPass($submitted_password);
1049         }
1050     }
1051
1052     /**
1053      * The basic password checker for all PassUser objects.
1054      * Uses global ENCRYPTED_PASSWD and PASSWORD_LENGTH_MINIMUM.
1055      * Empty passwords are always false!
1056      * PASSWORD_LENGTH_MINIMUM is enforced here and in the preference set method.
1057      * @see UserPreferences::set
1058      *
1059      * DBPassUser password's have their own crypt definition.
1060      * That's why DBPassUser::checkPass() doesn't call this method, if
1061      * the db password method is 'plain', which means that the DB SQL
1062      * statement just returns 1 or 0. To use CRYPT() or PASSWORD() and
1063      * don't store plain passwords in the DB.
1064      *
1065      * TODO: remove crypt() function check from config.php:396 ??
1066      */
1067     function _checkPass($submitted_password, $stored_password) {
1068         if(!empty($submitted_password)) {
1069             if (strlen($stored_password) < PASSWORD_LENGTH_MINIMUM) {
1070                 // Todo. hmm...
1071                 trigger_error(_("The length of the stored password is shorter than the system policy allows. Sorry, you cannot login.\n You have to ask the System Administrator to reset your password."));
1072                 return false;
1073             }
1074             if (strlen($submitted_password) < PASSWORD_LENGTH_MINIMUM)
1075                 return false;
1076             if (defined('ENCRYPTED_PASSWD') && ENCRYPTED_PASSWD) {
1077                 // Verify against encrypted password.
1078                 if (function_exists('crypt')) {
1079                     if (crypt($submitted_password, $stored_password) == $stored_password )
1080                         return true; // matches encrypted password
1081                     else
1082                         return false;
1083                 }
1084                 else {
1085                     trigger_error(_("The crypt function is not available in this version of PHP.") . " "
1086                                   . _("Please set ENCRYPTED_PASSWD to false in index.php and probably change ADMIN_PASSWD."),
1087                                   E_USER_WARNING);
1088                     return false;
1089                 }
1090             }
1091             else {
1092                 // Verify against cleartext password.
1093                 if ($submitted_password == $stored_password)
1094                     return true;
1095                 else {
1096                     // Check whether we forgot to enable ENCRYPTED_PASSWD
1097                     if (function_exists('crypt')) {
1098                         if (crypt($submitted_password, $stored_password) == $stored_password) {
1099                             trigger_error(_("Please set ENCRYPTED_PASSWD to true in index.php."),
1100                                           E_USER_WARNING);
1101                             return true;
1102                         }
1103                     }
1104                 }
1105             }
1106         }
1107         return false;
1108     }
1109
1110     /** The default method is storing the password in prefs.
1111      *  Child methods (DB,File) may store in external auth also, but this
1112      *  must be explicitly enabled.
1113      *  This may be called by plugin/UserPreferences or by ->SetPreferences()
1114      */
1115     function changePass($submitted_password) {
1116         $stored_password = $this->_prefs->get('passwd');
1117         // check if authenticated
1118         if ($this->isAuthenticated() and $stored_password != $submitted_password) {
1119             $this->_prefs->set('passwd',$submitted_password);
1120             //update the storage (session, homepage, ...)
1121             $this->SetPreferences($this->_prefs);
1122             return true;
1123         }
1124         //Todo: return an error msg to the caller what failed?
1125         // same password or no privilege
1126         return false;
1127     }
1128
1129     function _tryNextPass($submitted_password) {
1130         if (USER_AUTH_POLICY === 'strict') {
1131                 $class = $this->nextClass();
1132             if ($user = new $class($this->_userid,$this->_prefs)) {
1133                 if ($user->userExists()) {
1134                     return $user->checkPass($submitted_password);
1135                 }
1136             }
1137         }
1138         if (USER_AUTH_POLICY === 'stacked' or USER_AUTH_POLICY === 'old') {
1139                 $class = $this->nextClass();
1140             if ($user = new $class($this->_userid,$this->_prefs))
1141                 return $user->checkPass($submitted_password);
1142         }
1143         return $this->_level;
1144     }
1145
1146     function _tryNextUser() {
1147         if (USER_AUTH_POLICY === 'strict') {
1148                 $class = $this->nextClass();
1149             while ($user = new $class($this->_userid,$this->_prefs)) {
1150                 //todo: with php5 comment the following line:
1151                 /*PHP5 patch*/$this = $user;
1152                 $user = UpgradeUser($this, $user);
1153                 if ($user->userExists()) {
1154                     return true;
1155                 }
1156                 $class = $this->nextClass();
1157             }
1158         }
1159         return false;
1160     }
1161
1162 }
1163
1164 /** Without stored password. A _BogoLoginPassUser with password
1165  *  is automatically upgraded to a PersonalPagePassUser.
1166  */
1167 class _BogoLoginPassUser
1168 extends _PassUser
1169 {
1170     var $_authmethod = 'BogoLogin';
1171     function userExists() {
1172         if (isWikiWord($this->_userid)) {
1173             $this->_level = WIKIAUTH_BOGO;
1174             return true;
1175         } else {
1176             $this->_level = WIKIAUTH_ANON;
1177             return false;
1178         }
1179     }
1180
1181     /** A BogoLoginUser requires no password at all
1182      *  But if there's one stored, we should prefer PersonalPage instead
1183      */
1184     function checkPass($submitted_password) {
1185         if ($this->_prefs->get('passwd')) {
1186             $user = new _PersonalPagePassUser($this->_userid);
1187             if ($user->checkPass($submitted_password)) {
1188                 //todo: with php5 comment the following line:
1189                 /*PHP5 patch*/$this = $user;
1190                 $user = UpgradeUser($this, $user);
1191                 $this->_level = WIKIAUTH_USER;
1192                 return $this->_level;
1193             } else {
1194                 $this->_level = WIKIAUTH_ANON;
1195                 return $this->_level;
1196             }
1197         }
1198         $this->userExists();
1199         return $this->_level;
1200     }
1201 }
1202
1203
1204 /**
1205  * This class is only to simplify the auth method dispatcher.
1206  * It inherits almost all all methods from _PassUser.
1207  */
1208 class _PersonalPagePassUser
1209 extends _PassUser
1210 {
1211     var $_authmethod = 'PersonalPage';
1212
1213     function userExists() {
1214         return $this->_HomePagehandle and $this->_HomePagehandle->exists();
1215     }
1216
1217     /** A PersonalPagePassUser requires PASSWORD_LENGTH_MINIMUM.
1218      *  BUT if the user already has a homepage with an empty password
1219      *  stored, allow login but warn him to change it.
1220      */
1221     function checkPass($submitted_password) {
1222         if ($this->userExists()) {
1223             $stored_password = $this->_prefs->get('passwd');
1224             if (empty($stored_password)) {
1225                 trigger_error(sprintf(
1226                 _("\nYou stored an empty password in your '%s' page.\n").
1227                 _("Your access permissions are only for a BogoUser.\n").
1228                 _("Please set your password in UserPreferences."),
1229                                         $this->_userid), E_USER_NOTICE);
1230                 $this->_level = WIKIAUTH_BOGO;
1231                 return $this->_level;
1232             }
1233             if ($this->_checkPass($submitted_password, $stored_password))
1234                 return ($this->_level = WIKIAUTH_USER);
1235             return _PassUser::checkPass($submitted_password);
1236         }
1237         return WIKIAUTH_ANON;
1238     }
1239 }
1240
1241 /**
1242  * We have two possibilities here.
1243  * 1) The webserver location is already HTTP protected (usually Basic). Then just
1244  *    use the username and do nothing
1245  * 2) The webserver location is not protected, so we enforce basic HTTP Protection
1246  *    by sending a 401 error and let the client display the login dialog.
1247  *    This makes only sense if HttpAuth is the last method in USER_AUTH_ORDER,
1248  *    since the other methods cannot be transparently called after this enforced
1249  *    external dialog.
1250  *    Try the available auth methods (most likely Bogo) and sent this header back.
1251  *    header('Authorization: Basic '.base64_encode("$userid:$passwd")."\r\n";
1252  */
1253 class _HttpAuthPassUser
1254 extends _PassUser
1255 {
1256     function _HttpAuthPassUser($UserName='',$prefs=false) {
1257         if ($prefs) $this->_prefs = $prefs;
1258         if (!isset($this->_prefs->_method))
1259            _PassUser::_PassUser($UserName);
1260         if ($UserName) $this->_userid = $UserName;
1261         $this->_authmethod = 'HttpAuth';
1262         if ($this->userExists())
1263             return $this;
1264         else
1265             return $GLOBALS['ForbiddenUser'];
1266     }
1267
1268     function _http_username() {
1269         if (!empty($_SERVER['PHP_AUTH_USER']))
1270             return $_SERVER['PHP_AUTH_USER'];
1271         if ($GLOBALS['HTTP_SERVER_VARS']['PHP_AUTH_USER'])
1272             return $GLOBALS['HTTP_SERVER_VARS']['PHP_AUTH_USER'];
1273         if ($GLOBALS['REMOTE_USER'])
1274             return $GLOBALS['REMOTE_USER'];
1275         if ($_ENV['REMOTE_USER'])
1276             return $_ENV['REMOTE_USER'];
1277         return '';
1278     }
1279
1280     //force http auth authorization
1281     function userExists() {
1282         // todo: older php's
1283         $username = $this->_http_username();
1284         if (empty($username) or $username != $this->_userid) {
1285             header('WWW-Authenticate: Basic realm="'.WIKI_NAME.'"');
1286             header('HTTP/1.0 401 Unauthorized');
1287             exit;
1288         }
1289         $this->_userid = $username;
1290         $this->_level = WIKIAUTH_USER;
1291         return $this;
1292     }
1293
1294     function checkPass($submitted_password) {
1295         return $this->userExists() ? WIKIAUTH_USER : WIKIAUTH_ANON;
1296     }
1297
1298     function mayChangePass() {
1299         return false;
1300     }
1301
1302     // hmm... either the server dialog or our own.
1303     function PrintLoginForm (&$request, $args, $fail_message = false,
1304                              $seperate_page = true) {
1305         header('WWW-Authenticate: Basic realm="'.WIKI_NAME.'"');
1306         header('HTTP/1.0 401 Unauthorized');
1307         exit;
1308
1309         include_once('lib/Template.php');
1310         // Call update_locale in case the system's default language is not 'en'.
1311         // (We have no user pref for lang at this point yet, no one is logged in.)
1312         update_locale(DEFAULT_LANGUAGE);
1313         $userid = $this->_userid;
1314         $require_level = 0;
1315         extract($args); // fixme
1316
1317         $require_level = max(0, min(WIKIAUTH_ADMIN, (int)$require_level));
1318
1319         $pagename = $request->getArg('pagename');
1320         $nocache = 1;
1321         $login = new Template('login', $request,
1322                               compact('pagename', 'userid', 'require_level',
1323                                       'fail_message', 'pass_required', 'nocache'));
1324         if ($seperate_page) {
1325             $top = new Template('html', $request,
1326                                 array('TITLE' => _("Sign In")));
1327             return $top->printExpansion($login);
1328         } else {
1329             return $login;
1330         }
1331     }
1332
1333 }
1334
1335
1336 /**
1337  * Baseclass for PearDB and ADODB PassUser's
1338  * Authenticate against a database, to be able to use shared users.
1339  *   internal: no different $DbAuthParams['dsn'] defined, or
1340  *   external: different $DbAuthParams['dsn']
1341  * The magic is done in the symbolic SQL statements in index.php, similar to
1342  * libnss-mysql.
1343  *
1344  * We support only the SQL and ADODB backends.
1345  * The other WikiDB backends (flat, cvs, dba, ...) should be used for pages,
1346  * not for auth stuff. If one would like to use e.g. dba for auth, he should
1347  * use PearDB (SQL) with the right $DBAuthParam['auth_dsn'].
1348  * (Not supported yet, since we require SQL. SQLite would make since when
1349  * it will come to PHP)
1350  *
1351  * @tables: user, pref
1352  *
1353  * Preferences are handled in the parent class _PassUser, because the
1354  * previous classes may also use DB pref_select and pref_update.
1355  *
1356  * Flat files auth is handled by the auth method "File".
1357  */
1358 class _DbPassUser
1359 extends _PassUser
1360 {
1361     var $_authselect, $_authupdate, $_authcreate;
1362
1363     // This can only be called from _PassUser, because the parent class
1364     // sets the auth_dbi and pref methods, before this class is initialized.
1365     function _DbPassUser($UserName='',$prefs=false) {
1366         if (!$this->_prefs) {
1367             if ($prefs) $this->_prefs = $prefs;
1368         }
1369         if (!isset($this->_prefs->_method))
1370            _PassUser::_PassUser($UserName);
1371         $this->_authmethod = 'Db';
1372         //$this->getAuthDbh();
1373         //$this->_auth_crypt_method = @$GLOBALS['DBAuthParams']['auth_crypt_method'];
1374         if ($GLOBALS['DBParams']['dbtype'] == 'ADODB') {
1375             if (check_php_version(5))
1376                 return new _AdoDbPassUser($UserName,$this->_prefs);
1377             else {
1378                 $user = new _AdoDbPassUser($UserName,$this->_prefs);
1379                 //todo: with php5 comment the following line:
1380                 /*PHP5 patch*/$this = $user;
1381                 return UpgradeUser($user, $this);
1382             }
1383         }
1384         elseif ($GLOBALS['DBParams']['dbtype'] == 'SQL') {
1385             if (check_php_version(5))
1386                 return new _PearDbPassUser($UserName,$this->_prefs);
1387             else {
1388                 $user = new _PearDbPassUser($UserName,$this->_prefs);
1389                 //todo: with php5 comment the following line:
1390                 /*PHP5 patch*/$this = $user;
1391                 return UpgradeUser($user, $this);
1392             }
1393         }
1394         return false;
1395     }
1396
1397     function mayChangePass() {
1398         return !isset($this->_authupdate);
1399     }
1400
1401 }
1402
1403 class _PearDbPassUser
1404 extends _DbPassUser
1405 /**
1406  * Pear DB methods
1407  * Now optimized not to use prepare, ...query(sprintf($sql,quote())) instead.
1408  * We use FETCH_MODE_ROW, so we don't need aliases in the auth_* SQL statements.
1409  *
1410  * @tables: user
1411  * @tables: pref
1412  */
1413 {
1414     var $_authmethod = 'PearDb';
1415     function _PearDbPassUser($UserName='',$prefs=false) {
1416         global $DBAuthParams;
1417         if (!$this->_prefs and isa($this,"_PearDbPassUser")) {
1418             if ($prefs) $this->_prefs = $prefs;
1419         }
1420         if (!isset($this->_prefs->_method))
1421             _PassUser::_PassUser($UserName);
1422         $this->_userid = $UserName;
1423         // make use of session data. generally we only initialize this every time,
1424         // but do auth checks only once
1425         $this->_auth_crypt_method = @$DBAuthParams['auth_crypt_method'];
1426         //$this->getAuthDbh();
1427         return $this;
1428     }
1429
1430     function getPreferences() {
1431         // override the generic slow method here for efficiency and not to
1432         // clutter the homepage metadata with prefs.
1433         _AnonUser::getPreferences();
1434         $this->getAuthDbh();
1435         if (isset($this->_prefs->_select)) {
1436             $dbh = &$this->_auth_dbi;
1437             $db_result = $dbh->query(sprintf($this->_prefs->_select,$dbh->quote($this->_userid)));
1438             // patched by frederik@pandora.be
1439             $prefs = $db_result->fetchRow();
1440             $prefs_blob = $prefs["prefs"];
1441             if ($restored_from_db = $this->_prefs->retrieve($prefs_blob)) {
1442                 $updated = $this->_prefs->updatePrefs($restored_from_db);
1443                 //$this->_prefs = new UserPreferences($restored_from_db);
1444                 return $this->_prefs;
1445             }
1446         }
1447         if ($this->_HomePagehandle) {
1448             if ($restored_from_page = $this->_prefs->retrieve($this->_HomePagehandle->get('pref'))) {
1449                 $updated = $this->_prefs->updatePrefs($restored_from_page);
1450                 //$this->_prefs = new UserPreferences($restored_from_page);
1451                 return $this->_prefs;
1452             }
1453         }
1454         return $this->_prefs;
1455     }
1456
1457     function setPreferences($prefs, $id_only=false) {
1458         // if the prefs are changed
1459         if (_AnonUser::setPreferences($prefs, 1)) {
1460             //global $request;
1461             //$user = $request->_user;
1462             //unset($user->_auth_dbi);
1463             // this must be done in $request->_setUser, not here!
1464             //$request->setSessionVar('wiki_user', $user);
1465             $this->getAuthDbh();
1466             $packed = $this->_prefs->store();
1467             if (!$id_only and isset($this->_prefs->_update)) {
1468                 $dbh = &$this->_auth_dbi;
1469                 $dbh->simpleQuery(sprintf($this->_prefs->_update,
1470                                           $dbh->quote($packed),
1471                                           $dbh->quote($this->_userid)));
1472             } else {
1473                 //store prefs in homepage, not in cookie
1474                 if ($this->_HomePagehandle and !$id_only)
1475                     $this->_HomePagehandle->set('pref', $packed);
1476             }
1477             return count($this->_prefs->unpack($packed));
1478         }
1479         return 0;
1480     }
1481
1482     function userExists() {
1483         global $DBAuthParams;
1484         $this->getAuthDbh();
1485         $dbh = &$this->_auth_dbi;
1486         if (!$dbh) { // needed?
1487             return $this->_tryNextUser();
1488         }
1489         // Prepare the configured auth statements
1490         if (!empty($DBAuthParams['auth_check']) and empty($this->_authselect)) {
1491             $this->_authselect = str_replace(array('"$userid"','"$password"'),
1492                                              array('%s','%s'),
1493                                              $DBAuthParams['auth_check']);
1494         }
1495         if (empty($this->_authselect))
1496             trigger_error("Either \$DBAuthParams['auth_check'] is missing or \$DBParams['dbtype'] != 'SQL'",
1497                           E_USER_WARNING);
1498         //NOTE: for auth_crypt_method='crypt' no special auth_user_exists is needed
1499         if ($this->_auth_crypt_method == 'crypt') {
1500             $rs = $dbh->query(sprintf($this->_authselect,$dbh->quote($this->_userid)));
1501             if ($rs->numRows())
1502                 return true;
1503         }
1504         else {
1505             if (! $GLOBALS['DBAuthParams']['auth_user_exists'])
1506                 trigger_error("\$DBAuthParams['auth_user_exists'] is missing",
1507                               E_USER_WARNING);
1508             $this->_authcheck = str_replace('"$userid"','%s',
1509                                              $DBAuthParams['auth_user_exists']);
1510             $rs = $dbh->query(sprintf($this->_authcheck,$dbh->quote($this->_userid)));
1511             if ($rs->numRows())
1512                 return true;
1513         }
1514         // maybe the user is allowed to create himself. Generally not wanted in
1515         // external databases, but maybe wanted for the wiki database, for performance
1516         // reasons
1517         if (empty($this->_authcreate) and !empty($DBAuthParams['auth_create'])) {
1518             $this->_authcreate = str_replace(array('"$userid"','"$password"'),array('%s','%s'),
1519                                               $DBAuthParams['auth_create']);
1520         }
1521         if (!empty($this->_authcreate)) return true;
1522
1523         return $this->_tryNextUser();
1524     }
1525
1526     function checkPass($submitted_password) {
1527         global $DBAuthParams;
1528         $this->getAuthDbh();
1529         if (!$this->_auth_dbi) {  // needed?
1530             return $this->_tryNextPass($submitted_password);
1531         }
1532         if (empty($this->_authselect))
1533             trigger_error("Either \$DBAuthParams['auth_check'] is missing or \$DBParams['dbtype'] != 'SQL'",
1534                           E_USER_WARNING);
1535
1536         //NOTE: for auth_crypt_method='crypt'  defined('ENCRYPTED_PASSWD',true) must be set
1537         $dbh = &$this->_auth_dbi;
1538         if ($this->_auth_crypt_method == 'crypt') {
1539             $stored_password = $dbh->getOne(sprintf($this->_authselect,$dbh->quote($this->_userid)));
1540             $result = $this->_checkPass($submitted_password, $stored_password);
1541         } else {
1542             $okay = $dbh->getOne(sprintf($this->_authselect,
1543                                          $dbh->quote($submitted_password),
1544                                          $dbh->quote($this->_userid)));
1545             $result = !empty($okay);
1546         }
1547
1548         if ($result) {
1549             $this->_level = WIKIAUTH_USER;
1550             return $this->_level;
1551         } else {
1552             return $this->_tryNextPass($submitted_password);
1553         }
1554     }
1555
1556     function mayChangePass() {
1557         global $DBAuthParams;
1558         return !empty($DBAuthParams['auth_update']);
1559     }
1560
1561     function storePass($submitted_password) {
1562         global $DBAuthParams;
1563         $dbh = &$this->_auth_dbi;
1564         if (!empty($DBAuthParams['auth_update']) and empty($this->_authupdate)) {
1565             $this->_authupdate = str_replace(array('"$userid"','"$password"'),
1566                                              array('%s','%s'),
1567                                              $DBAuthParams['auth_update']);
1568         }
1569         if (empty($this->_authupdate)) {
1570             trigger_error("Either \$DBAuthParams['auth_update'] not defined or \$DBParams['dbtype'] != 'SQL'",
1571                           E_USER_WARNING);
1572             return false;
1573         }
1574
1575         if ($this->_auth_crypt_method == 'crypt') {
1576             if (function_exists('crypt'))
1577                 $submitted_password = crypt($submitted_password);
1578         }
1579         $dbh->simpleQuery(sprintf($this->_authupdate,
1580                                   $dbh->quote($submitted_password),
1581                                   $dbh->quote($this->_userid)
1582                                   ));
1583     }
1584
1585 }
1586
1587 class _AdoDbPassUser
1588 extends _DbPassUser
1589 /**
1590  * ADODB methods
1591  * Simple sprintf, no prepare.
1592  *
1593  * Warning: Since we use FETCH_MODE_ASSOC (string hash) and not the also faster
1594  * FETCH_MODE_ROW (numeric), we have to use the correct aliases in auth_* sql statements!
1595  *
1596  * TODO: Change FETCH_MODE in adodb WikiDB sublasses.
1597  *
1598  * @tables: user
1599  */
1600 {
1601     var $_authmethod = 'AdoDb';
1602     function _AdoDbPassUser($UserName='',$prefs=false) {
1603         if (!$this->_prefs and isa($this,"_AdoDbPassUser")) {
1604             if ($prefs) $this->_prefs = $prefs;
1605             if (!isset($this->_prefs->_method))
1606               _PassUser::_PassUser($UserName);
1607         }
1608         $this->_userid = $UserName;
1609         $this->_auth_crypt_method = $GLOBALS['DBAuthParams']['auth_crypt_method'];
1610         $this->getAuthDbh();
1611         // Don't prepare the configured auth statements anymore
1612         return $this;
1613     }
1614
1615     function getPreferences() {
1616         // override the generic slow method here for efficiency
1617         _AnonUser::getPreferences();
1618         $this->getAuthDbh();
1619         if (isset($this->_prefs->_select)) {
1620             $dbh = & $this->_auth_dbi;
1621             $rs = $dbh->Execute(sprintf($this->_prefs->_select,$dbh->qstr($this->_userid)));
1622             if ($rs->EOF) {
1623                 $rs->Close();
1624             } else {
1625                 $prefs_blob = $rs->fields['prefs'];
1626                 $rs->Close();
1627                 if ($restored_from_db = $this->_prefs->retrieve($prefs_blob)) {
1628                     $updated = $this->_prefs->updatePrefs($restored_from_db);
1629                     //$this->_prefs = new UserPreferences($restored_from_db);
1630                     return $this->_prefs;
1631                 }
1632             }
1633         }
1634         if ($this->_HomePagehandle) {
1635             if ($restored_from_page = $this->_prefs->retrieve($this->_HomePagehandle->get('pref'))) {
1636                 $updated = $this->_prefs->updatePrefs($restored_from_page);
1637                 //$this->_prefs = new UserPreferences($restored_from_page);
1638                 return $this->_prefs;
1639             }
1640         }
1641         return $this->_prefs;
1642     }
1643
1644     function setPreferences($prefs, $id_only=false) {
1645         // if the prefs are changed
1646         if (_AnonUser::setPreferences($prefs, 1)) {
1647             global $request;
1648             $packed = $this->_prefs->store();
1649             //$user = $request->_user;
1650             //unset($user->_auth_dbi);
1651             if (!$id_only and isset($this->_prefs->_update)) {
1652                 $this->getAuthDbh();
1653                 $dbh = &$this->_auth_dbi;
1654                 $db_result = $dbh->Execute(sprintf($this->_prefs->_update,
1655                                                    $dbh->qstr($packed),
1656                                                    $dbh->qstr($this->_userid)));
1657                 $db_result->Close();
1658             } else {
1659                 //store prefs in homepage, not in cookie
1660                 if ($this->_HomePagehandle and !$id_only)
1661                     $this->_HomePagehandle->set('pref', $packed);
1662             }
1663             return count($this->_prefs->unpack($packed));
1664         }
1665         return 0;
1666     }
1667
1668     function userExists() {
1669         global $DBAuthParams;
1670         if (empty($this->_authselect) and !empty($DBAuthParams['auth_check'])) {
1671             $this->_authselect = str_replace(array('"$userid"','"$password"'),array('%s','%s'),
1672                                               $DBAuthParams['auth_check']);
1673         }
1674         if (empty($this->_authselect))
1675             trigger_error("Either \$DBAuthParams['auth_check'] is missing or \$DBParams['dbtype'] != 'ADODB'",
1676                           E_USER_WARNING);
1677         //$this->getAuthDbh();
1678         $dbh = &$this->_auth_dbi;
1679         //NOTE: for auth_crypt_method='crypt' no special auth_user_exists is needed
1680         if ($this->_auth_crypt_method == 'crypt') {
1681             $rs = $dbh->Execute(sprintf($this->_authselect,$dbh->qstr($this->_userid)));
1682             if (!$rs->EOF) {
1683                 $rs->Close();
1684                 return true;
1685             } else {
1686                 $rs->Close();
1687             }
1688         }
1689         else {
1690             if (! $DBAuthParams['auth_user_exists'])
1691                 trigger_error("\$DBAuthParams['auth_user_exists'] is missing",
1692                               E_USER_WARNING);
1693             $this->_authcheck = str_replace('"$userid"','%s',
1694                                              $DBAuthParams['auth_user_exists']);
1695             $rs = $dbh->Execute(sprintf($this->_authcheck,$dbh->qstr($this->_userid)));
1696             if (!$rs->EOF) {
1697                 $rs->Close();
1698                 return true;
1699             } else {
1700                 $rs->Close();
1701             }
1702         }
1703         // maybe the user is allowed to create himself. Generally not wanted in
1704         // external databases, but maybe wanted for the wiki database, for performance
1705         // reasons
1706         if (!$this->_authcreate and !empty($DBAuthParams['auth_create'])) {
1707             $this->_authcreate = str_replace(array('"$userid"','"$password"'),array('%s','%s'),
1708                                               $DBAuthParams['auth_create']);
1709         }
1710         if (!empty($this->_authcreate)) return true;
1711
1712         return $this->_tryNextUser();
1713     }
1714
1715     function checkPass($submitted_password) {
1716         global $DBAuthParams;
1717         if (empty($this->_authselect) and !empty($DBAuthParams['auth_check'])) {
1718             $this->_authselect = str_replace(array('"$userid"','"$password"'),array('%s','%s'),
1719                                               $DBAuthParams['auth_check']);
1720         }
1721         if (!isset($this->_authselect))
1722             trigger_error("Either \$DBAuthParams['auth_check'] is missing or \$DBParams['dbtype'] != 'ADODB'",
1723                           E_USER_WARNING);
1724         //$this->getAuthDbh();
1725         $dbh = &$this->_auth_dbi;
1726         //NOTE: for auth_crypt_method='crypt'  defined('ENCRYPTED_PASSWD',true) must be set
1727         if ($this->_auth_crypt_method == 'crypt') {
1728             $rs = $dbh->Execute(sprintf($this->_authselect,$dbh->qstr($this->_userid)));
1729             if (!$rs->EOF) {
1730                 $stored_password = $rs->fields['password'];
1731                 $rs->Close();
1732                 $result = $this->_checkPass($submitted_password, $stored_password);
1733             } else {
1734                 $rs->Close();
1735                 $result = false;
1736             }
1737         }
1738         else {
1739             $rs = $dbh->Execute(sprintf($this->_authselect,
1740                                         $dbh->qstr($submitted_password),
1741                                         $dbh->qstr($this->_userid)));
1742             $okay = $rs->fields['ok'];
1743             $rs->Close();
1744             $result = !empty($okay);
1745         }
1746
1747         if ($result) {
1748             $this->_level = WIKIAUTH_USER;
1749             return $this->_level;
1750         } else {
1751             return $this->_tryNextPass($submitted_password);
1752         }
1753     }
1754
1755     function mayChangePass() {
1756         global $DBAuthParams;
1757         return !empty($DBAuthParams['auth_update']);
1758     }
1759
1760     function storePass($submitted_password) {
1761         global $DBAuthParams;
1762         if (!isset($this->_authupdate) and !empty($DBAuthParams['auth_update'])) {
1763             $this->_authupdate = str_replace(array('"$userid"','"$password"'),array("%s","%s"),
1764                                               $DBAuthParams['auth_update']);
1765         }
1766         if (!isset($this->_authupdate)) {
1767             trigger_error("Either \$DBAuthParams['auth_update'] not defined or \$DBParams['dbtype'] != 'ADODB'",
1768                           E_USER_WARNING);
1769             return false;
1770         }
1771
1772         if ($this->_auth_crypt_method == 'crypt') {
1773             if (function_exists('crypt'))
1774                 $submitted_password = crypt($submitted_password);
1775         }
1776         $this->getAuthDbh();
1777         $dbh = &$this->_auth_dbi;
1778         $rs = $dbh->Execute(sprintf($this->_authupdate,
1779                                     $dbh->qstr($submitted_password),
1780                                     $dbh->qstr($this->_userid)
1781                                     ));
1782         $rs->Close();
1783         return $rs;
1784     }
1785
1786 }
1787
1788 class _LDAPPassUser
1789 extends _PassUser
1790 /**
1791  * Define the vars LDAP_AUTH_HOST and LDAP_BASE_DN in index.php
1792  *
1793  * Preferences are handled in _PassUser
1794  */
1795 {
1796     function checkPass($submitted_password) {
1797         global $LDAP_SET_OPTION;
1798
1799         $this->_authmethod = 'LDAP';
1800         $userid = $this->_userid;
1801         if ($ldap = ldap_connect(LDAP_AUTH_HOST)) { // must be a valid LDAP server!
1802             if (defined('LDAP_AUTH_USER'))
1803                 if (defined('LDAP_AUTH_PASSWORD'))
1804                     // Windows Active Directory Server is strict
1805                     $r = @ldap_bind($ldap,LDAP_AUTH_USER,LDAP_AUTH_PASSWORD);
1806                 else
1807                     $r = @ldap_bind($ldap,LDAP_AUTH_USER);
1808             else
1809                 $r = @ldap_bind($ldap); // this is an anonymous bind
1810             if (!empty($LDAP_SET_OPTION)) {
1811                 foreach ($LDAP_SET_OPTION as $key => $value) {
1812                     ldap_set_option($ldap,$key,$value);
1813                 }
1814             }
1815             // Need to set the right root search information. see ../index.php
1816             $st_search = defined('LDAP_SEARCH_FIELD')
1817                 ? LDAP_SEARCH_FIELD."=$userid"
1818                 : "uid=$userid";
1819             $sr = ldap_search($ldap, LDAP_BASE_DN, $st_search);
1820             $info = ldap_get_entries($ldap, $sr);
1821             // there may be more hits with this userid.
1822             // of course it would be better to narrow down the BASE_DN
1823             for ($i = 0; $i < $info["count"]; $i++) {
1824                 $dn = $info[$i]["dn"];
1825                 // The password is still plain text.
1826                 if ($r = @ldap_bind($ldap, $dn, $submitted_password)) {
1827                     // ldap_bind will return TRUE if everything matches
1828                     ldap_close($ldap);
1829                     $this->_level = WIKIAUTH_USER;
1830                     return $this->_level;
1831                 }
1832             }
1833         } else {
1834             trigger_error(fmt("Unable to connect to LDAP server %s", LDAP_AUTH_HOST),
1835                           E_USER_WARNING);
1836             //return false;
1837         }
1838
1839         return $this->_tryNextPass($submitted_password);
1840     }
1841
1842     function userExists() {
1843         global $LDAP_SET_OPTION;
1844
1845         $userid = $this->_userid;
1846         if ($ldap = ldap_connect(LDAP_AUTH_HOST)) { // must be a valid LDAP server!
1847             if (defined('LDAP_AUTH_USER'))
1848                 if (defined('LDAP_AUTH_PASSWORD'))
1849                     // Windows Active Directory Server is strict
1850                     $r = @ldap_bind($ldap,LDAP_AUTH_USER,LDAP_AUTH_PASSWORD);
1851                 else
1852                     $r = @ldap_bind($ldap,LDAP_AUTH_USER);
1853             else
1854                 $r = @ldap_bind($ldap); // this is an anonymous bind
1855             if (!empty($LDAP_SET_OPTION)) {
1856                 foreach ($LDAP_SET_OPTION as $key => $value) {
1857                     ldap_set_option($ldap,$key,$value);
1858                 }
1859             }
1860             // Need to set the right root search information. see ../index.php
1861             $st_search = defined('LDAP_SEARCH_FIELD')
1862                 ? LDAP_SEARCH_FIELD."=$userid"
1863                 : "uid=$userid";
1864             $sr = ldap_search($ldap, LDAP_BASE_DN, $st_search);
1865             $info = ldap_get_entries($ldap, $sr);
1866
1867             if ($info["count"] > 0) {
1868                 ldap_close($ldap);
1869                 return true;
1870             }
1871         } else {
1872             trigger_error(_("Unable to connect to LDAP server "). LDAP_AUTH_HOST, E_USER_WARNING);
1873         }
1874
1875         return $this->_tryNextUser();
1876     }
1877
1878     function mayChangePass() {
1879         return false;
1880     }
1881
1882 }
1883
1884 class _IMAPPassUser
1885 extends _PassUser
1886 /**
1887  * Define the var IMAP_AUTH_HOST in index.php (with port probably)
1888  *
1889  * Preferences are handled in _PassUser
1890  */
1891 {
1892     function checkPass($submitted_password) {
1893         $userid = $this->_userid;
1894         $mbox = @imap_open( "{" . IMAP_AUTH_HOST . "}",
1895                             $userid, $submitted_password, OP_HALFOPEN );
1896         if ($mbox) {
1897             imap_close($mbox);
1898             $this->_authmethod = 'IMAP';
1899             $this->_level = WIKIAUTH_USER;
1900             return $this->_level;
1901         } else {
1902             trigger_error(_("Unable to connect to IMAP server "). IMAP_AUTH_HOST, E_USER_WARNING);
1903         }
1904
1905         return $this->_tryNextPass($submitted_password);
1906     }
1907
1908     //CHECKME: this will not be okay for the auth policy strict
1909     function userExists() {
1910         return true;
1911         if (checkPass($this->_prefs->get('passwd')))
1912             return true;
1913
1914         return $this->_tryNextUser();
1915     }
1916
1917     function mayChangePass() {
1918         return false;
1919     }
1920 }
1921
1922
1923 class _POP3PassUser
1924 extends _IMAPPassUser {
1925 /**
1926  * Define the var POP3_AUTH_HOST in index.php
1927  * Preferences are handled in _PassUser
1928  */
1929     function checkPass($submitted_password) {
1930         $userid = $this->_userid;
1931         $pass = $submitted_password;
1932         $host = defined('POP3_AUTH_HOST') ? POP3_AUTH_HOST : 'localhost';
1933         $port = defined('POP3_AUTH_PORT') ? POP3_AUTH_PORT : 110;
1934         $retval = false;
1935         $fp = fsockopen($host, $port, $errno, $errstr, 10);
1936         if ($fp) {
1937             // Get welcome string
1938             $line = fgets($fp, 1024);
1939             if (! strncmp("+OK ", $line, 4)) {
1940                 // Send user name
1941                 fputs($fp, "user $user\n");
1942                 // Get response
1943                 $line = fgets($fp, 1024);
1944                 if (! strncmp("+OK ", $line, 4)) {
1945                     // Send password
1946                     fputs($fp, "pass $pass\n");
1947                     // Get response
1948                     $line = fgets($fp, 1024);
1949                     if (! strncmp("+OK ", $line, 4)) {
1950                         $retval = true;
1951                     }
1952                 }
1953             }
1954             // quit the connection
1955             fputs($fp, "quit\n");
1956             // Get the sayonara message
1957             $line = fgets($fp, 1024);
1958             fclose($fp);
1959         }
1960         $this->_authmethod = 'POP3';
1961         if ($retval) {
1962             $this->_level = WIKIAUTH_USER;
1963         } else {
1964             $this->_level = WIKIAUTH_ANON;
1965         }
1966         return $this->_level;
1967     }
1968 }
1969
1970 class _FilePassUser
1971 extends _PassUser
1972 /**
1973  * Check users defined in a .htaccess style file
1974  * username:crypt\n...
1975  *
1976  * Preferences are handled in _PassUser
1977  */
1978 {
1979     var $_file, $_may_change;
1980
1981     // This can only be called from _PassUser, because the parent class
1982     // sets the pref methods, before this class is initialized.
1983     function _FilePassUser($UserName='',$prefs=false,$file='') {
1984         if (!$this->_prefs and isa($this,"_FilePassUser")) {
1985             if ($prefs) $this->_prefs = $prefs;
1986             if (!isset($this->_prefs->_method))
1987               _PassUser::_PassUser($UserName);
1988         }
1989
1990         $this->_userid = $UserName;
1991         // read the .htaccess style file. We use our own copy of the standard pear class.
1992         include_once 'lib/pear/File_Passwd.php';
1993         $this->_may_change = defined('AUTH_USER_FILE_STORABLE') && AUTH_USER_FILE_STORABLE;
1994         if (empty($file) and defined('AUTH_USER_FILE'))
1995             $file = AUTH_USER_FILE;
1996         // if passwords may be changed we have to lock them:
1997         if ($this->_may_change) {
1998             $lock = true;
1999             $lockfile = $file . ".lock";
2000         } else {
2001             $lock = false;
2002             $lockfile = false;
2003         }
2004         // "__PHP_Incomplete_Class"
2005         if (!empty($file) or empty($this->_file) or !isa($this->_file,"File_Passwd"))
2006             $this->_file = new File_Passwd($file, $lock, $lockfile);
2007         else
2008             return false;
2009         return $this;
2010     }
2011
2012     function mayChangePass() {
2013         return $this->_may_change;
2014     }
2015
2016     function userExists() {
2017         $this->_authmethod = 'File';
2018         if (isset($this->_file->users[$this->_userid]))
2019             return true;
2020
2021         return $this->_tryNextUser();
2022     }
2023
2024     function checkPass($submitted_password) {
2025         include_once 'lib/pear/File_Passwd.php';
2026         if ($this->_file->verifyPassword($this->_userid,$submitted_password)) {
2027             $this->_authmethod = 'File';
2028             $this->_level = WIKIAUTH_USER;
2029             return $this->_level;
2030         }
2031
2032         return $this->_tryNextPass($submitted_password);
2033     }
2034
2035     function storePass($submitted_password) {
2036         if ($this->_may_change) {
2037             if ($this->_file->modUser($this->_userid,$submitted_password)) {
2038                 $this->_file->close();
2039                 $this->_file = new File_Passwd($this->_file->_filename, true, $this->_file->lockfile);
2040                 return true;
2041             }
2042         }
2043         return false;
2044     }
2045
2046 }
2047
2048 /**
2049  * Insert more auth classes here...
2050  * For example a customized db class for another db connection
2051  * or a socket-based auth server
2052  *
2053  */
2054
2055
2056 /**
2057  * For security, this class should not be extended. Instead, extend
2058  * from _PassUser (think of this as unix "root").
2059  */
2060 class _AdminUser
2061 extends _PassUser
2062 {
2063     function mayChangePass() {
2064         return false;
2065     }
2066     function checkPass($submitted_password) {
2067         $stored_password = ADMIN_PASSWD;
2068         if ($this->_checkPass($submitted_password, $stored_password)) {
2069             $this->_level = WIKIAUTH_ADMIN;
2070             return $this->_level;
2071         } else {
2072             $this->_level = WIKIAUTH_ANON;
2073             return $this->_level;
2074         }
2075     }
2076     function storePass($submitted_password) {
2077         return false;
2078     }
2079 }
2080
2081 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
2082 /**
2083  * Various data classes for the preference types,
2084  * to support get, set, sanify (range checking, ...)
2085  * update() will do the neccessary side-effects if a
2086  * setting gets changed (theme, language, ...)
2087 */
2088
2089 class _UserPreference
2090 {
2091     var $default_value;
2092
2093     function _UserPreference ($default_value) {
2094         $this->default_value = $default_value;
2095     }
2096
2097     function sanify ($value) {
2098         return (string)$value;
2099     }
2100
2101     function get ($name) {
2102         if (isset($this->{$name}))
2103             return $this->{$name};
2104         else
2105             return $this->default_value;
2106     }
2107
2108     function getraw ($name) {
2109         if (!empty($this->{$name}))
2110             return $this->{$name};
2111     }
2112
2113     // stores the value as $this->$name, and not as $this->value (clever?)
2114     function set ($name, $value) {
2115         if ($this->get($name) != $value) {
2116             $this->update($value);
2117         }
2118         if ($value != $this->default_value) {
2119             $this->{$name} = $value;
2120         }
2121         else
2122             unset($this->{$name});
2123     }
2124
2125     // default: no side-effects
2126     function update ($value) {
2127         ;
2128     }
2129 }
2130
2131 class _UserPreference_numeric
2132 extends _UserPreference
2133 {
2134     function _UserPreference_numeric ($default, $minval = false,
2135                                       $maxval = false) {
2136         $this->_UserPreference((double)$default);
2137         $this->_minval = (double)$minval;
2138         $this->_maxval = (double)$maxval;
2139     }
2140
2141     function sanify ($value) {
2142         $value = (double)$value;
2143         if ($this->_minval !== false && $value < $this->_minval)
2144             $value = $this->_minval;
2145         if ($this->_maxval !== false && $value > $this->_maxval)
2146             $value = $this->_maxval;
2147         return $value;
2148     }
2149 }
2150
2151 class _UserPreference_int
2152 extends _UserPreference_numeric
2153 {
2154     function _UserPreference_int ($default, $minval = false, $maxval = false) {
2155         $this->_UserPreference_numeric((int)$default, (int)$minval, (int)$maxval);
2156     }
2157
2158     function sanify ($value) {
2159         return (int)parent::sanify((int)$value);
2160     }
2161 }
2162
2163 class _UserPreference_bool
2164 extends _UserPreference
2165 {
2166     function _UserPreference_bool ($default = false) {
2167         $this->_UserPreference((bool)$default);
2168     }
2169
2170     function sanify ($value) {
2171         if (is_array($value)) {
2172             /* This allows for constructs like:
2173              *
2174              *   <input type="hidden" name="pref[boolPref][]" value="0" />
2175              *   <input type="checkbox" name="pref[boolPref][]" value="1" />
2176              *
2177              * (If the checkbox is not checked, only the hidden input
2178              * gets sent. If the checkbox is sent, both inputs get
2179              * sent.)
2180              */
2181             foreach ($value as $val) {
2182                 if ($val)
2183                     return true;
2184             }
2185             return false;
2186         }
2187         return (bool) $value;
2188     }
2189 }
2190
2191 class _UserPreference_language
2192 extends _UserPreference
2193 {
2194     function _UserPreference_language ($default = DEFAULT_LANGUAGE) {
2195         $this->_UserPreference($default);
2196     }
2197
2198     // FIXME: check for valid locale
2199     function sanify ($value) {
2200         // Revert to DEFAULT_LANGUAGE if user does not specify
2201         // language in UserPreferences or chooses <system language>.
2202         if ($value == '' or empty($value))
2203             $value = DEFAULT_LANGUAGE;
2204
2205         return (string) $value;
2206     }
2207
2208     function update ($newvalue) {
2209         if (! $this->_init ) {
2210             // invalidate etag to force fresh output
2211             $GLOBALS['request']->setValidators(array('%mtime' => false));
2212             update_locale($newvalue ? $newvalue : $GLOBALS['LANG']);
2213         }
2214     }
2215 }
2216
2217 class _UserPreference_theme
2218 extends _UserPreference
2219 {
2220     function _UserPreference_theme ($default = THEME) {
2221         $this->_UserPreference($default);
2222     }
2223
2224     function sanify ($value) {
2225         if (!empty($value) and FindFile($this->_themefile($value)))
2226             return $value;
2227         return $this->default_value;
2228     }
2229
2230     function update ($newvalue) {
2231         global $Theme;
2232         // invalidate etag to force fresh output
2233         if (! $this->_init )
2234             $GLOBALS['request']->setValidators(array('%mtime' => false));
2235         if ($newvalue)
2236             include_once($this->_themefile($newvalue));
2237         if (empty($Theme))
2238             include_once($this->_themefile(THEME));
2239     }
2240
2241     function _themefile ($theme) {
2242         return "themes/$theme/themeinfo.php";
2243     }
2244 }
2245
2246 class _UserPreference_notify
2247 extends _UserPreference
2248 {
2249     function sanify ($value) {
2250         if (!empty($value))
2251             return $value;
2252         else
2253             return $this->default_value;
2254     }
2255
2256     /** update to global user prefs: side-effect on set notify changes
2257      * use a global_data notify hash:
2258      * notify = array('pagematch' => array(userid => ('email' => mail,
2259      *                                                'verified' => 0|1),
2260      *                                     ...),
2261      *                ...);
2262      */
2263     function update ($value) {
2264         if (!empty($this->_init)) return;
2265         $dbh = $GLOBALS['request']->getDbh();
2266         $notify = $dbh->get('notify');
2267         if (empty($notify))
2268             $data = array();
2269         else
2270             $data = & $notify;
2271         // expand to existing pages only or store matches?
2272         // for now we store (glob-style) matches which is easier for the user
2273         $pages = $this->_page_split($value);
2274         // Limitation: only current user.
2275         $user = $GLOBALS['request']->getUser();
2276         $userid = $user->UserName();
2277         $email  = $user->_prefs->get('email');
2278         $verified = $user->_prefs->_prefs['email']->getraw('emailVerified');
2279         // check existing notify hash and possibly delete pages for email
2280         if (!empty($data)) {
2281             foreach ($data as $page => $users) {
2282                 if (isset($data[$page][$userid]) and !in_array($page, $pages)) {
2283                     unset($data[$page][$userid]);
2284                 }
2285                 if (count($data[$page]) == 0)
2286                     unset($data[$page]);
2287             }
2288         }
2289         // add the new pages
2290         if (!empty($pages)) {
2291             foreach ($pages as $page) {
2292                 if (!isset($data[$page]))
2293                     $data[$page] = array();
2294                 if (!isset($data[$page][$userid])) {
2295                     // should we really store the verification notice here or
2296                     // check it dynamically at every page->save?
2297                     if ($verified) {
2298                         $data[$page][$userid] = array('email' => $email,
2299                                                       'verified' => $verified);
2300                     } else {
2301                         $data[$page][$userid] = array('email' => $email);
2302                     }
2303                 }
2304             }
2305         }
2306         // store users changes
2307         $dbh->set('notify',$data);
2308     }
2309
2310     /** split the user-given comma or whitespace delimited pagenames
2311      *  to array
2312      */
2313     function _page_split($value) {
2314         return preg_split('/[\s,]+/',$value,-1,PREG_SPLIT_NO_EMPTY);
2315     }
2316 }
2317
2318 class _UserPreference_email
2319 extends _UserPreference
2320 {
2321     function sanify ($value) {
2322         // check for valid email address
2323         if ($this->get('email') == $value and $this->getraw('emailVerified'))
2324             return $value;
2325         list($ok,$msg) = ValidateMail($value,'noconnect');
2326         if ($ok) {
2327             return $value;
2328         } else {
2329             trigger_error($msg, E_USER_WARNING);
2330             return $this->default_value;
2331         }
2332     }
2333
2334     /** Side-effect on email changes:
2335      * Send a verification mail or for now just a notification email.
2336      * For true verification (value = 2), we'd need a mailserver hook.
2337      */
2338     function update ($value) {
2339         if (!empty($this->_init)) return;
2340         $verified = $this->getraw('emailVerified');
2341         if (!empty($value) and !$verified) {
2342             list($ok,$msg) = ValidateMail($value);
2343             if ($ok and mail($value,"[".WIKI_NAME ."] "._("Email Verification"),
2344                      sprintf(_("Welcome to %s!\nYou email account is verified and\nwill be used to send pagechange notifications.\nSee %s"),
2345                              WIKI_NAME, WikiUrl($GLOBALS['request']->getArg('pagename'),'',true))))
2346                 $this->set('emailVerified',1);
2347         }
2348     }
2349 }
2350
2351 /** Check for valid email address
2352     fixed version from http://www.zend.com/zend/spotlight/ev12apr.php
2353  */
2354 function ValidateMail($email, $noconnect=false) {
2355     $HTTP_HOST = $_SERVER['HTTP_HOST'];
2356     $result = array();
2357     // well, technically ".a.a.@host.com" is also valid
2358     if (!eregi("^[_a-z0-9-]+(\.[_a-z0-9-]+)*@[a-z0-9-]+(\.[a-z0-9-]+)*(\.[a-z]{2,3})$", $email)) {
2359         $result[0] = false;
2360         $result[1] = "$email is not properly formatted";
2361         return $result;
2362     }
2363     if ($noconnect)
2364       return array(true,"$email is properly formatted");
2365
2366     list ( $Username, $Domain ) = split ("@",$email);
2367     //Todo: getmxrr workaround on windows or manual input field to verify it manually
2368     if (!isWindows() and getmxrr($Domain, $MXHost)) { // avoid warning on Windows.
2369         $ConnectAddress = $MXHost[0];
2370     } else {
2371         $ConnectAddress = $Domain;
2372     }
2373     $Connect = fsockopen ( $ConnectAddress, 25 );
2374     if ($Connect) {
2375         if (ereg("^220", $Out = fgets($Connect, 1024))) {
2376             fputs ($Connect, "HELO $HTTP_HOST\r\n");
2377             $Out = fgets ( $Connect, 1024 );
2378             fputs ($Connect, "MAIL FROM: <".$email.">\r\n");
2379             $From = fgets ( $Connect, 1024 );
2380             fputs ($Connect, "RCPT TO: <".$email.">\r\n");
2381             $To = fgets ($Connect, 1024);
2382             fputs ($Connect, "QUIT\r\n");
2383             fclose($Connect);
2384             if (!ereg ("^250", $From)) {
2385                 $result[0]=false;
2386                 $result[1]="Server rejected address: ". $From;
2387                 return $result;
2388             }
2389             if (!ereg ( "^250", $To )) {
2390                 $result[0]=false;
2391                 $result[1]="Server rejected address: ". $To;
2392                 return $result;
2393             }
2394         } else {
2395             $result[0] = false;
2396             $result[1] = "No response from server";
2397             return $result;
2398           }
2399     }  else {
2400         $result[0]=false;
2401         $result[1]="Can not connect E-Mail server.";
2402         return $result;
2403     }
2404     $result[0]=true;
2405     $result[1]="$email appears to be valid.";
2406     return $result;
2407 } // end of function
2408
2409 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
2410
2411 /**
2412  * UserPreferences
2413  *
2414  * This object holds the $request->_prefs subobjects.
2415  * A simple packed array of non-default values get's stored as cookie,
2416  * homepage, or database, which are converted to the array of
2417  * ->_prefs objects.
2418  * We don't store the objects, because otherwise we will
2419  * not be able to upgrade any subobject. And it's a waste of space also.
2420  *
2421  */
2422 class UserPreferences
2423 {
2424     function UserPreferences($saved_prefs = false) {
2425         // userid stored too, to ensure the prefs are being loaded for
2426         // the correct (currently signing in) userid if stored in a
2427         // cookie.
2428         // Update: for db prefs we disallow passwd.
2429         // userid is needed for pref reflexion. current pref must know its username,
2430         // if some app needs prefs from different users, different from current user.
2431         $this->_prefs
2432             = array(
2433                     'userid'        => new _UserPreference(''),
2434                     'passwd'        => new _UserPreference(''),
2435                     'autologin'     => new _UserPreference_bool(),
2436                     //'emailVerified' => new _UserPreference_emailVerified(),
2437                     //fixed: store emailVerified as email parameter
2438                     'email'         => new _UserPreference_email(''),
2439                     'notifyPages'   => new _UserPreference_notify(''),
2440                     'theme'         => new _UserPreference_theme(THEME),
2441                     'lang'          => new _UserPreference_language(DEFAULT_LANGUAGE),
2442                     'editWidth'     => new _UserPreference_int(EDITWIDTH_DEFAULT_COLS,
2443                                                                EDITWIDTH_MIN_COLS,
2444                                                                EDITWIDTH_MAX_COLS),
2445                     'noLinkIcons'   => new _UserPreference_bool(),
2446                     'editHeight'    => new _UserPreference_int(EDITHEIGHT_DEFAULT_ROWS,
2447                                                                EDITHEIGHT_MIN_ROWS,
2448                                                                EDITHEIGHT_DEFAULT_ROWS),
2449                     'timeOffset'    => new _UserPreference_numeric(TIMEOFFSET_DEFAULT_HOURS,
2450                                                                    TIMEOFFSET_MIN_HOURS,
2451                                                                    TIMEOFFSET_MAX_HOURS),
2452                     'relativeDates' => new _UserPreference_bool()
2453                     );
2454         // add custom theme-specific pref types:
2455         // FIXME: on theme changes the wiki_user session pref object will fail.
2456         // We will silently ignore this.
2457         if (!empty($customUserPreferenceColumns))
2458             $this->_prefs = array_merge($this->_prefs,$customUserPreferenceColumns);
2459
2460         if (isset($this->_method) and $this->_method == 'SQL') {
2461             //unset($this->_prefs['userid']);
2462             unset($this->_prefs['passwd']);
2463         }
2464
2465         if (is_array($saved_prefs)) {
2466             foreach ($saved_prefs as $name => $value)
2467                 $this->set($name, $value);
2468         }
2469     }
2470
2471     function _getPref($name) {
2472         if ($name == 'emailVerified')
2473             $name = 'email';
2474         if (!isset($this->_prefs[$name])) {
2475             if ($name == 'passwd2') return false;
2476             trigger_error("$name: unknown preference", E_USER_NOTICE);
2477             return false;
2478         }
2479         return $this->_prefs[$name];
2480     }
2481
2482     // get the value or default_value of the subobject
2483     function get($name) {
2484         if ($_pref = $this->_getPref($name))
2485             if ($name == 'emailVerified')
2486                 return $_pref->getraw($name);
2487             else
2488                 return $_pref->get($name);
2489         else
2490             return false;
2491     }
2492
2493     // check and set the new value in the subobject
2494     function set($name, $value) {
2495         $pref = $this->_getPref($name);
2496         if ($pref === false)
2497             return false;
2498
2499         /* do it here or outside? */
2500         if ($name == 'passwd' and
2501             defined('PASSWORD_LENGTH_MINIMUM') and
2502             strlen($value) <= PASSWORD_LENGTH_MINIMUM ) {
2503             //TODO: How to notify the user?
2504             return false;
2505         }
2506         /*
2507         if ($name == 'theme' and $value == '')
2508            return true;
2509         */
2510         if (!isset($pref->{$value}) or $pref->{$value} != $pref->default_value) {
2511             if ($name == 'emailVerified') $newvalue = $value;
2512             else $newvalue = $pref->sanify($value);
2513             $pref->set($name,$newvalue);
2514         }
2515         $this->_prefs[$name] =& $pref;
2516         return true;
2517     }
2518     /**
2519      * use init to avoid update on set
2520      */
2521     function updatePrefs($prefs, $init = false) {
2522         $count = 0;
2523         if ($init) $this->_init = $init;
2524         if (is_object($prefs)) {
2525             $type = 'emailVerified'; $obj =& $this->_prefs['email'];
2526             $obj->_init = $init;
2527             if ($obj->get($type) !== $prefs->get($type)) {
2528                 $obj->set($type,$prefs->get($type));
2529                 $count++;
2530             }
2531             foreach (array_keys($this->_prefs) as $type) {
2532                 $obj =& $this->_prefs[$type];
2533                 $obj->_init = $init;
2534                 if ($this->_prefs[$type]->get($type) !== $prefs->get($type)) {
2535                     $this->_prefs[$type]->set($type,$prefs->get($type));
2536                     $count++;
2537                 }
2538             }
2539         } elseif (is_array($prefs)) {
2540             //unset($this->_prefs['userid']);
2541             if (isset($this->_method) and $this->_method == 'SQL') {
2542                 unset($this->_prefs['passwd']);
2543             }
2544             $type = 'emailVerified'; $obj =& $this->_prefs['email'];
2545             $obj->_init = $init;
2546             if (isset($prefs[$type]) and $obj->get($type) !== $prefs[$type]) {
2547                 $obj->set($type,$prefs[$type]);
2548                 $count++;
2549             }
2550             foreach (array_keys($this->_prefs) as $type) {
2551                 $obj =& $this->_prefs[$type];
2552                 $obj->_init = $init;
2553                 if (isset($prefs[$type]) and $obj->get($type) != $prefs[$type]) {
2554                     $obj->set($type,$prefs[$type]);
2555                     $count++;
2556                 }
2557             }
2558         }
2559         return $count;
2560     }
2561
2562     // for now convert just array of objects => array of values
2563     // Todo: the specialized subobjects must override this.
2564     function store() {
2565         $prefs = array();
2566         foreach ($this->_prefs as $name => $object) {
2567             if ($value = $object->getraw($name))
2568                 $prefs[$name] = $value;
2569             if ($name == 'email' and ($value = $object->getraw('emailVerified')))
2570                 $prefs['emailVerified'] = $value;
2571         }
2572         return $this->pack($prefs);
2573     }
2574
2575     // packed string or array of values => array of values
2576     // Todo: the specialized subobjects must override this.
2577     function retrieve($packed) {
2578         if (is_string($packed) and (substr($packed, 0, 2) == "a:"))
2579             $packed = unserialize($packed);
2580         if (!is_array($packed)) return false;
2581         $prefs = array();
2582         foreach ($packed as $name => $packed_pref) {
2583             if (is_string($packed_pref) and substr($packed_pref, 0, 2) == "O:") {
2584                 //legacy: check if it's an old array of objects
2585                 // Looks like a serialized object.
2586                 // This might fail if the object definition does not exist anymore.
2587                 // object with ->$name and ->default_value vars.
2588                 $pref =  @unserialize($packed_pref);
2589                 if (empty($pref))
2590                     $pref = @unserialize(base64_decode($packed_pref));
2591                 $prefs[$name] = $pref->get($name);
2592             // fix old-style prefs
2593             } elseif (is_numeric($name) and is_array($packed_pref)) {
2594                 if (count($packed_pref) == 1) {
2595                     list($name,$value) = each($packed_pref);
2596                     $prefs[$name] = $value;
2597                 }
2598             } else {
2599                 $prefs[$name] = @unserialize($packed_pref);
2600                 if (empty($prefs[$name]))
2601                     $prefs[$name] = @unserialize(base64_decode($packed_pref));
2602                 // patched by frederik@pandora.be
2603                 if (empty($prefs[$name]))
2604                     $prefs[$name] = $packed_pref;
2605             }
2606         }
2607         return $prefs;
2608     }
2609
2610     /**
2611      * Check if the given prefs object is different from the current prefs object
2612      */
2613     function isChanged($other) {
2614         foreach ($this->_prefs as $type => $obj) {
2615             if ($obj->get($type) !== $other->get($type))
2616                 return true;
2617         }
2618         return false;
2619     }
2620
2621     // array of objects
2622     function getAll() {
2623         return $this->_prefs;
2624     }
2625
2626     function pack($nonpacked) {
2627         return serialize($nonpacked);
2628     }
2629
2630     function unpack($packed) {
2631         if (!$packed)
2632             return false;
2633         //$packed = base64_decode($packed);
2634         if (substr($packed, 0, 2) == "O:") {
2635             // Looks like a serialized object
2636             return unserialize($packed);
2637         }
2638         if (substr($packed, 0, 2) == "a:") {
2639             return unserialize($packed);
2640         }
2641         //trigger_error("DEBUG: Can't unpack bad UserPreferences",
2642         //E_USER_WARNING);
2643         return false;
2644     }
2645
2646     function hash () {
2647         return hash($this->_prefs);
2648     }
2649 }
2650
2651 /** TODO: new pref storage classes
2652  *  These are currently user specific and should be rewritten to be pref specific.
2653  *  i.e. $this == $user->_prefs
2654  */
2655 class CookieUserPreferences
2656 extends UserPreferences
2657 {
2658     function CookieUserPreferences ($saved_prefs = false) {
2659         //_AnonUser::_AnonUser('',$saved_prefs);
2660         UserPreferences::UserPreferences($saved_prefs);
2661     }
2662 }
2663
2664 class PageUserPreferences
2665 extends UserPreferences
2666 {
2667     function PageUserPreferences ($saved_prefs = false) {
2668         UserPreferences::UserPreferences($saved_prefs);
2669     }
2670 }
2671
2672 class PearDbUserPreferences
2673 extends UserPreferences
2674 {
2675     function PearDbUserPreferences ($saved_prefs = false) {
2676         UserPreferences::UserPreferences($saved_prefs);
2677     }
2678 }
2679
2680 class AdoDbUserPreferences
2681 extends UserPreferences
2682 {
2683     function AdoDbUserPreferences ($saved_prefs = false) {
2684         UserPreferences::UserPreferences($saved_prefs);
2685     }
2686     function getPreferences() {
2687         // override the generic slow method here for efficiency
2688         _AnonUser::getPreferences();
2689         $this->getAuthDbh();
2690         if (isset($this->_select)) {
2691             $dbh = & $this->_auth_dbi;
2692             $rs = $dbh->Execute(sprintf($this->_select,$dbh->qstr($this->_userid)));
2693             if ($rs->EOF) {
2694                 $rs->Close();
2695             } else {
2696                 $prefs_blob = $rs->fields['pref_blob'];
2697                 $rs->Close();
2698                 if ($restored_from_db = $this->_prefs->retrieve($prefs_blob)) {
2699                     $updated = $this->_prefs->updatePrefs($restored_from_db);
2700                     //$this->_prefs = new UserPreferences($restored_from_db);
2701                     return $this->_prefs;
2702                 }
2703             }
2704         }
2705         if (empty($this->_prefs->_prefs) and $this->_HomePagehandle) {
2706             if ($restored_from_page = $this->_prefs->retrieve($this->_HomePagehandle->get('pref'))) {
2707                 $updated = $this->_prefs->updatePrefs($restored_from_page);
2708                 //$this->_prefs = new UserPreferences($restored_from_page);
2709                 return $this->_prefs;
2710             }
2711         }
2712         return $this->_prefs;
2713     }
2714 }
2715
2716
2717 // $Log: not supported by cvs2svn $
2718 // Revision 1.48  2004/04/06 20:00:10  rurban
2719 // Cleanup of special PageList column types
2720 // Added support of plugin and theme specific Pagelist Types
2721 // Added support for theme specific UserPreferences
2722 // Added session support for ip-based throttling
2723 //   sql table schema change: ALTER TABLE session ADD sess_ip CHAR(15);
2724 // Enhanced postgres schema
2725 // Added DB_Session_dba support
2726 //
2727 // Revision 1.47  2004/04/02 15:06:55  rurban
2728 // fixed a nasty ADODB_mysql session update bug
2729 // improved UserPreferences layout (tabled hints)
2730 // fixed UserPreferences auth handling
2731 // improved auth stability
2732 // improved old cookie handling: fixed deletion of old cookies with paths
2733 //
2734 // Revision 1.46  2004/04/01 06:29:51  rurban
2735 // better wording
2736 // RateIt also for ADODB
2737 //
2738 // Revision 1.45  2004/03/30 02:14:03  rurban
2739 // fixed yet another Prefs bug
2740 // added generic PearDb_iter
2741 // $request->appendValidators no so strict as before
2742 // added some box plugin methods
2743 // PageList commalist for condensed output
2744 //
2745 // Revision 1.44  2004/03/27 22:01:03  rurban
2746 // two catches by Konstantin Zadorozhny
2747 //
2748 // Revision 1.43  2004/03/27 19:40:09  rurban
2749 // init fix and validator reset
2750 //
2751 // Revision 1.40  2004/03/25 22:54:31  rurban
2752 // fixed HttpAuth
2753 //
2754 // Revision 1.38  2004/03/25 17:37:36  rurban
2755 // helper to patch to and from php5 (workaround for stricter parser, no macros in php)
2756 //
2757 // Revision 1.37  2004/03/25 17:00:31  rurban
2758 // more code to convert old-style pref array to new hash
2759 //
2760 // Revision 1.36  2004/03/24 19:39:02  rurban
2761 // php5 workaround code (plus some interim debugging code in XmlElement)
2762 //   php5 doesn't work yet with the current XmlElement class constructors,
2763 //   WikiUserNew does work better than php4.
2764 // rewrote WikiUserNew user upgrading to ease php5 update
2765 // fixed pref handling in WikiUserNew
2766 // added Email Notification
2767 // added simple Email verification
2768 // removed emailVerify userpref subclass: just a email property
2769 // changed pref binary storage layout: numarray => hash of non default values
2770 // print optimize message only if really done.
2771 // forced new cookie policy: delete pref cookies, use only WIKI_ID as plain string.
2772 //   prefs should be stored in db or homepage, besides the current session.
2773 //
2774 // Revision 1.35  2004/03/18 22:18:31  rurban
2775 // workaround for php5 object upgrading problem
2776 //
2777 // Revision 1.34  2004/03/18 21:41:09  rurban
2778 // fixed sqlite support
2779 // WikiUserNew: PHP5 fixes: don't assign $this (untested)
2780 //
2781 // Revision 1.33  2004/03/16 15:42:04  rurban
2782 // more fixes for undefined property warnings
2783 //
2784 // Revision 1.32  2004/03/14 16:30:52  rurban
2785 // db-handle session revivification, dba fixes
2786 //
2787 // Revision 1.31  2004/03/12 23:20:58  rurban
2788 // pref fixes (base64)
2789 //
2790 // Revision 1.30  2004/03/12 20:59:17  rurban
2791 // important cookie fix by Konstantin Zadorozhny
2792 // new editpage feature: JS_SEARCHREPLACE
2793 //
2794 // Revision 1.29  2004/03/11 13:30:47  rurban
2795 // fixed File Auth for user and group
2796 // missing only getMembersOf(Authenticated Users),getMembersOf(Every),getMembersOf(Signed Users)
2797 //
2798 // Revision 1.28  2004/03/08 18:17:09  rurban
2799 // added more WikiGroup::getMembersOf methods, esp. for special groups
2800 // fixed $LDAP_SET_OPTIONS
2801 // fixed _AuthInfo group methods
2802 //
2803 // Revision 1.27  2004/03/01 09:35:13  rurban
2804 // fixed DbPassuser pref init; lost userid
2805 //
2806 // Revision 1.26  2004/02/29 04:10:56  rurban
2807 // new POP3 auth (thanks to BiloBilo: pentothal at despammed dot com)
2808 // fixed syntax error in index.php
2809 //
2810 // Revision 1.25  2004/02/28 22:25:07  rurban
2811 // First PagePerm implementation:
2812 //
2813 // $Theme->setAnonEditUnknownLinks(false);
2814 //
2815 // Layout improvement with dangling links for mostly closed wiki's:
2816 // If false, only users with edit permissions will be presented the
2817 // special wikiunknown class with "?" and Tooltip.
2818 // If true (default), any user will see the ?, but will be presented
2819 // the PrintLoginForm on a click.
2820 //
2821 // Revision 1.24  2004/02/28 21:14:08  rurban
2822 // generally more PHPDOC docs
2823 //   see http://xarch.tu-graz.ac.at/home/rurban/phpwiki/xref/
2824 // fxied WikiUserNew pref handling: empty theme not stored, save only
2825 //   changed prefs, sql prefs improved, fixed password update,
2826 //   removed REPLACE sql (dangerous)
2827 // moved gettext init after the locale was guessed
2828 // + some minor changes
2829 //
2830 // Revision 1.23  2004/02/27 13:21:17  rurban
2831 // several performance improvements, esp. with peardb
2832 // simplified loops
2833 // storepass seperated from prefs if defined so
2834 // stacked and strict still not working
2835 //
2836 // Revision 1.22  2004/02/27 05:15:40  rurban
2837 // more stability. detected by Micki
2838 //
2839 // Revision 1.21  2004/02/26 20:43:49  rurban
2840 // new HttpAuthPassUser class (forces http auth if in the auth loop)
2841 // fixed user upgrade: don't return _PassUser in the first hand.
2842 //
2843 // Revision 1.20  2004/02/26 01:29:11  rurban
2844 // important fixes: endless loops in certain cases. minor rewrite
2845 //
2846 // Revision 1.19  2004/02/25 17:15:17  rurban
2847 // improve stability
2848 //
2849 // Revision 1.18  2004/02/24 15:20:05  rurban
2850 // fixed minor warnings: unchecked args, POST => Get urls for sortby e.g.
2851 //
2852 // Revision 1.17  2004/02/17 12:16:42  rurban
2853 // started with changePass support. not yet used.
2854 //
2855 // Revision 1.16  2004/02/15 22:23:45  rurban
2856 // oops, fixed showstopper (endless recursion)
2857 //
2858 // Revision 1.15  2004/02/15 21:34:37  rurban
2859 // PageList enhanced and improved.
2860 // fixed new WikiAdmin... plugins
2861 // editpage, Theme with exp. htmlarea framework
2862 //   (htmlarea yet committed, this is really questionable)
2863 // WikiUser... code with better session handling for prefs
2864 // enhanced UserPreferences (again)
2865 // RecentChanges for show_deleted: how should pages be deleted then?
2866 //
2867 // Revision 1.14  2004/02/15 17:30:13  rurban
2868 // workaround for lost db connnection handle on session restauration (->_auth_dbi)
2869 // fixed getPreferences() (esp. from sessions)
2870 // fixed setPreferences() (update and set),
2871 // fixed AdoDb DB statements,
2872 // update prefs only at UserPreferences POST (for testing)
2873 // unified db prefs methods (but in external pref classes yet)
2874 //
2875 // Revision 1.13  2004/02/09 03:58:12  rurban
2876 // for now default DB_SESSION to false
2877 // PagePerm:
2878 //   * not existing perms will now query the parent, and not
2879 //     return the default perm
2880 //   * added pagePermissions func which returns the object per page
2881 //   * added getAccessDescription
2882 // WikiUserNew:
2883 //   * added global ->prepare (not yet used) with smart user/pref/member table prefixing.
2884 //   * force init of authdbh in the 2 db classes
2885 // main:
2886 //   * fixed session handling (not triple auth request anymore)
2887 //   * don't store cookie prefs with sessions
2888 // stdlib: global obj2hash helper from _AuthInfo, also needed for PagePerm
2889 //
2890 // Revision 1.12  2004/02/07 10:41:25  rurban
2891 // fixed auth from session (still double code but works)
2892 // fixed GroupDB
2893 // fixed DbPassUser upgrade and policy=old
2894 // added GroupLdap
2895 //
2896 // Revision 1.11  2004/02/03 09:45:39  rurban
2897 // LDAP cleanup, start of new Pref classes
2898 //
2899 // Revision 1.10  2004/02/01 09:14:11  rurban
2900 // Started with Group_Ldap (not yet ready)
2901 // added new _AuthInfo plugin to help in auth problems (warning: may display passwords)
2902 // fixed some configurator vars
2903 // renamed LDAP_AUTH_SEARCH to LDAP_BASE_DN
2904 // changed PHPWIKI_VERSION from 1.3.8a to 1.3.8pre
2905 // USE_DB_SESSION defaults to true on SQL
2906 // changed GROUP_METHOD definition to string, not constants
2907 // changed sample user DBAuthParams from UPDATE to REPLACE to be able to
2908 //   create users. (Not to be used with external databases generally, but
2909 //   with the default internal user table)
2910 //
2911 // fixed the IndexAsConfigProblem logic. this was flawed:
2912 //   scripts which are the same virtual path defined their own lib/main call
2913 //   (hmm, have to test this better, phpwiki.sf.net/demo works again)
2914 //
2915 // Revision 1.9  2004/01/30 19:57:58  rurban
2916 // fixed DBAuthParams['pref_select']: wrong _auth_dbi object used.
2917 //
2918 // Revision 1.8  2004/01/30 18:46:15  rurban
2919 // fix "lib/WikiUserNew.php:572: Notice[8]: Undefined variable: DBParams"
2920 //
2921 // Revision 1.7  2004/01/27 23:23:39  rurban
2922 // renamed ->Username => _userid for consistency
2923 // renamed mayCheckPassword => mayCheckPass
2924 // fixed recursion problem in WikiUserNew
2925 // fixed bogo login (but not quite 100% ready yet, password storage)
2926 //
2927 // Revision 1.6  2004/01/26 09:17:49  rurban
2928 // * changed stored pref representation as before.
2929 //   the array of objects is 1) bigger and 2)
2930 //   less portable. If we would import packed pref
2931 //   objects and the object definition was changed, PHP would fail.
2932 //   This doesn't happen with an simple array of non-default values.
2933 // * use $prefs->retrieve and $prefs->store methods, where retrieve
2934 //   understands the interim format of array of objects also.
2935 // * simplified $prefs->get() and fixed $prefs->set()
2936 // * added $user->_userid and class '_WikiUser' portability functions
2937 // * fixed $user object ->_level upgrading, mostly using sessions.
2938 //   this fixes yesterdays problems with loosing authorization level.
2939 // * fixed WikiUserNew::checkPass to return the _level
2940 // * fixed WikiUserNew::isSignedIn
2941 // * added explodePageList to class PageList, support sortby arg
2942 // * fixed UserPreferences for WikiUserNew
2943 // * fixed WikiPlugin for empty defaults array
2944 // * UnfoldSubpages: added pagename arg, renamed pages arg,
2945 //   removed sort arg, support sortby arg
2946 //
2947 // Revision 1.5  2004/01/25 03:05:00  rurban
2948 // First working version, but has some problems with the current main loop.
2949 // Implemented new auth method dispatcher and policies, all the external
2950 // _PassUser classes (also for ADODB and Pear DB).
2951 // The two global funcs UserExists() and CheckPass() are probably not needed,
2952 // since the auth loop is done recursively inside the class code, upgrading
2953 // the user class within itself.
2954 // Note: When a higher user class is returned, this doesn't mean that the user
2955 // is authorized, $user->_level is still low, and only upgraded on successful
2956 // login.
2957 //
2958 // Revision 1.4  2003/12/07 19:29:48  carstenklapp
2959 // Code Housecleaning: fixed syntax errors. (php -l *.php)
2960 //
2961 // Revision 1.3  2003/12/06 19:10:46  carstenklapp
2962 // Finished off logic for determining user class, including
2963 // PassUser. Removed ability of BogoUser to save prefs into a page.
2964 //
2965 // Revision 1.2  2003/12/03 21:45:48  carstenklapp
2966 // Added admin user, password user, and preference classes. Added
2967 // password checking functions for users and the admin. (Now the easy
2968 // parts are nearly done).
2969 //
2970 // Revision 1.1  2003/12/02 05:46:36  carstenklapp
2971 // Complete rewrite of WikiUser.php.
2972 //
2973 // This should make it easier to hook in user permission groups etc. some
2974 // time in the future. Most importantly, to finally get UserPreferences
2975 // fully working properly for all classes of users: AnonUser, BogoUser,
2976 // AdminUser; whether they have a NamesakePage (PersonalHomePage) or not,
2977 // want a cookie or not, and to bring back optional AutoLogin with the
2978 // UserName stored in a cookie--something that was lost after PhpWiki had
2979 // dropped the default http auth login method.
2980 //
2981 // Added WikiUser classes which will (almost) work together with existing
2982 // UserPreferences class. Other parts of PhpWiki need to be updated yet
2983 // before this code can be hooked up.
2984 //
2985
2986 // Local Variables:
2987 // mode: php
2988 // tab-width: 8
2989 // c-basic-offset: 4
2990 // c-hanging-comment-ender-p: nil
2991 // indent-tabs-mode: nil
2992 // End:
2993 ?>