lib/WikiUserNew.php

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