2 rcs_id('$Id: WikiUserNew.php,v 1.72 2004-05-12 10:49:55 rurban Exp $');
3 /* Copyright (C) 2004 $ThePhpWikiProgrammingTeam
5 * This file is part of PhpWiki.
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.
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.
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
22 * This is a complete OOP rewrite of the old WikiUser code with various
23 * configurable external authentication methods.
25 * There's only one entry point, the function WikiUser which returns
26 * a WikiUser object, which contains the 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.
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.
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.
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.
56 * @author: Reini Urban (the tricky parts),
57 * Carsten Klapp (started rolling the ball)
59 * Random architectural notes, sorted by date:
61 * Test it by defining ENABLE_USER_NEW in index.php
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)
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.
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))
80 * A /php5-patch.php is provided, which patches the src automatically
81 * for php4 and php5. Default is php4.
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.
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.
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
101 if (!defined('COOKIE_EXPIRATION_DAYS')) define('COOKIE_EXPIRATION_DAYS', 365);
102 if (!defined('COOKIE_DOMAIN')) define('COOKIE_DOMAIN', '/');
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);
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);
112 define('TIMEOFFSET_MIN_HOURS', -26);
113 define('TIMEOFFSET_MAX_HOURS', 26);
114 if (!defined('TIMEOFFSET_DEFAULT_HOURS')) define('TIMEOFFSET_DEFAULT_HOURS', 0);
117 * There are be the following constants in index.php to
118 * establish login parameters:
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 ?
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
132 * To establish a COMPLETELY private wiki, such as an internal
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
139 * There are other possible combinations, but the typical wiki (such
140 * as http://PhpWiki.sf.net/phpwiki) would usually just leave all four
145 // The last object in the row is the bad guy...
146 if (!is_array($USER_AUTH_ORDER))
147 $USER_AUTH_ORDER = array("Forbidden");
149 $USER_AUTH_ORDER[] = "Forbidden";
151 // Local convenience functions.
152 function _isAnonUserAllowed() {
153 return (defined('ALLOW_ANON_USER') && ALLOW_ANON_USER);
155 function _isBogoUserAllowed() {
156 return (defined('ALLOW_BOGO_LOGIN') && ALLOW_BOGO_LOGIN);
158 function _isUserPasswordsAllowed() {
159 return (defined('ALLOW_USER_PASSWORDS') && ALLOW_USER_PASSWORDS);
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.
167 return $GLOBALS['ForbiddenUser'];
169 $group = &WikiGroup::getGroup($GLOBALS['request']);
170 if ($UserName == ADMIN_USER or $group->isMember(GROUP_ADMIN))
171 return new _AdminUser($UserName);
173 return _determineBogoUserOrPassUser($UserName);
176 function _determineBogoUserOrPassUser($UserName) {
177 global $ForbiddenUser;
179 // Sanity check. User name is a condition of the definition of
180 // _BogoUser and _PassUser.
182 return $ForbiddenUser;
184 // Check for password and possibly upgrade user object.
185 // $_BogoUser = new _BogoUser($UserName);
186 if (_isBogoUserAllowed()) {
187 $_BogoUser = new _BogoLoginPassUser($UserName);
188 if ($_BogoUser->userExists())
191 if (_isUserPasswordsAllowed()) {
192 // PassUsers override BogoUsers if a password is stored
193 if (isset($_BogoUser) and $_BogoUser->_prefs->get('passwd'))
194 return new _PassUser($UserName,$_BogoUser->_prefs);
196 $_PassUser = new _PassUser($UserName,isset($_BogoUser) ? $_BogoUser->_prefs : false);
197 if ($_PassUser->userExists())
201 // No Bogo- or PassUser exists, or
202 // passwords are not allowed, and bogo is disallowed too.
203 // (Only the admin can sign in).
204 return $ForbiddenUser;
208 * Primary WikiUser function, called by lib/main.php.
210 * This determines the user's type and returns an appropriate user
211 * object. lib/main.php then querys the resultant object for password
212 * validity as necessary.
214 * If an _AnonUser object is returned, the user may only browse pages
215 * (and save prefs in a cookie).
217 * To disable access but provide prefs the global $ForbiddenUser class
218 * is returned. (was previously false)
221 function WikiUser ($UserName = '') {
222 global $ForbiddenUser;
224 //Maybe: Check sessionvar for username & save username into
225 //sessionvar (may be more appropriate to do this in lib/main.php).
227 $ForbiddenUser = new _ForbiddenUser($UserName);
228 // Found a user name.
229 return _determineAdminUserOrOtherUser($UserName);
231 elseif (!empty($_SESSION['userid'])) {
232 // Found a user name.
233 $ForbiddenUser = new _ForbiddenUser($_SESSION['userid']);
234 return _determineAdminUserOrOtherUser($_SESSION['userid']);
237 // Check for autologin pref in cookie and possibly upgrade
238 // user object to another type.
239 $_AnonUser = new _AnonUser();
240 if ($UserName = $_AnonUser->_userid && $_AnonUser->_prefs->get('autologin')) {
241 // Found a user name.
242 $ForbiddenUser = new _ForbiddenUser($UserName);
243 return _determineAdminUserOrOtherUser($UserName);
246 $ForbiddenUser = new _ForbiddenUser();
247 if (_isAnonUserAllowed())
249 return $ForbiddenUser; // User must sign in to browse pages.
251 return $ForbiddenUser; // User must sign in with a password.
254 trigger_error("DEBUG: Note: End of function reached in WikiUser." . " "
255 . "Unexpectedly, an appropriate user class could not be determined.");
256 return $ForbiddenUser; // Failsafe.
261 * WikiUser.php use the name 'WikiUser'
263 function WikiUserClassname() {
269 * Upgrade olduser by copying properties from user to olduser.
270 * We are not sure yet, for which php's a simple $this = $user works reliably,
271 * (on php4 it works ok, on php5 it's currently disallowed on the parser level)
272 * that's why try it the hard way.
274 function UpgradeUser ($olduser, $user) {
275 if (isa($user,'_WikiUser') and isa($olduser,'_WikiUser')) {
276 // populate the upgraded class $olduser with the values from the new user object
277 //only _auth_level, _current_method, _current_index,
278 if (!empty($user->_level) and
279 $user->_level > $olduser->_level)
280 $olduser->_level = $user->_level;
281 if (!empty($user->_current_index) and
282 $user->_current_index > $olduser->_current_index) {
283 $olduser->_current_index = $user->_current_index;
284 $olduser->_current_method = $user->_current_method;
286 if (!empty($user->_authmethod))
287 $olduser->_authmethod = $user->_authmethod;
289 foreach (get_object_vars($user) as $k => $v) {
290 if (!empty($v)) $olduser->$k = $v;
293 $olduser->hasHomePage(); // revive db handle, because these don't survive sessions
294 //$GLOBALS['request']->_user = $olduser;
302 * Probably not needed, since we use the various user objects methods so far.
303 * Anyway, here it is, looping through all available objects.
305 function UserExists ($UserName) {
307 if (!($user = $request->getUser()))
308 $user = WikiUser($UserName);
311 if ($user->userExists($UserName)) {
312 $request->_user = $user;
315 if (isa($user,'_BogoUser'))
316 $user = new _PassUser($UserName,$user->_prefs);
317 $class = $user->nextClass();
318 if ($user = new $class($UserName,$user->_prefs)) {
319 return $user->userExists($UserName);
321 $request->_user = $GLOBALS['ForbiddenUser'];
325 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
328 * Base WikiUser class.
333 var $_level = WIKIAUTH_FORBIDDEN;
335 var $_HomePagehandle = false;
338 function _WikiUser($UserName='', $prefs=false) {
340 $this->_userid = $UserName;
341 $this->_HomePagehandle = false;
343 $this->hasHomePage();
345 $this->_level = WIKIAUTH_FORBIDDEN;
346 if (empty($this->_prefs)) {
347 if ($prefs) $this->_prefs = $prefs;
348 else $this->getPreferences();
352 function UserName() {
353 if (!empty($this->_userid))
354 return $this->_userid;
357 function getPreferences() {
358 trigger_error("DEBUG: Note: undefined _WikiUser class trying to load prefs." . " "
359 . "New subclasses of _WikiUser must override this function.");
363 function setPreferences($prefs, $id_only) {
364 trigger_error("DEBUG: Note: undefined _WikiUser class trying to save prefs." . " "
365 . "New subclasses of _WikiUser must override this function.");
369 function userExists() {
370 return $this->hasHomePage();
373 function checkPass($submitted_password) {
374 // By definition, an undefined user class cannot sign in.
375 trigger_error("DEBUG: Warning: undefined _WikiUser class trying to sign in." . " "
376 . "New subclasses of _WikiUser must override this function.");
380 // returns page_handle to user's home page or false if none
381 function hasHomePage() {
382 if ($this->_userid) {
383 if (!empty($this->_HomePagehandle) and is_object($this->_HomePagehandle)) {
384 return $this->_HomePagehandle->exists();
387 // check db again (maybe someone else created it since
390 $this->_HomePagehandle = $request->getPage($this->_userid);
391 return $this->_HomePagehandle->exists();
398 // innocent helper: case-insensitive position in _auth_methods
399 function array_position ($string, $array) {
400 $string = strtolower($string);
401 for ($found = 0; $found < count($array); $found++) {
402 if (strtolower($array[$found]) == $string)
408 function nextAuthMethodIndex() {
409 if (empty($this->_auth_methods))
410 $this->_auth_methods = $GLOBALS['USER_AUTH_ORDER'];
411 if (empty($this->_current_index)) {
412 if (get_class($this) != '_passuser') {
413 $this->_current_method = substr(get_class($this),1,-8);
414 $this->_current_index = $this->array_position($this->_current_method,
415 $this->_auth_methods);
417 $this->_current_index = -1;
420 $this->_current_index++;
421 if ($this->_current_index >= count($this->_auth_methods))
423 $this->_current_method = $this->_auth_methods[$this->_current_index];
424 return $this->_current_index;
427 function AuthMethod($index = false) {
428 return $this->_auth_methods[ $index === false ? 0 : $index];
431 // upgrade the user object
432 function nextClass() {
433 if (($next = $this->nextAuthMethodIndex()) !== false) {
434 $method = $this->AuthMethod($next);
435 return "_".$method."PassUser";
437 if ($user = new $class($this->_userid)) {
438 // prevent from endless recursion.
439 //$user->_current_method = $this->_current_method;
440 //$user->_current_index = $this->_current_index;
441 $user = UpgradeUser($user, $this);
446 return "_ForbiddenPassUser";
449 //Fixme: for _HttpAuthPassUser
450 function PrintLoginForm (&$request, $args, $fail_message = false,
451 $seperate_page = true) {
452 include_once('lib/Template.php');
453 // Call update_locale in case the system's default language is not 'en'.
454 // (We have no user pref for lang at this point yet, no one is logged in.)
455 update_locale(DEFAULT_LANGUAGE);
456 $userid = $this->_userid;
458 extract($args); // fixme
460 $require_level = max(0, min(WIKIAUTH_ADMIN, (int)$require_level));
462 $pagename = $request->getArg('pagename');
464 $login = new Template('login', $request,
465 compact('pagename', 'userid', 'require_level',
466 'fail_message', 'pass_required', 'nocache'));
467 if ($seperate_page) {
468 $top = new Template('html', $request,
469 array('TITLE' => _("Sign In")));
470 return $top->printExpansion($login);
476 /** Signed in but probably not password checked.
478 function isSignedIn() {
479 return (isa($this,'_BogoUser') or isa($this,'_PassUser'));
482 /** This is password checked for sure.
484 function isAuthenticated () {
485 //return isa($this,'_PassUser');
486 //return isa($this,'_BogoUser') || isa($this,'_PassUser');
487 return $this->_level >= WIKIAUTH_BOGO; // hmm.
490 function isAdmin () {
491 return $this->_level == WIKIAUTH_ADMIN;
494 /** Name or IP for a signed user. UserName could come from a cookie e.g.
497 return ( $this->UserName()
499 : $GLOBALS['request']->get('REMOTE_ADDR') ); // FIXME: globals
502 /** Name for an authenticated user. No IP here.
504 function getAuthenticatedId() {
505 return ( $this->isAuthenticated()
507 : ''); //$GLOBALS['request']->get('REMOTE_ADDR') ); // FIXME: globals
510 function hasAuthority ($require_level) {
511 return $this->_level >= $require_level;
515 * Called on an auth_args POST request, such as login, logout or signin.
517 function AuthCheck ($postargs) {
518 // Normalize args, and extract.
519 $keys = array('userid', 'passwd', 'require_level', 'login', 'logout',
521 foreach ($keys as $key)
522 $args[$key] = isset($postargs[$key]) ? $postargs[$key] : false;
524 $require_level = max(0, min(WIKIAUTH_ADMIN, (int)$require_level));
526 if ($logout) { // Log out
527 $GLOBALS['request']->_user = new _AnonUser();
528 return $GLOBALS['request']->_user;
530 return false; // User hit cancel button.
531 elseif (!$login && !$userid)
532 return false; // Nothing to do?
534 $authlevel = $this->checkPass($passwd === false ? '' : $passwd);
536 return _("Invalid password or userid.");
537 elseif ($authlevel < $require_level)
538 return _("Insufficient permissions.");
541 //$user = $GLOBALS['request']->_user;
542 if (!empty($this->_current_method) and
543 strtolower(get_class($this)) == '_passuser')
546 $class = "_" . $this->_current_method . "PassUser";
547 $user = new $class($userid,$this->_prefs);
548 /*PHP5 patch*/$this = $user;
549 $this->_level = $authlevel;
552 $this->_userid = $userid;
553 $this->_level = $authlevel;
560 * Not authenticated in user, but he may be signed in. Basicly with view access only.
561 * prefs are stored in cookies, but only the userid.
566 var $_level = WIKIAUTH_ANON; // var in php-5.0.0RC1 deprecated
568 /** Anon only gets to load and save prefs in a cookie, that's it.
570 function getPreferences() {
573 if (empty($this->_prefs))
574 $this->_prefs = new UserPreferences;
575 $UserName = $this->UserName();
577 // Try to read deprecated 1.3.x style cookies
578 if ($cookie = $request->cookies->get_old(WIKI_NAME)) {
579 if (! $unboxedcookie = $this->_prefs->retrieve($cookie)) {
580 trigger_error(_("Empty Preferences or format of UserPreferences cookie not recognised.")
582 . sprintf("%s='%s'", WIKI_NAME, $cookie)
584 . _("Default preferences will be used."),
588 * Only set if it matches the UserName who is
589 * signing in or if this really is an Anon login (no
590 * username). (Remember, _BogoUser and higher inherit this
593 if (! $UserName || $UserName == @$unboxedcookie['userid']) {
594 $updated = $this->_prefs->updatePrefs($unboxedcookie);
595 //$this->_prefs = new UserPreferences($unboxedcookie);
596 $UserName = @$unboxedcookie['userid'];
597 if (is_string($UserName) and (substr($UserName,0,2) != 's:'))
598 $this->_userid = $UserName;
602 // v1.3.8 policy: don't set PhpWiki cookies, only plaintext WIKI_ID cookies
603 $request->deleteCookieVar(WIKI_NAME);
605 // Try to read deprecated 1.3.4 style cookies
606 if (! $UserName and ($cookie = $request->cookies->get_old("WIKI_PREF2"))) {
607 if (! $unboxedcookie = $this->_prefs->retrieve($cookie)) {
608 if (! $UserName || $UserName == $unboxedcookie['userid']) {
609 $updated = $this->_prefs->updatePrefs($unboxedcookie);
610 //$this->_prefs = new UserPreferences($unboxedcookie);
611 $UserName = $unboxedcookie['userid'];
612 if (is_string($UserName) and (substr($UserName,0,2) != 's:'))
613 $this->_userid = $UserName;
617 $request->deleteCookieVar("WIKI_PREF2");
621 // Try reading userid from old PhpWiki cookie formats:
622 if ($cookie = $request->cookies->get_old('WIKI_ID')) {
623 if (is_string($cookie) and (substr($cookie,0,2) != 's:'))
625 elseif (is_array($cookie) and !empty($cookie['userid']))
626 $UserName = $cookie['userid'];
629 $request->deleteCookieVar("WIKI_ID");
631 $this->_userid = $UserName;
634 // initializeTheme() needs at least an empty object
636 if (empty($this->_prefs))
637 $this->_prefs = new UserPreferences;
639 return $this->_prefs;
642 /** _AnonUser::setPreferences(): Save prefs in a cookie and session and update all global vars
644 * Allow for multiple wikis in same domain. Encode only the
645 * _prefs array of the UserPreference object. Ideally the
646 * prefs array should just be imploded into a single string or
647 * something so it is completely human readable by the end
648 * user. In that case stricter error checking will be needed
649 * when loading the cookie.
651 function setPreferences($prefs, $id_only=false) {
652 if (!is_object($prefs)) {
653 if (is_object($this->_prefs)) {
654 $updated = $this->_prefs->updatePrefs($prefs);
655 $prefs =& $this->_prefs;
657 // update the prefs values from scratch. This could leed to unnecessary
658 // side-effects: duplicate emailVerified, ...
659 $this->_prefs = new UserPreferences($prefs);
663 if (!isset($this->_prefs))
664 $this->_prefs =& $prefs;
666 $updated = $this->_prefs->isChanged($prefs);
671 // new 1.3.8 policy: no array cookies, only plain userid string as in
672 // the pre 1.3.x versions.
673 // prefs should be stored besides the session in the homepagehandle or in a db.
674 $request->setCookieVar('WIKI_ID', $this->_userid,
675 COOKIE_EXPIRATION_DAYS, COOKIE_DOMAIN);
676 //$request->setCookieVar(WIKI_NAME, array('userid' => $prefs->get('userid')),
677 // COOKIE_EXPIRATION_DAYS, COOKIE_DOMAIN);
680 $packed = $prefs->store();
681 $unpacked = $prefs->unpack($packed);
682 if (count($unpacked)) {
683 foreach (array('_method','_select','_update') as $param) {
684 if (!empty($this->_prefs->{$param}))
685 $prefs->{$param} = $this->_prefs->{$param};
687 $this->_prefs = $prefs;
688 //FIXME! The following must be done in $request->_setUser(), not here,
689 // to be able to iterate over multiple users, without tampering the current user.
692 $request->_prefs =& $this->_prefs;
693 $request->_user->_prefs =& $this->_prefs;
694 if (isset($request->_user->_auth_dbi)) {
695 $user = $request->_user;
696 unset($user->_auth_dbi);
697 $request->setSessionVar('wiki_user', $user);
699 //$request->setSessionVar('wiki_prefs', $this->_prefs);
700 $request->setSessionVar('wiki_user', $request->_user);
707 function userExists() {
711 function checkPass($submitted_password) {
713 // this might happen on a old-style signin button.
715 // By definition, the _AnonUser does not HAVE a password
716 // (compared to _BogoUser, who has an EMPTY password).
717 trigger_error("DEBUG: Warning: _AnonUser unexpectedly asked to checkPass()." . " "
718 . "Check isa(\$user, '_PassUser'), or: isa(\$user, '_AdminUser') etc. first." . " "
719 . "New subclasses of _WikiUser must override this function.");
726 * Helper class to finish the PassUser auth loop.
727 * This is added automatically to USER_AUTH_ORDER.
732 var $_level = WIKIAUTH_FORBIDDEN;
734 function checkPass($submitted_password) {
735 return WIKIAUTH_FORBIDDEN;
738 function userExists() {
739 if ($this->_HomePagehandle) return true;
744 * The PassUser name gets created automatically.
745 * That's why this class is empty, but must exist.
747 class _ForbiddenPassUser
748 extends _ForbiddenUser
756 * Do NOT extend _BogoUser to other classes, for checkPass()
757 * security. (In case of defects in code logic of the new class!)
758 * The intermediate step between anon and passuser.
759 * We also have the _BogoLoginPassUser class with stricter
760 * password checking, which fits into the auth loop.
761 * Note: This class is not called anymore by WikiUser()
766 function userExists() {
767 if (isWikiWord($this->_userid)) {
768 $this->_level = WIKIAUTH_BOGO;
771 $this->_level = WIKIAUTH_ANON;
776 function checkPass($submitted_password) {
777 // By definition, BogoUser has an empty password.
779 return $this->_level;
786 * Called if ALLOW_USER_PASSWORDS and Anon and Bogo failed.
788 * The classes for all subsequent auth methods extend from this class.
789 * This handles the auth method type dispatcher according $USER_AUTH_ORDER,
790 * the three auth method policies first-only, strict and stacked
791 * and the two methods for prefs: homepage or database,
792 * if $DBAuthParams['pref_select'] is defined.
794 * Default is PersonalPage auth and prefs.
796 * TODO: email verification
798 * @author: Reini Urban
802 var $_auth_dbi, $_prefs;
803 var $_current_method, $_current_index;
805 // check and prepare the auth and pref methods only once
806 function _PassUser($UserName='', $prefs=false) {
807 global $DBAuthParams, $DBParams;
809 $this->_userid = $UserName;
810 if ($this->hasHomePage())
811 $this->_HomePagehandle = $GLOBALS['request']->getPage($this->_userid);
813 $this->_authmethod = substr(get_class($this),1,-8);
814 if ($this->_authmethod == 'a') $this->_authmethod = 'admin';
815 if (! $this->_prefs) {
816 if ($prefs) $this->_prefs = $prefs;
817 else $this->getPreferences();
820 // Check the configured Prefs methods
821 $dbi = $this->getAuthDbh();
822 if ( $dbi and !isset($this->_prefs->_select) and !empty($DBAuthParams['pref_select'])) {
823 $this->_prefs->_method = $DBParams['dbtype'];
824 $this->_prefs->_select = $this->prepare($DBAuthParams['pref_select'],"userid");
826 if ( !isset($this->_prefs->_update) and !empty($DBAuthParams['pref_update'])) {
827 $this->_prefs->_update = $this->prepare($DBAuthParams['pref_update'],
828 array("userid","pref_blob"));
831 $this->_prefs->_method = 'HomePage';
834 // Upgrade to the next parent _PassUser class. Avoid recursion.
835 if ( strtolower(get_class($this)) === '_passuser' ) {
836 //auth policy: Check the order of the configured auth methods
837 // 1. first-only: Upgrade the class here in the constructor
838 // 2. old: ignore USER_AUTH_ORDER and try to use all available methods as
839 /// in the previous PhpWiki releases (slow)
840 // 3. strict: upgrade the class after checking the user existance in userExists()
841 // 4. stacked: upgrade the class after the password verification in checkPass()
842 // Methods: PersonalPage, HttpAuth, DB, Ldap, Imap, File
843 if (!defined('USER_AUTH_POLICY')) define('USER_AUTH_POLICY','old');
844 if (defined('USER_AUTH_POLICY')) {
845 // policy 1: only pre-define one method for all users
846 if (USER_AUTH_POLICY === 'first-only') {
847 $class = $this->nextClass();
848 return new $class($UserName,$this->_prefs);
850 // use the default behaviour from the previous versions:
851 elseif (USER_AUTH_POLICY === 'old') {
852 // default: try to be smart
853 // On php5 we can directly return and upgrade the Object,
854 // before we have to upgrade it manually.
855 if (!empty($GLOBALS['PHP_AUTH_USER'])) {
856 if (check_php_version(5))
857 return new _HttpAuthPassUser($UserName,$this->_prefs);
859 $user = new _HttpAuthPassUser($UserName,$this->_prefs);
860 //todo: with php5 comment the following line.
861 /*PHP5 patch*/$this = $user;
864 } elseif (!empty($DBAuthParams['auth_check']) and
865 (!empty($DBAuthParams['auth_dsn']) or !empty($GLOBALS ['DBParams']['dsn']))) {
866 if (check_php_version(5))
867 return new _DbPassUser($UserName,$this->_prefs);
869 $user = new _DbPassUser($UserName,$this->_prefs);
870 //todo: with php5 comment the following line.
871 /*PHP5 patch*/$this = $user;
874 } elseif (defined('LDAP_AUTH_HOST') and defined('LDAP_BASE_DN') and function_exists('ldap_open')) {
875 if (check_php_version(5))
876 return new _LDAPPassUser($UserName,$this->_prefs);
878 $user = new _LDAPPassUser($UserName,$this->_prefs);
879 //todo: with php5 comment the following line.
880 /*PHP5 patch*/$this = $user;
883 } elseif (defined('IMAP_AUTH_HOST') and function_exists('imap_open')) {
884 if (check_php_version(5))
885 return new _IMAPPassUser($UserName,$this->_prefs);
887 $user = new _IMAPPassUser($UserName,$this->_prefs);
888 //todo: with php5 comment the following line.
889 /*PHP5 patch*/$this = $user;
892 } elseif (defined('AUTH_USER_FILE')) {
893 if (check_php_version(5))
894 return new _FilePassUser($UserName,$this->_prefs);
896 $user = new _FilePassUser($UserName,$this->_prefs);
897 //todo: with php5 comment the following line.
898 /*PHP5 patch*/$this = $user;
902 if (check_php_version(5))
903 return new _PersonalPagePassUser($UserName,$this->_prefs);
905 $user = new _PersonalPagePassUser($UserName,$this->_prefs);
906 //todo: with php5 comment the following line.
907 /*PHP5 patch*/$this = $user;
913 // else use the page methods defined in _PassUser.
919 function getAuthDbh () {
920 global $request, $DBParams, $DBAuthParams;
922 // session restauration doesn't re-connect to the database automatically,
924 if (($DBParams['dbtype'] == 'SQL') and isset($this->_auth_dbi) and
925 empty($this->_auth_dbi->connection))
926 unset($this->_auth_dbi);
927 if (($DBParams['dbtype'] == 'ADODB') and isset($this->_auth_dbi) and
928 empty($this->_auth_dbi->_connectionID))
929 unset($this->_auth_dbi);
931 if (empty($this->_auth_dbi)) {
932 if ($DBParams['dbtype'] != 'SQL' and $DBParams['dbtype'] != 'ADODB')
934 if (empty($DBAuthParams))
936 if (empty($DBAuthParams['auth_dsn'])) {
937 $dbh = $request->getDbh(); // use phpwiki database
938 } elseif ($DBAuthParams['auth_dsn'] == $DBParams['dsn']) {
939 $dbh = $request->getDbh(); // same phpwiki database
940 } else { // use another external database handle. needs PHP >= 4.1
941 $local_params = array_merge($DBParams,$DBAuthParams);
942 $local_params['dsn'] = $local_params['auth_dsn'];
943 $dbh = WikiDB::open($local_params);
945 $this->_auth_dbi =& $dbh->_backend->_dbh;
947 return $this->_auth_dbi;
950 function _normalize_stmt_var($var, $oldstyle = false) {
951 static $valid_variables = array('userid','password','pref_blob','groupname');
952 // old-style: "'$userid'"
953 // new-style: '"\$userid"' or just "userid"
954 $new = str_replace(array("'",'"','\$','$'),'',$var);
955 if (!in_array($new,$valid_variables)) {
956 trigger_error("Unknown DBAuthParam statement variable: ". $new, E_USER_ERROR);
959 return !$oldstyle ? "'$".$new."'" : '"\$'.$new.'"';
962 // TODO: use it again for the auth and member tables
963 function prepare ($stmt, $variables, $oldstyle = false) {
964 global $DBParams, $request;
966 // "'\$userid"' => '%s'
967 // variables can be old-style: '"\$userid"' or new-style: "'$userid'" or just "userid"
968 // old-style strings don't survive pear/Config/IniConfig treatment, that's why we changed it.
970 if (is_array($variables)) {
971 for ($i=0; $i<count($variables); $i++) {
972 $var = $this->_normalize_stmt_var($variables[$i],$oldstyle);
974 trigger_error(sprintf("DbAuthParams: Undefined or empty statement variable %s in %s",
975 $variables[$i], $stmt), E_USER_WARNING);
976 $variables[$i] = $var;
977 if (!$var) $new[] = '';
981 $var = $this->_normalize_stmt_var($variables,$oldstyle);
983 trigger_error(sprintf("DbAuthParams: Undefined or empty statement variable %s in %s",
984 $variables,$stmt), E_USER_WARNING);
986 if (!$var) $new = '';
989 // probably prefix table names if in same database
990 if (!empty($DBParams['prefix']) and
991 isset($this->_auth_dbi) and
992 isset($request->_dbi->_backend->_dbh) and
993 (!empty($GLOBALS['DBAuthParams']['auth_dsn']) and
994 $DBParams['dsn'] == $GLOBALS['DBAuthParams']['auth_dsn']))
996 $prefix = $DBParams['prefix'];
997 if (!stristr($stmt, $prefix)) {
998 //Do it automatically for the lazy admin? Esp. on sf.net it's nice to have
999 trigger_error("TODO: Need to prefix the DBAuthParam tablename in index.php:\n $stmt",
1001 $stmt = str_replace(array(" user "," pref "," member "),
1002 array(" ".$prefix."user ",
1003 " ".$prefix."prefs ",
1004 " ".$prefix."member "),$stmt);
1007 // Preparate the SELECT statement, for ADODB and PearDB (MDB not).
1008 // Simple sprintf-style.
1009 $new_stmt = str_replace($variables,$new,$stmt);
1010 if ($new_stmt == $stmt) {
1011 trigger_error(sprintf("DbAuthParams: Old statement quoting style in %s",
1012 $stmt), E_USER_WARNING);
1013 $new_stmt = $this->prepare($stmt, $variables, 'oldstyle');
1018 function getPreferences() {
1019 if (!empty($this->_prefs->_method)) {
1020 if ($this->_prefs->_method == 'ADODB') {
1021 _AdoDbPassUser::_AdoDbPassUser($this->_userid,$this->_prefs);
1022 return _AdoDbPassUser::getPreferences();
1023 } elseif ($this->_prefs->_method == 'SQL') {
1024 _PearDbPassUser::_PearDbPassUser($this->_userid,$this->_prefs);
1025 return _PearDbPassUser::getPreferences();
1029 // We don't necessarily have to read the cookie first. Since
1030 // the user has a password, the prefs stored in the homepage
1031 // cannot be arbitrarily altered by other Bogo users.
1032 _AnonUser::getPreferences();
1033 // User may have deleted cookie, retrieve from his
1034 // PersonalPage if there is one.
1035 if ($this->_HomePagehandle) {
1036 if ($restored_from_page = $this->_prefs->retrieve($this->_HomePagehandle->get('pref'))) {
1037 $updated = $this->_prefs->updatePrefs($restored_from_page,'init');
1038 //$this->_prefs = new UserPreferences($restored_from_page);
1039 return $this->_prefs;
1042 return $this->_prefs;
1045 function setPreferences($prefs, $id_only=false) {
1046 if (!empty($this->_prefs->_method)) {
1047 if ($this->_prefs->_method == 'ADODB') {
1048 _AdoDbPassUser::_AdoDbPassUser($this->_userid,$prefs);
1049 return _AdoDbPassUser::setPreferences($prefs, $id_only);
1051 elseif ($this->_prefs->_method == 'SQL') {
1052 _PearDbPassUser::_PearDbPassUser($this->_userid,$prefs);
1053 return _PearDbPassUser::setPreferences($prefs, $id_only);
1056 if (_AnonUser::setPreferences($prefs, $id_only)) {
1057 // Encode only the _prefs array of the UserPreference object
1058 if ($this->_HomePagehandle and !$id_only) {
1059 $this->_HomePagehandle->set('pref', $this->_prefs->store());
1065 function mayChangePass() {
1069 //The default method is getting the password from prefs.
1070 // child methods obtain $stored_password from external auth.
1071 function userExists() {
1072 //if ($this->_HomePagehandle) return true;
1073 $class = $this->nextClass();
1074 while ($user = new $class($this->_userid,$this->_prefs)) {
1075 //todo: with php5 comment the following line:
1076 /*PHP5 patch*/$this = $user;
1077 //UpgradeUser($this,$user);
1078 if ($user->userExists()) {
1081 // prevent endless loop. does this work on all PHP's?
1082 // it just has to set the classname, what it correctly does.
1083 $class = $user->nextClass();
1084 if ($class == "_ForbiddenPassUser")
1090 //The default method is getting the password from prefs.
1091 // child methods obtain $stored_password from external auth.
1092 function checkPass($submitted_password) {
1093 $stored_password = $this->_prefs->get('passwd');
1094 if ($this->_checkPass($submitted_password, $stored_password)) {
1095 $this->_level = WIKIAUTH_USER;
1096 return $this->_level;
1098 return $this->_tryNextPass($submitted_password);
1103 * The basic password checker for all PassUser objects.
1104 * Uses global ENCRYPTED_PASSWD and PASSWORD_LENGTH_MINIMUM.
1105 * Empty passwords are always false!
1106 * PASSWORD_LENGTH_MINIMUM is enforced here and in the preference set method.
1107 * @see UserPreferences::set
1109 * DBPassUser password's have their own crypt definition.
1110 * That's why DBPassUser::checkPass() doesn't call this method, if
1111 * the db password method is 'plain', which means that the DB SQL
1112 * statement just returns 1 or 0. To use CRYPT() or PASSWORD() and
1113 * don't store plain passwords in the DB.
1115 * TODO: remove crypt() function check from config.php:396 ??
1117 function _checkPass($submitted_password, $stored_password) {
1118 if(!empty($submitted_password)) {
1119 if (strlen($stored_password) < PASSWORD_LENGTH_MINIMUM) {
1121 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."));
1124 if (strlen($submitted_password) < PASSWORD_LENGTH_MINIMUM)
1126 if (defined('ENCRYPTED_PASSWD') && ENCRYPTED_PASSWD) {
1127 // Verify against encrypted password.
1128 if (function_exists('crypt')) {
1129 if (crypt($submitted_password, $stored_password) == $stored_password )
1130 return true; // matches encrypted password
1135 trigger_error(_("The crypt function is not available in this version of PHP.") . " "
1136 . _("Please set ENCRYPTED_PASSWD to false in index.php and probably change ADMIN_PASSWD."),
1142 // Verify against cleartext password.
1143 if ($submitted_password == $stored_password)
1146 // Check whether we forgot to enable ENCRYPTED_PASSWD
1147 if (function_exists('crypt')) {
1148 if (crypt($submitted_password, $stored_password) == $stored_password) {
1149 trigger_error(_("Please set ENCRYPTED_PASSWD to true in index.php."),
1160 /** The default method is storing the password in prefs.
1161 * Child methods (DB,File) may store in external auth also, but this
1162 * must be explicitly enabled.
1163 * This may be called by plugin/UserPreferences or by ->SetPreferences()
1165 function changePass($submitted_password) {
1166 $stored_password = $this->_prefs->get('passwd');
1167 // check if authenticated
1168 if ($this->isAuthenticated() and $stored_password != $submitted_password) {
1169 $this->_prefs->set('passwd',$submitted_password);
1170 //update the storage (session, homepage, ...)
1171 $this->SetPreferences($this->_prefs);
1174 //Todo: return an error msg to the caller what failed?
1175 // same password or no privilege
1179 function _tryNextPass($submitted_password) {
1180 if (USER_AUTH_POLICY === 'strict') {
1181 $class = $this->nextClass();
1182 if ($user = new $class($this->_userid,$this->_prefs)) {
1183 if ($user->userExists()) {
1184 return $user->checkPass($submitted_password);
1188 if (USER_AUTH_POLICY === 'stacked' or USER_AUTH_POLICY === 'old') {
1189 $class = $this->nextClass();
1190 if ($user = new $class($this->_userid,$this->_prefs))
1191 return $user->checkPass($submitted_password);
1193 return $this->_level;
1196 function _tryNextUser() {
1197 if (USER_AUTH_POLICY === 'strict') {
1198 $class = $this->nextClass();
1199 while ($user = new $class($this->_userid,$this->_prefs)) {
1200 //todo: with php5 comment the following line:
1201 /*PHP5 patch*/$this = $user;
1202 //$user = UpgradeUser($this, $user);
1203 if ($user->userExists()) {
1206 $class = $this->nextClass();
1214 /** Without stored password. A _BogoLoginPassUser with password
1215 * is automatically upgraded to a PersonalPagePassUser.
1217 class _BogoLoginPassUser
1220 var $_authmethod = 'BogoLogin';
1221 function userExists() {
1222 if (isWikiWord($this->_userid)) {
1223 $this->_level = WIKIAUTH_BOGO;
1226 $this->_level = WIKIAUTH_ANON;
1231 /** A BogoLoginUser requires no password at all
1232 * But if there's one stored, we should prefer PersonalPage instead
1234 function checkPass($submitted_password) {
1235 if ($this->_prefs->get('passwd')) {
1236 $user = new _PersonalPagePassUser($this->_userid);
1237 if ($user->checkPass($submitted_password)) {
1238 //todo: with php5 comment the following line:
1239 /*PHP5 patch*/$this = $user;
1240 $user = UpgradeUser($this, $user);
1241 $this->_level = WIKIAUTH_USER;
1242 return $this->_level;
1244 $this->_level = WIKIAUTH_ANON;
1245 return $this->_level;
1248 $this->userExists();
1249 return $this->_level;
1255 * This class is only to simplify the auth method dispatcher.
1256 * It inherits almost all all methods from _PassUser.
1258 class _PersonalPagePassUser
1261 var $_authmethod = 'PersonalPage';
1263 function userExists() {
1264 return $this->_HomePagehandle and $this->_HomePagehandle->exists();
1267 /** A PersonalPagePassUser requires PASSWORD_LENGTH_MINIMUM.
1268 * BUT if the user already has a homepage with an empty password
1269 * stored, allow login but warn him to change it.
1271 function checkPass($submitted_password) {
1272 if ($this->userExists()) {
1273 $stored_password = $this->_prefs->get('passwd');
1274 if (empty($stored_password)) {
1275 trigger_error(sprintf(
1276 _("\nYou stored an empty password in your '%s' page.\n").
1277 _("Your access permissions are only for a BogoUser.\n").
1278 _("Please set your password in UserPreferences."),
1279 $this->_userid), E_USER_NOTICE);
1280 $this->_level = WIKIAUTH_BOGO;
1281 return $this->_level;
1283 if ($this->_checkPass($submitted_password, $stored_password))
1284 return ($this->_level = WIKIAUTH_USER);
1285 return _PassUser::checkPass($submitted_password);
1287 return WIKIAUTH_ANON;
1292 * We have two possibilities here.
1293 * 1) The webserver location is already HTTP protected (usually Basic). Then just
1294 * use the username and do nothing
1295 * 2) The webserver location is not protected, so we enforce basic HTTP Protection
1296 * by sending a 401 error and let the client display the login dialog.
1297 * This makes only sense if HttpAuth is the last method in USER_AUTH_ORDER,
1298 * since the other methods cannot be transparently called after this enforced
1300 * Try the available auth methods (most likely Bogo) and sent this header back.
1301 * header('Authorization: Basic '.base64_encode("$userid:$passwd")."\r\n";
1303 class _HttpAuthPassUser
1306 function _HttpAuthPassUser($UserName='',$prefs=false) {
1307 if ($prefs) $this->_prefs = $prefs;
1308 if (!isset($this->_prefs->_method))
1309 _PassUser::_PassUser($UserName);
1310 if ($UserName) $this->_userid = $UserName;
1311 $this->_authmethod = 'HttpAuth';
1312 if ($this->userExists())
1315 return $GLOBALS['ForbiddenUser'];
1318 function _http_username() {
1319 if (!isset($_SERVER))
1320 $_SERVER =& $GLOBALS['HTTP_SERVER_VARS'];
1321 if (!empty($_SERVER['PHP_AUTH_USER']))
1322 return $_SERVER['PHP_AUTH_USER'];
1323 if (!empty($_SERVER['REMOTE_USER']))
1324 return $_SERVER['REMOTE_USER'];
1325 if (!empty($GLOBALS['HTTP_ENV_VARS']['REMOTE_USER']))
1326 return $GLOBALS['HTTP_ENV_VARS']['REMOTE_USER'];
1327 if (!empty($GLOBALS['REMOTE_USER']))
1328 return $GLOBALS['REMOTE_USER'];
1332 //force http auth authorization
1333 function userExists() {
1334 // todo: older php's
1335 $username = $this->_http_username();
1336 if (empty($username) or $username != $this->_userid) {
1337 header('WWW-Authenticate: Basic realm="'.WIKI_NAME.'"');
1338 header('HTTP/1.0 401 Unauthorized');
1341 $this->_userid = $username;
1342 $this->_level = WIKIAUTH_USER;
1346 function checkPass($submitted_password) {
1347 return $this->userExists() ? WIKIAUTH_USER : WIKIAUTH_ANON;
1350 function mayChangePass() {
1354 // hmm... either the server dialog or our own.
1355 function PrintLoginForm (&$request, $args, $fail_message = false,
1356 $seperate_page = true) {
1357 header('WWW-Authenticate: Basic realm="'.WIKI_NAME.'"');
1358 header('HTTP/1.0 401 Unauthorized');
1361 include_once('lib/Template.php');
1362 // Call update_locale in case the system's default language is not 'en'.
1363 // (We have no user pref for lang at this point yet, no one is logged in.)
1364 update_locale(DEFAULT_LANGUAGE);
1365 $userid = $this->_userid;
1367 extract($args); // fixme
1369 $require_level = max(0, min(WIKIAUTH_ADMIN, (int)$require_level));
1371 $pagename = $request->getArg('pagename');
1373 $login = new Template('login', $request,
1374 compact('pagename', 'userid', 'require_level',
1375 'fail_message', 'pass_required', 'nocache'));
1376 if ($seperate_page) {
1377 $top = new Template('html', $request,
1378 array('TITLE' => _("Sign In")));
1379 return $top->printExpansion($login);
1388 * Support reuse of existing user session from another application.
1389 * You have to define which session variable holds the userid, and
1390 * at what level is that user then. 1: BogoUser, 2: PassUser
1391 * define('AUTH_SESS_USER','userid');
1392 * define('AUTH_SESS_LEVEL',2);
1394 class _SessionPassUser
1397 function _SessionPassUser($UserName='',$prefs=false) {
1398 if ($prefs) $this->_prefs = $prefs;
1399 if (!defined("AUTH_SESS_USER") or !defined("AUTH_SESS_LEVEL")) {
1401 "AUTH_SESS_USER or AUTH_SESS_LEVEL is not defined for the SessionPassUser method",
1405 $sess =& $GLOBALS['HTTP_SESSION_VARS'];
1406 // FIXME: user hash: "[user][userid]" or object "user->id"
1407 $this->_userid = $sess[AUTH_SESS_USER];
1408 if (!isset($this->_prefs->_method))
1409 _PassUser::_PassUser($this->_userid);
1410 $this->_level = AUTH_SESS_LEVEL;
1411 $this->_authmethod = 'Session';
1413 function userExists() {
1414 return !empty($this->_userid);
1416 function checkPass($submitted_password) {
1417 return $this->userExists() and $this->_level;
1419 function mayChangePass() {
1425 * Baseclass for PearDB and ADODB PassUser's
1426 * Authenticate against a database, to be able to use shared users.
1427 * internal: no different $DbAuthParams['dsn'] defined, or
1428 * external: different $DbAuthParams['dsn']
1429 * The magic is done in the symbolic SQL statements in index.php, similar to
1432 * We support only the SQL and ADODB backends.
1433 * The other WikiDB backends (flat, cvs, dba, ...) should be used for pages,
1434 * not for auth stuff. If one would like to use e.g. dba for auth, he should
1435 * use PearDB (SQL) with the right $DBAuthParam['auth_dsn'].
1436 * (Not supported yet, since we require SQL. SQLite would make since when
1437 * it will come to PHP)
1439 * @tables: user, pref
1441 * Preferences are handled in the parent class _PassUser, because the
1442 * previous classes may also use DB pref_select and pref_update.
1444 * Flat files auth is handled by the auth method "File".
1449 var $_authselect, $_authupdate, $_authcreate;
1451 // This can only be called from _PassUser, because the parent class
1452 // sets the auth_dbi and pref methods, before this class is initialized.
1453 function _DbPassUser($UserName='',$prefs=false) {
1454 if (!$this->_prefs) {
1455 if ($prefs) $this->_prefs = $prefs;
1457 if (!isset($this->_prefs->_method))
1458 _PassUser::_PassUser($UserName);
1459 $this->_authmethod = 'Db';
1460 //$this->getAuthDbh();
1461 //$this->_auth_crypt_method = @$GLOBALS['DBAuthParams']['auth_crypt_method'];
1462 if ($GLOBALS['DBParams']['dbtype'] == 'ADODB') {
1463 if (check_php_version(5))
1464 return new _AdoDbPassUser($UserName,$this->_prefs);
1466 $user = new _AdoDbPassUser($UserName,$this->_prefs);
1467 //todo: with php5 comment the following line:
1468 /*PHP5 patch*/$this = $user;
1472 elseif ($GLOBALS['DBParams']['dbtype'] == 'SQL') {
1473 if (check_php_version(5))
1474 return new _PearDbPassUser($UserName,$this->_prefs);
1476 $user = new _PearDbPassUser($UserName,$this->_prefs);
1477 //todo: with php5 comment the following line:
1478 /*PHP5 patch*/$this = $user;
1485 function mayChangePass() {
1486 return !isset($this->_authupdate);
1491 class _PearDbPassUser
1495 * Now optimized not to use prepare, ...query(sprintf($sql,quote())) instead.
1496 * We use FETCH_MODE_ROW, so we don't need aliases in the auth_* SQL statements.
1502 var $_authmethod = 'PearDb';
1503 function _PearDbPassUser($UserName='',$prefs=false) {
1504 global $DBAuthParams;
1505 if (!$this->_prefs and isa($this,"_PearDbPassUser")) {
1506 if ($prefs) $this->_prefs = $prefs;
1508 if (!isset($this->_prefs->_method))
1509 _PassUser::_PassUser($UserName);
1510 $this->_userid = $UserName;
1511 // make use of session data. generally we only initialize this every time,
1512 // but do auth checks only once
1513 $this->_auth_crypt_method = @$DBAuthParams['auth_crypt_method'];
1514 //$this->getAuthDbh();
1518 function getPreferences() {
1519 // override the generic slow method here for efficiency and not to
1520 // clutter the homepage metadata with prefs.
1521 _AnonUser::getPreferences();
1522 $this->getAuthDbh();
1523 if (isset($this->_prefs->_select)) {
1524 $dbh = &$this->_auth_dbi;
1525 $db_result = $dbh->query(sprintf($this->_prefs->_select,$dbh->quote($this->_userid)));
1526 // patched by frederik@pandora.be
1527 $prefs = $db_result->fetchRow();
1528 $prefs_blob = @$prefs["prefs"];
1529 if ($restored_from_db = $this->_prefs->retrieve($prefs_blob)) {
1530 $updated = $this->_prefs->updatePrefs($restored_from_db);
1531 //$this->_prefs = new UserPreferences($restored_from_db);
1532 return $this->_prefs;
1535 if ($this->_HomePagehandle) {
1536 if ($restored_from_page = $this->_prefs->retrieve($this->_HomePagehandle->get('pref'))) {
1537 $updated = $this->_prefs->updatePrefs($restored_from_page);
1538 //$this->_prefs = new UserPreferences($restored_from_page);
1539 return $this->_prefs;
1542 return $this->_prefs;
1545 function setPreferences($prefs, $id_only=false) {
1546 // if the prefs are changed
1547 if ($count = _AnonUser::setPreferences($prefs, 1)) {
1549 //$user = $request->_user;
1550 //unset($user->_auth_dbi);
1551 // this must be done in $request->_setUser, not here!
1552 //$request->setSessionVar('wiki_user', $user);
1553 $this->getAuthDbh();
1554 $packed = $this->_prefs->store();
1555 if (!$id_only and isset($this->_prefs->_update)) {
1556 $dbh = &$this->_auth_dbi;
1557 $dbh->simpleQuery(sprintf($this->_prefs->_update,
1558 $dbh->quote($packed),
1559 $dbh->quote($this->_userid)));
1561 //store prefs in homepage, not in cookie
1562 if ($this->_HomePagehandle and !$id_only)
1563 $this->_HomePagehandle->set('pref', $packed);
1565 return $count; //count($this->_prefs->unpack($packed));
1570 function userExists() {
1571 global $DBAuthParams;
1572 $this->getAuthDbh();
1573 $dbh = &$this->_auth_dbi;
1574 if (!$dbh) { // needed?
1575 return $this->_tryNextUser();
1577 // Prepare the configured auth statements
1578 if (!empty($DBAuthParams['auth_check']) and empty($this->_authselect)) {
1579 $this->_authselect = $this->prepare($DBAuthParams['auth_check'],
1580 array("userid","password"));
1582 if (empty($this->_authselect))
1583 trigger_error("Either \$DBAuthParams['auth_check'] is missing or \$DBParams['dbtype'] != 'SQL'",
1585 //NOTE: for auth_crypt_method='crypt' no special auth_user_exists is needed
1586 if ($this->_auth_crypt_method == 'crypt') {
1587 $rs = $dbh->query(sprintf($this->_authselect,$dbh->quote($this->_userid)));
1592 if (! $GLOBALS['DBAuthParams']['auth_user_exists'])
1593 trigger_error("\$DBAuthParams['auth_user_exists'] is missing",
1595 $this->_authcheck = $this->prepare($DBAuthParams['auth_user_exists'],"userid");
1596 $rs = $dbh->query(sprintf($this->_authcheck,$dbh->quote($this->_userid)));
1600 // maybe the user is allowed to create himself. Generally not wanted in
1601 // external databases, but maybe wanted for the wiki database, for performance
1603 if (empty($this->_authcreate) and !empty($DBAuthParams['auth_create'])) {
1604 $this->_authcreate = $this->prepare($DBAuthParams['auth_create'],
1605 array("userid","password"));
1607 if (!empty($this->_authcreate)) {
1608 $dbh->simpleQuery(sprintf($this->_authcreate,
1609 $dbh->quote($GLOBALS['HTTP_POST_VARS']['auth']['passwd']),
1610 $dbh->quote($this->_userid)
1614 return $this->_tryNextUser();
1617 function checkPass($submitted_password) {
1618 global $DBAuthParams;
1619 $this->getAuthDbh();
1620 if (!$this->_auth_dbi) { // needed?
1621 return $this->_tryNextPass($submitted_password);
1623 if (!isset($this->_authselect))
1624 $this->userExists();
1625 if (!isset($this->_authselect))
1626 trigger_error("Either \$DBAuthParams['auth_check'] is missing or \$DBParams['dbtype'] != 'SQL'",
1629 //NOTE: for auth_crypt_method='crypt' defined('ENCRYPTED_PASSWD',true) must be set
1630 $dbh = &$this->_auth_dbi;
1631 if ($this->_auth_crypt_method == 'crypt') {
1632 $stored_password = $dbh->getOne(sprintf($this->_authselect,$dbh->quote($this->_userid)));
1633 $result = $this->_checkPass($submitted_password, $stored_password);
1635 $okay = $dbh->getOne(sprintf($this->_authselect,
1636 $dbh->quote($submitted_password),
1637 $dbh->quote($this->_userid)));
1638 $result = !empty($okay);
1642 $this->_level = WIKIAUTH_USER;
1643 return $this->_level;
1645 return $this->_tryNextPass($submitted_password);
1649 function mayChangePass() {
1650 global $DBAuthParams;
1651 return !empty($DBAuthParams['auth_update']);
1654 function storePass($submitted_password) {
1655 global $DBAuthParams;
1656 if (!empty($DBAuthParams['auth_update']) and empty($this->_authupdate)) {
1657 $this->_authupdate = $this->prepare($DBAuthParams['auth_update'],
1658 array("userid","password"));
1660 if (empty($this->_authupdate)) {
1661 trigger_error("Either \$DBAuthParams['auth_update'] not defined or \$DBParams['dbtype'] != 'SQL'",
1666 if ($this->_auth_crypt_method == 'crypt') {
1667 if (function_exists('crypt'))
1668 $submitted_password = crypt($submitted_password);
1670 $this->getAuthDbh();
1671 $dbh = &$this->_auth_dbi;
1672 $dbh->simpleQuery(sprintf($this->_authupdate,
1673 $dbh->quote($submitted_password),
1674 $dbh->quote($this->_userid)
1680 class _AdoDbPassUser
1684 * Simple sprintf, no prepare.
1686 * Warning: Since we use FETCH_MODE_ASSOC (string hash) and not the also faster
1687 * FETCH_MODE_ROW (numeric), we have to use the correct aliases in auth_* sql statements!
1689 * TODO: Change FETCH_MODE in adodb WikiDB sublasses.
1694 var $_authmethod = 'AdoDb';
1695 function _AdoDbPassUser($UserName='',$prefs=false) {
1696 if (!$this->_prefs and isa($this,"_AdoDbPassUser")) {
1697 if ($prefs) $this->_prefs = $prefs;
1698 if (!isset($this->_prefs->_method))
1699 _PassUser::_PassUser($UserName);
1701 $this->_userid = $UserName;
1702 $this->_auth_crypt_method = $GLOBALS['DBAuthParams']['auth_crypt_method'];
1703 $this->getAuthDbh();
1704 // Don't prepare the configured auth statements anymore
1708 function getPreferences() {
1709 // override the generic slow method here for efficiency
1710 _AnonUser::getPreferences();
1711 $this->getAuthDbh();
1712 if (isset($this->_prefs->_select)) {
1713 $dbh = & $this->_auth_dbi;
1714 $rs = $dbh->Execute(sprintf($this->_prefs->_select,$dbh->qstr($this->_userid)));
1718 $prefs_blob = @$rs->fields['prefs'];
1720 if ($restored_from_db = $this->_prefs->retrieve($prefs_blob)) {
1721 $updated = $this->_prefs->updatePrefs($restored_from_db);
1722 //$this->_prefs = new UserPreferences($restored_from_db);
1723 return $this->_prefs;
1727 if ($this->_HomePagehandle) {
1728 if ($restored_from_page = $this->_prefs->retrieve($this->_HomePagehandle->get('pref'))) {
1729 $updated = $this->_prefs->updatePrefs($restored_from_page);
1730 //$this->_prefs = new UserPreferences($restored_from_page);
1731 return $this->_prefs;
1734 return $this->_prefs;
1737 function setPreferences($prefs, $id_only=false) {
1738 // if the prefs are changed
1739 if (_AnonUser::setPreferences($prefs, 1)) {
1741 $packed = $this->_prefs->store();
1742 //$user = $request->_user;
1743 //unset($user->_auth_dbi);
1744 if (!$id_only and isset($this->_prefs->_update)) {
1745 $this->getAuthDbh();
1746 $dbh = &$this->_auth_dbi;
1747 $db_result = $dbh->Execute(sprintf($this->_prefs->_update,
1748 $dbh->qstr($packed),
1749 $dbh->qstr($this->_userid)));
1750 $db_result->Close();
1752 //store prefs in homepage, not in cookie
1753 if ($this->_HomePagehandle and !$id_only)
1754 $this->_HomePagehandle->set('pref', $packed);
1756 return count($this->_prefs->unpack($packed));
1761 function userExists() {
1762 global $DBAuthParams;
1763 $this->getAuthDbh();
1764 $dbh = &$this->_auth_dbi;
1765 if (!$dbh) { // needed?
1766 return $this->_tryNextUser();
1768 if (empty($this->_authselect) and !empty($DBAuthParams['auth_check'])) {
1769 $this->_authselect = $this->prepare($DBAuthParams['auth_check'],
1770 array("userid","password"));
1772 if (empty($this->_authselect))
1773 trigger_error("Either \$DBAuthParams['auth_check'] is missing or \$DBParams['dbtype'] != 'ADODB'",
1775 //NOTE: for auth_crypt_method='crypt' no special auth_user_exists is needed
1776 if ($this->_auth_crypt_method == 'crypt') {
1777 $rs = $dbh->Execute(sprintf($this->_authselect,$dbh->qstr($this->_userid)));
1786 if (! $DBAuthParams['auth_user_exists'])
1787 trigger_error("\$DBAuthParams['auth_user_exists'] is missing",
1789 $this->_authcheck = $this->prepare($DBAuthParams['auth_user_exists'],'userid');
1790 $rs = $dbh->Execute(sprintf($this->_authcheck,$dbh->qstr($this->_userid)));
1798 // maybe the user is allowed to create himself. Generally not wanted in
1799 // external databases, but maybe wanted for the wiki database, for performance
1801 if (empty($this->_authcreate) and !empty($DBAuthParams['auth_create'])) {
1802 $this->_authcreate = $this->prepare($DBAuthParams['auth_create'],
1803 array("userid","password"));
1805 if (!empty($this->_authcreate)) {
1806 $dbh->Execute(sprintf($this->_authcreate,
1807 $dbh->qstr($GLOBALS['HTTP_POST_VARS']['auth']['passwd']),
1808 $dbh->qstr($this->_userid)));
1812 return $this->_tryNextUser();
1815 function checkPass($submitted_password) {
1816 global $DBAuthParams;
1817 $this->getAuthDbh();
1818 if (!$this->_auth_dbi) { // needed?
1819 return $this->_tryNextPass($submitted_password);
1821 if (empty($this->_authselect) and !empty($DBAuthParams['auth_check'])) {
1822 $this->_authselect = $this->prepare($DBAuthParams['auth_check'],
1823 array("userid","password"));
1825 if (!isset($this->_authselect))
1826 $this->userExists();
1827 if (!isset($this->_authselect))
1828 trigger_error("Either \$DBAuthParams['auth_check'] is missing or \$DBParams['dbtype'] != 'ADODB'",
1830 $dbh = &$this->_auth_dbi;
1831 //NOTE: for auth_crypt_method='crypt' defined('ENCRYPTED_PASSWD',true) must be set
1832 if ($this->_auth_crypt_method == 'crypt') {
1833 $rs = $dbh->Execute(sprintf($this->_authselect,$dbh->qstr($this->_userid)));
1835 $stored_password = $rs->fields['password'];
1837 $result = $this->_checkPass($submitted_password, $stored_password);
1844 $rs = $dbh->Execute(sprintf($this->_authselect,
1845 $dbh->qstr($submitted_password),
1846 $dbh->qstr($this->_userid)));
1847 $okay = $rs->fields['ok'];
1849 $result = !empty($okay);
1853 $this->_level = WIKIAUTH_USER;
1854 return $this->_level;
1856 return $this->_tryNextPass($submitted_password);
1860 function mayChangePass() {
1861 global $DBAuthParams;
1862 return !empty($DBAuthParams['auth_update']);
1865 function storePass($submitted_password) {
1866 global $DBAuthParams;
1867 if (!isset($this->_authupdate) and !empty($DBAuthParams['auth_update'])) {
1868 $this->_authupdate = $this->prepare($DBAuthParams['auth_update'],
1869 array("userid","password"));
1871 if (!isset($this->_authupdate)) {
1872 trigger_error("Either \$DBAuthParams['auth_update'] not defined or \$DBParams['dbtype'] != 'ADODB'",
1877 if ($this->_auth_crypt_method == 'crypt') {
1878 if (function_exists('crypt'))
1879 $submitted_password = crypt($submitted_password);
1881 $this->getAuthDbh();
1882 $dbh = &$this->_auth_dbi;
1883 $rs = $dbh->Execute(sprintf($this->_authupdate,
1884 $dbh->qstr($submitted_password),
1885 $dbh->qstr($this->_userid)
1896 * Define the vars LDAP_AUTH_HOST and LDAP_BASE_DN in index.php
1898 * Preferences are handled in _PassUser
1901 function checkPass($submitted_password) {
1902 global $LDAP_SET_OPTION;
1904 $this->_authmethod = 'LDAP';
1905 $userid = $this->_userid;
1906 if ($ldap = ldap_connect(LDAP_AUTH_HOST)) { // must be a valid LDAP server!
1907 if (defined('LDAP_AUTH_USER'))
1908 if (defined('LDAP_AUTH_PASSWORD'))
1909 // Windows Active Directory Server is strict
1910 $r = @ldap_bind($ldap,LDAP_AUTH_USER,LDAP_AUTH_PASSWORD);
1912 $r = @ldap_bind($ldap,LDAP_AUTH_USER);
1914 $r = @ldap_bind($ldap); // this is an anonymous bind
1915 if (!empty($LDAP_SET_OPTION)) {
1916 foreach ($LDAP_SET_OPTION as $key => $value) {
1917 if (is_string($key) and defined($key))
1918 $key = constant($key);
1919 ldap_set_option($ldap,$key,$value);
1922 // Need to set the right root search information. see ../index.php
1923 $st_search = defined('LDAP_SEARCH_FIELD')
1924 ? LDAP_SEARCH_FIELD."=$userid"
1926 $sr = ldap_search($ldap, LDAP_BASE_DN, $st_search);
1927 $info = ldap_get_entries($ldap, $sr);
1928 // there may be more hits with this userid.
1929 // of course it would be better to narrow down the BASE_DN
1930 for ($i = 0; $i < $info["count"]; $i++) {
1931 $dn = $info[$i]["dn"];
1932 // The password is still plain text.
1933 if ($r = @ldap_bind($ldap, $dn, $submitted_password)) {
1934 // ldap_bind will return TRUE if everything matches
1936 $this->_level = WIKIAUTH_USER;
1937 return $this->_level;
1941 trigger_error(fmt("Unable to connect to LDAP server %s", LDAP_AUTH_HOST),
1946 return $this->_tryNextPass($submitted_password);
1949 function userExists() {
1950 global $LDAP_SET_OPTION;
1952 $userid = $this->_userid;
1953 if ($ldap = ldap_connect(LDAP_AUTH_HOST)) { // must be a valid LDAP server!
1954 if (defined('LDAP_AUTH_USER'))
1955 if (defined('LDAP_AUTH_PASSWORD'))
1956 // Windows Active Directory Server is strict
1957 $r = @ldap_bind($ldap,LDAP_AUTH_USER,LDAP_AUTH_PASSWORD);
1959 $r = @ldap_bind($ldap,LDAP_AUTH_USER);
1961 $r = @ldap_bind($ldap); // this is an anonymous bind
1962 if (!empty($LDAP_SET_OPTION)) {
1963 foreach ($LDAP_SET_OPTION as $key => $value) {
1964 ldap_set_option($ldap,$key,$value);
1967 // Need to set the right root search information. see ../index.php
1968 $st_search = defined('LDAP_SEARCH_FIELD')
1969 ? LDAP_SEARCH_FIELD."=$userid"
1971 $sr = ldap_search($ldap, LDAP_BASE_DN, $st_search);
1972 $info = ldap_get_entries($ldap, $sr);
1974 if ($info["count"] > 0) {
1979 trigger_error(_("Unable to connect to LDAP server "). LDAP_AUTH_HOST, E_USER_WARNING);
1982 return $this->_tryNextUser();
1985 function mayChangePass() {
1994 * Define the var IMAP_AUTH_HOST in index.php (with port probably)
1996 * Preferences are handled in _PassUser
1999 function checkPass($submitted_password) {
2000 $userid = $this->_userid;
2001 $mbox = @imap_open( "{" . IMAP_AUTH_HOST . "}",
2002 $userid, $submitted_password, OP_HALFOPEN );
2005 $this->_authmethod = 'IMAP';
2006 $this->_level = WIKIAUTH_USER;
2007 return $this->_level;
2009 trigger_error(_("Unable to connect to IMAP server "). IMAP_AUTH_HOST, E_USER_WARNING);
2012 return $this->_tryNextPass($submitted_password);
2015 //CHECKME: this will not be okay for the auth policy strict
2016 function userExists() {
2018 if (checkPass($this->_prefs->get('passwd')))
2021 return $this->_tryNextUser();
2024 function mayChangePass() {
2031 extends _IMAPPassUser {
2033 * Define the var POP3_AUTH_HOST in index.php
2034 * Preferences are handled in _PassUser
2036 function checkPass($submitted_password) {
2037 $userid = $this->_userid;
2038 $pass = $submitted_password;
2039 $host = defined('POP3_AUTH_HOST') ? POP3_AUTH_HOST : 'localhost:110';
2040 if (defined('POP3_AUTH_PORT'))
2041 $port = POP3_AUTH_PORT;
2042 elseif (strstr($host,':')) {
2043 list(,$port) = split(':',$host);
2048 $fp = fsockopen($host, $port, $errno, $errstr, 10);
2050 // Get welcome string
2051 $line = fgets($fp, 1024);
2052 if (! strncmp("+OK ", $line, 4)) {
2054 fputs($fp, "user $userid\n");
2056 $line = fgets($fp, 1024);
2057 if (! strncmp("+OK ", $line, 4)) {
2059 fputs($fp, "pass $pass\n");
2061 $line = fgets($fp, 1024);
2062 if (! strncmp("+OK ", $line, 4)) {
2067 // quit the connection
2068 fputs($fp, "quit\n");
2069 // Get the sayonara message
2070 $line = fgets($fp, 1024);
2073 trigger_error(_("Couldn't connect to %s","POP3_AUTH_HOST ".$host.':'.$port),
2076 $this->_authmethod = 'POP3';
2078 $this->_level = WIKIAUTH_USER;
2080 $this->_level = WIKIAUTH_ANON;
2082 return $this->_level;
2089 * Check users defined in a .htaccess style file
2090 * username:crypt\n...
2092 * Preferences are handled in _PassUser
2095 var $_file, $_may_change;
2097 // This can only be called from _PassUser, because the parent class
2098 // sets the pref methods, before this class is initialized.
2099 function _FilePassUser($UserName='',$prefs=false,$file='') {
2100 if (!$this->_prefs and isa($this,"_FilePassUser")) {
2101 if ($prefs) $this->_prefs = $prefs;
2102 if (!isset($this->_prefs->_method))
2103 _PassUser::_PassUser($UserName);
2106 $this->_userid = $UserName;
2107 // read the .htaccess style file. We use our own copy of the standard pear class.
2108 //include_once 'lib/pear/File_Passwd.php';
2109 $this->_may_change = defined('AUTH_USER_FILE_STORABLE') && AUTH_USER_FILE_STORABLE;
2110 if (empty($file) and defined('AUTH_USER_FILE'))
2111 $file = AUTH_USER_FILE;
2112 // if passwords may be changed we have to lock them:
2113 if ($this->_may_change) {
2115 $lockfile = $file . ".lock";
2120 // "__PHP_Incomplete_Class"
2121 if (!empty($file) or empty($this->_file) or !isa($this->_file,"File_Passwd"))
2122 $this->_file = new File_Passwd($file, $lock, $lockfile);
2128 function mayChangePass() {
2129 return $this->_may_change;
2132 function userExists() {
2133 $this->_authmethod = 'File';
2134 if (isset($this->_file->users[$this->_userid]))
2137 return $this->_tryNextUser();
2140 function checkPass($submitted_password) {
2141 //include_once 'lib/pear/File_Passwd.php';
2142 if ($this->_file->verifyPassword($this->_userid,$submitted_password)) {
2143 $this->_authmethod = 'File';
2144 $this->_level = WIKIAUTH_USER;
2145 return $this->_level;
2148 return $this->_tryNextPass($submitted_password);
2151 function storePass($submitted_password) {
2152 if ($this->_may_change) {
2153 if ($this->_file->modUser($this->_userid,$submitted_password)) {
2154 $this->_file->close();
2155 $this->_file = new File_Passwd($this->_file->_filename, true, $this->_file->lockfile);
2165 * Insert more auth classes here...
2166 * For example a customized db class for another db connection
2167 * or a socket-based auth server
2173 * For security, this class should not be extended. Instead, extend
2174 * from _PassUser (think of this as unix "root").
2179 function mayChangePass() {
2182 function checkPass($submitted_password) {
2183 $stored_password = ADMIN_PASSWD;
2184 if ($this->_checkPass($submitted_password, $stored_password)) {
2185 $this->_level = WIKIAUTH_ADMIN;
2186 return $this->_level;
2188 $this->_level = WIKIAUTH_ANON;
2189 return $this->_level;
2192 function storePass($submitted_password) {
2197 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
2199 * Various data classes for the preference types,
2200 * to support get, set, sanify (range checking, ...)
2201 * update() will do the neccessary side-effects if a
2202 * setting gets changed (theme, language, ...)
2205 class _UserPreference
2209 function _UserPreference ($default_value) {
2210 $this->default_value = $default_value;
2213 function sanify ($value) {
2214 return (string)$value;
2217 function get ($name) {
2218 if (isset($this->{$name}))
2219 return $this->{$name};
2221 return $this->default_value;
2224 function getraw ($name) {
2225 if (!empty($this->{$name}))
2226 return $this->{$name};
2229 // stores the value as $this->$name, and not as $this->value (clever?)
2230 function set ($name, $value) {
2232 $value = $this->sanify($value);
2233 if ($this->get($name) != $value) {
2234 $this->update($value);
2237 if ($value != $this->default_value) {
2238 $this->{$name} = $value;
2240 unset($this->{$name});
2245 // default: no side-effects
2246 function update ($value) {
2251 class _UserPreference_numeric
2252 extends _UserPreference
2254 function _UserPreference_numeric ($default, $minval = false,
2256 $this->_UserPreference((double)$default);
2257 $this->_minval = (double)$minval;
2258 $this->_maxval = (double)$maxval;
2261 function sanify ($value) {
2262 $value = (double)$value;
2263 if ($this->_minval !== false && $value < $this->_minval)
2264 $value = $this->_minval;
2265 if ($this->_maxval !== false && $value > $this->_maxval)
2266 $value = $this->_maxval;
2271 class _UserPreference_int
2272 extends _UserPreference_numeric
2274 function _UserPreference_int ($default, $minval = false, $maxval = false) {
2275 $this->_UserPreference_numeric((int)$default, (int)$minval, (int)$maxval);
2278 function sanify ($value) {
2279 return (int)parent::sanify((int)$value);
2283 class _UserPreference_bool
2284 extends _UserPreference
2286 function _UserPreference_bool ($default = false) {
2287 $this->_UserPreference((bool)$default);
2290 function sanify ($value) {
2291 if (is_array($value)) {
2292 /* This allows for constructs like:
2294 * <input type="hidden" name="pref[boolPref][]" value="0" />
2295 * <input type="checkbox" name="pref[boolPref][]" value="1" />
2297 * (If the checkbox is not checked, only the hidden input
2298 * gets sent. If the checkbox is sent, both inputs get
2301 foreach ($value as $val) {
2307 return (bool) $value;
2311 class _UserPreference_language
2312 extends _UserPreference
2314 function _UserPreference_language ($default = DEFAULT_LANGUAGE) {
2315 $this->_UserPreference($default);
2318 // FIXME: check for valid locale
2319 function sanify ($value) {
2320 // Revert to DEFAULT_LANGUAGE if user does not specify
2321 // language in UserPreferences or chooses <system language>.
2322 if ($value == '' or empty($value))
2323 $value = DEFAULT_LANGUAGE;
2325 return (string) $value;
2328 function update ($newvalue) {
2329 if (! $this->_init ) {
2330 // invalidate etag to force fresh output
2331 $GLOBALS['request']->setValidators(array('%mtime' => false));
2332 update_locale($newvalue ? $newvalue : $GLOBALS['LANG']);
2337 class _UserPreference_theme
2338 extends _UserPreference
2340 function _UserPreference_theme ($default = THEME) {
2341 $this->_UserPreference($default);
2344 function sanify ($value) {
2345 if (!empty($value) and FindFile($this->_themefile($value)))
2347 return $this->default_value;
2350 function update ($newvalue) {
2352 // invalidate etag to force fresh output
2353 if (! $this->_init )
2354 $GLOBALS['request']->setValidators(array('%mtime' => false));
2356 include_once($this->_themefile($newvalue));
2358 include_once($this->_themefile(THEME));
2361 function _themefile ($theme) {
2362 return "themes/$theme/themeinfo.php";
2366 class _UserPreference_notify
2367 extends _UserPreference
2369 function sanify ($value) {
2373 return $this->default_value;
2376 /** update to global user prefs: side-effect on set notify changes
2377 * use a global_data notify hash:
2378 * notify = array('pagematch' => array(userid => ('email' => mail,
2379 * 'verified' => 0|1),
2383 function update ($value) {
2384 if (!empty($this->_init)) return;
2385 $dbh = $GLOBALS['request']->getDbh();
2386 $notify = $dbh->get('notify');
2391 // expand to existing pages only or store matches?
2392 // for now we store (glob-style) matches which is easier for the user
2393 $pages = $this->_page_split($value);
2394 // Limitation: only current user.
2395 $user = $GLOBALS['request']->getUser();
2396 if (!$user or !method_exists($user,'UserName')) return;
2397 // This fails with php5 and a WIKI_ID cookie:
2398 $userid = $user->UserName();
2399 $email = $user->_prefs->get('email');
2400 $verified = $user->_prefs->_prefs['email']->getraw('emailVerified');
2401 // check existing notify hash and possibly delete pages for email
2402 if (!empty($data)) {
2403 foreach ($data as $page => $users) {
2404 if (isset($data[$page][$userid]) and !in_array($page, $pages)) {
2405 unset($data[$page][$userid]);
2407 if (count($data[$page]) == 0)
2408 unset($data[$page]);
2411 // add the new pages
2412 if (!empty($pages)) {
2413 foreach ($pages as $page) {
2414 if (!isset($data[$page]))
2415 $data[$page] = array();
2416 if (!isset($data[$page][$userid])) {
2417 // should we really store the verification notice here or
2418 // check it dynamically at every page->save?
2420 $data[$page][$userid] = array('email' => $email,
2421 'verified' => $verified);
2423 $data[$page][$userid] = array('email' => $email);
2428 // store users changes
2429 $dbh->set('notify',$data);
2432 /** split the user-given comma or whitespace delimited pagenames
2435 function _page_split($value) {
2436 return preg_split('/[\s,]+/',$value,-1,PREG_SPLIT_NO_EMPTY);
2440 class _UserPreference_email
2441 extends _UserPreference
2443 function sanify($value) {
2444 // check for valid email address
2445 if ($this->get('email') == $value and $this->getraw('emailVerified'))
2448 if ($value == 1 or $value === true)
2450 list($ok,$msg) = ValidateMail($value,'noconnect');
2454 trigger_error("E-Mail Validation Error: ".$msg, E_USER_WARNING);
2455 return $this->default_value;
2459 /** Side-effect on email changes:
2460 * Send a verification mail or for now just a notification email.
2461 * For true verification (value = 2), we'd need a mailserver hook.
2463 function update($value) {
2464 if (!empty($this->_init)) return;
2465 $verified = $this->getraw('emailVerified');
2467 if (($value == 1 or $value === true) and $verified)
2469 if (!empty($value) and !$verified) {
2470 list($ok,$msg) = ValidateMail($value);
2471 if ($ok and mail($value,"[".WIKI_NAME ."] "._("Email Verification"),
2472 sprintf(_("Welcome to %s!\nYou email account is verified and\nwill be used to send pagechange notifications.\nSee %s"),
2473 WIKI_NAME, WikiURL($GLOBALS['request']->getArg('pagename'),'',true))))
2474 $this->set('emailVerified',1);
2479 /** Check for valid email address
2480 fixed version from http://www.zend.com/zend/spotlight/ev12apr.php
2482 function ValidateMail($email, $noconnect=false) {
2483 if (!isset($_SERVER))
2484 $_SERVER =& $GLOBALS['HTTP_SERVER_VARS'];
2485 $HTTP_HOST = $_SERVER['HTTP_HOST'];
2487 // well, technically ".a.a.@host.com" is also valid
2488 if (!eregi("^[_a-z0-9-]+(\.[_a-z0-9-]+)*@[a-z0-9-]+(\.[a-z0-9-]+)*(\.[a-z]{2,3})$", $email)) {
2490 $result[1] = sprintf(_("E-Mail address '%s' is not properly formatted"),$email);
2494 return array(true,sprintf(_("E-Mail address '%s' is properly formatted"),$email));
2496 list ( $Username, $Domain ) = split ("@",$email);
2497 //Todo: getmxrr workaround on windows or manual input field to verify it manually
2498 if (!isWindows() and getmxrr($Domain, $MXHost)) { // avoid warning on Windows.
2499 $ConnectAddress = $MXHost[0];
2501 $ConnectAddress = $Domain;
2503 $Connect = fsockopen ( $ConnectAddress, 25 );
2505 if (ereg("^220", $Out = fgets($Connect, 1024))) {
2506 fputs ($Connect, "HELO $HTTP_HOST\r\n");
2507 $Out = fgets ( $Connect, 1024 );
2508 fputs ($Connect, "MAIL FROM: <".$email.">\r\n");
2509 $From = fgets ( $Connect, 1024 );
2510 fputs ($Connect, "RCPT TO: <".$email.">\r\n");
2511 $To = fgets ($Connect, 1024);
2512 fputs ($Connect, "QUIT\r\n");
2514 if (!ereg ("^250", $From)) {
2516 $result[1]="Server rejected address: ". $From;
2519 if (!ereg ( "^250", $To )) {
2521 $result[1]="Server rejected address: ". $To;
2526 $result[1] = "No response from server";
2531 $result[1]="Can not connect E-Mail server.";
2535 $result[1]="E-Mail address '$email' appears to be valid.";
2537 } // end of function
2539 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
2544 * This object holds the $request->_prefs subobjects.
2545 * A simple packed array of non-default values get's stored as cookie,
2546 * homepage, or database, which are converted to the array of
2548 * We don't store the objects, because otherwise we will
2549 * not be able to upgrade any subobject. And it's a waste of space also.
2552 class UserPreferences
2554 function UserPreferences($saved_prefs = false) {
2555 // userid stored too, to ensure the prefs are being loaded for
2556 // the correct (currently signing in) userid if stored in a
2558 // Update: for db prefs we disallow passwd.
2559 // userid is needed for pref reflexion. current pref must know its username,
2560 // if some app needs prefs from different users, different from current user.
2563 'userid' => new _UserPreference(''),
2564 'passwd' => new _UserPreference(''),
2565 'autologin' => new _UserPreference_bool(),
2566 //'emailVerified' => new _UserPreference_emailVerified(),
2567 //fixed: store emailVerified as email parameter, 1.3.8
2568 'email' => new _UserPreference_email(''),
2569 'notifyPages' => new _UserPreference_notify(''), // 1.3.8
2570 'theme' => new _UserPreference_theme(THEME),
2571 'lang' => new _UserPreference_language(DEFAULT_LANGUAGE),
2572 'editWidth' => new _UserPreference_int(EDITWIDTH_DEFAULT_COLS,
2574 EDITWIDTH_MAX_COLS),
2575 'noLinkIcons' => new _UserPreference_bool(), // 1.3.8
2576 'editHeight' => new _UserPreference_int(EDITHEIGHT_DEFAULT_ROWS,
2577 EDITHEIGHT_MIN_ROWS,
2578 EDITHEIGHT_DEFAULT_ROWS),
2579 'timeOffset' => new _UserPreference_numeric(TIMEOFFSET_DEFAULT_HOURS,
2580 TIMEOFFSET_MIN_HOURS,
2581 TIMEOFFSET_MAX_HOURS),
2582 'relativeDates' => new _UserPreference_bool(),
2583 'googleLink' => new _UserPreference_bool(), // 1.3.10
2585 // add custom theme-specific pref types:
2586 // FIXME: on theme changes the wiki_user session pref object will fail.
2587 // We will silently ignore this.
2588 if (!empty($customUserPreferenceColumns))
2589 $this->_prefs = array_merge($this->_prefs,$customUserPreferenceColumns);
2591 if (isset($this->_method) and $this->_method == 'SQL') {
2592 //unset($this->_prefs['userid']);
2593 unset($this->_prefs['passwd']);
2596 if (is_array($saved_prefs)) {
2597 foreach ($saved_prefs as $name => $value)
2598 $this->set($name, $value);
2602 function _getPref($name) {
2603 if ($name == 'emailVerified')
2605 if (!isset($this->_prefs[$name])) {
2606 if ($name == 'passwd2') return false;
2607 if ($name == 'passwd') return false;
2608 trigger_error("$name: unknown preference", E_USER_NOTICE);
2611 return $this->_prefs[$name];
2614 // get the value or default_value of the subobject
2615 function get($name) {
2616 if ($_pref = $this->_getPref($name))
2617 if ($name == 'emailVerified')
2618 return $_pref->getraw($name);
2620 return $_pref->get($name);
2625 // check and set the new value in the subobject
2626 function set($name, $value) {
2627 $pref = $this->_getPref($name);
2628 if ($pref === false)
2631 /* do it here or outside? */
2632 if ($name == 'passwd' and
2633 defined('PASSWORD_LENGTH_MINIMUM') and
2634 strlen($value) <= PASSWORD_LENGTH_MINIMUM ) {
2635 //TODO: How to notify the user?
2639 if ($name == 'theme' and $value == '')
2642 if (!isset($pref->{$value}) or $pref->{$value} != $pref->default_value) {
2643 if ($name == 'emailVerified') $newvalue = $value;
2644 else $newvalue = $pref->sanify($value);
2645 $pref->set($name,$newvalue);
2647 $this->_prefs[$name] =& $pref;
2651 * use init to avoid update on set
2653 function updatePrefs($prefs, $init = false) {
2655 if ($init) $this->_init = $init;
2656 if (is_object($prefs)) {
2657 $type = 'emailVerified'; $obj =& $this->_prefs['email'];
2658 $obj->_init = $init;
2659 if ($obj->get($type) !== $prefs->get($type)) {
2660 if ($obj->set($type,$prefs->get($type)))
2663 foreach (array_keys($this->_prefs) as $type) {
2664 $obj =& $this->_prefs[$type];
2665 $obj->_init = $init;
2666 if ($prefs->get($type) !== $obj->get($type)) {
2667 // special systemdefault prefs: (probably not needed)
2668 if ($type == 'theme' and $prefs->get($type) == '' and $obj->get($type) == THEME) continue;
2669 if ($type == 'lang' and $prefs->get($type) == '' and $obj->get($type) == DEFAULT_LANGUAGE) continue;
2670 if ($this->_prefs[$type]->set($type,$prefs->get($type)))
2674 } elseif (is_array($prefs)) {
2675 //unset($this->_prefs['userid']);
2676 if (isset($this->_method) and
2677 ($this->_method == 'SQL' or $this->_method == 'ADODB')) {
2678 unset($this->_prefs['passwd']);
2680 // emailVerified at first, the rest later
2681 $type = 'emailVerified'; $obj =& $this->_prefs['email'];
2682 $obj->_init = $init;
2683 if (isset($prefs[$type]) and $obj->get($type) !== $prefs[$type]) {
2684 if ($obj->set($type,$prefs[$type]))
2687 foreach (array_keys($this->_prefs) as $type) {
2688 $obj =& $this->_prefs[$type];
2689 $obj->_init = $init;
2690 if (!isset($prefs[$type]) and isa($obj,"_UserPreference_bool"))
2691 $prefs[$type] = false;
2692 if (isset($prefs[$type]) and isa($obj,"_UserPreference_int"))
2693 $prefs[$type] = (int) $prefs[$type];
2694 if (isset($prefs[$type]) and $obj->get($type) != $prefs[$type]) {
2695 // special systemdefault prefs:
2696 if ($type == 'theme' and $prefs[$type] == '' and $obj->get($type) == THEME) continue;
2697 if ($type == 'lang' and $prefs[$type] == '' and $obj->get($type) == DEFAULT_LANGUAGE) continue;
2698 if ($obj->set($type,$prefs[$type]))
2706 // for now convert just array of objects => array of values
2707 // Todo: the specialized subobjects must override this.
2710 foreach ($this->_prefs as $name => $object) {
2711 if ($value = $object->getraw($name))
2712 $prefs[$name] = $value;
2713 if ($name == 'email' and ($value = $object->getraw('emailVerified')))
2714 $prefs['emailVerified'] = $value;
2716 return $this->pack($prefs);
2719 // packed string or array of values => array of values
2720 // Todo: the specialized subobjects must override this.
2721 function retrieve($packed) {
2722 if (is_string($packed) and (substr($packed, 0, 2) == "a:"))
2723 $packed = unserialize($packed);
2724 if (!is_array($packed)) return false;
2726 foreach ($packed as $name => $packed_pref) {
2727 if (is_string($packed_pref) and substr($packed_pref, 0, 2) == "O:") {
2728 //legacy: check if it's an old array of objects
2729 // Looks like a serialized object.
2730 // This might fail if the object definition does not exist anymore.
2731 // object with ->$name and ->default_value vars.
2732 $pref = @unserialize($packed_pref);
2734 $pref = @unserialize(base64_decode($packed_pref));
2735 $prefs[$name] = $pref->get($name);
2736 // fix old-style prefs
2737 } elseif (is_numeric($name) and is_array($packed_pref)) {
2738 if (count($packed_pref) == 1) {
2739 list($name,$value) = each($packed_pref);
2740 $prefs[$name] = $value;
2743 $prefs[$name] = @unserialize($packed_pref);
2744 if (empty($prefs[$name]))
2745 $prefs[$name] = @unserialize(base64_decode($packed_pref));
2746 // patched by frederik@pandora.be
2747 if (empty($prefs[$name]))
2748 $prefs[$name] = $packed_pref;
2755 * Check if the given prefs object is different from the current prefs object
2757 function isChanged($other) {
2758 foreach ($this->_prefs as $type => $obj) {
2759 if ($obj->get($type) !== $other->get($type))
2765 function defaultPreferences() {
2767 foreach ($this->_prefs as $key => $obj) {
2768 $prefs[$key] = $obj->default_value;
2775 return $this->_prefs;
2778 function pack($nonpacked) {
2779 return serialize($nonpacked);
2782 function unpack($packed) {
2785 //$packed = base64_decode($packed);
2786 if (substr($packed, 0, 2) == "O:") {
2787 // Looks like a serialized object
2788 return unserialize($packed);
2790 if (substr($packed, 0, 2) == "a:") {
2791 return unserialize($packed);
2793 //trigger_error("DEBUG: Can't unpack bad UserPreferences",
2799 return hash($this->_prefs);
2803 /** TODO: new pref storage classes
2804 * These are currently user specific and should be rewritten to be pref specific.
2805 * i.e. $this == $user->_prefs
2807 class CookieUserPreferences
2808 extends UserPreferences
2810 function CookieUserPreferences ($saved_prefs = false) {
2811 //_AnonUser::_AnonUser('',$saved_prefs);
2812 UserPreferences::UserPreferences($saved_prefs);
2816 class PageUserPreferences
2817 extends UserPreferences
2819 function PageUserPreferences ($saved_prefs = false) {
2820 UserPreferences::UserPreferences($saved_prefs);
2824 class PearDbUserPreferences
2825 extends UserPreferences
2827 function PearDbUserPreferences ($saved_prefs = false) {
2828 UserPreferences::UserPreferences($saved_prefs);
2832 class AdoDbUserPreferences
2833 extends UserPreferences
2835 function AdoDbUserPreferences ($saved_prefs = false) {
2836 UserPreferences::UserPreferences($saved_prefs);
2838 function getPreferences() {
2839 // override the generic slow method here for efficiency
2840 _AnonUser::getPreferences();
2841 $this->getAuthDbh();
2842 if (isset($this->_select)) {
2843 $dbh = & $this->_auth_dbi;
2844 $rs = $dbh->Execute(sprintf($this->_select,$dbh->qstr($this->_userid)));
2848 $prefs_blob = $rs->fields['pref_blob'];
2850 if ($restored_from_db = $this->_prefs->retrieve($prefs_blob)) {
2851 $updated = $this->_prefs->updatePrefs($restored_from_db);
2852 //$this->_prefs = new UserPreferences($restored_from_db);
2853 return $this->_prefs;
2857 if (empty($this->_prefs->_prefs) and $this->_HomePagehandle) {
2858 if ($restored_from_page = $this->_prefs->retrieve($this->_HomePagehandle->get('pref'))) {
2859 $updated = $this->_prefs->updatePrefs($restored_from_page);
2860 //$this->_prefs = new UserPreferences($restored_from_page);
2861 return $this->_prefs;
2864 return $this->_prefs;
2869 // $Log: not supported by cvs2svn $
2870 // Revision 1.71 2004/05/10 12:34:47 rurban
2871 // stabilize DbAuthParam statement pre-prozessor:
2872 // try old-style and new-style (double-)quoting
2873 // reject unknown $variables
2874 // use ->prepare() for all calls (again)
2876 // Revision 1.70 2004/05/06 19:26:16 rurban
2877 // improve stability, trying to find the InlineParser endless loop on sf.net
2879 // remove end-of-zip comments to fix sf.net bug #777278 and probably #859628
2881 // Revision 1.69 2004/05/06 13:56:40 rurban
2882 // Enable the Administrators group, and add the WIKIPAGE group default root page.
2884 // Revision 1.68 2004/05/05 13:37:54 rurban
2885 // Support to remove all UserPreferences
2887 // Revision 1.66 2004/05/03 21:44:24 rurban
2888 // fixed sf,net bug #947264: LDAP options are constants, not strings!
2890 // Revision 1.65 2004/05/03 13:16:47 rurban
2891 // fixed UserPreferences update, esp for boolean and int
2893 // Revision 1.64 2004/05/02 15:10:06 rurban
2894 // new finally reliable way to detect if /index.php is called directly
2895 // and if to include lib/main.php
2896 // new global AllActionPages
2897 // SetupWiki now loads all mandatory pages: HOME_PAGE, action pages, and warns if not.
2898 // WikiTranslation what=buttons for Carsten to create the missing MacOSX buttons
2899 // PageGroupTestOne => subpages
2900 // renamed PhpWikiRss to PhpWikiRecentChanges
2901 // more docs, default configs, ...
2903 // Revision 1.63 2004/05/01 15:59:29 rurban
2904 // more php-4.0.6 compatibility: superglobals
2906 // Revision 1.62 2004/04/29 18:31:24 rurban
2907 // Prevent from warning where no db pref was previously stored.
2909 // Revision 1.61 2004/04/29 17:18:19 zorloc
2910 // 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.
2912 // Revision 1.60 2004/04/27 18:20:54 rurban
2913 // sf.net patch #940359 by rassie
2915 // Revision 1.59 2004/04/26 12:35:21 rurban
2916 // POP3_AUTH_PORT deprecated, use "host:port" similar to IMAP
2917 // File_Passwd is already loaded
2919 // Revision 1.58 2004/04/20 17:08:28 rurban
2920 // Some IniConfig fixes: prepend our private lib/pear dir
2921 // switch from " to ' in the auth statements
2922 // use error handling.
2923 // WikiUserNew changes for the new "'$variable'" syntax
2924 // in the statements
2925 // TODO: optimization to put config vars into the session.
2927 // Revision 1.57 2004/04/19 18:27:45 rurban
2928 // Prevent from some PHP5 warnings (ref args, no :: object init)
2929 // php5 runs now through, just one wrong XmlElement object init missing
2930 // Removed unneccesary UpgradeUser lines
2931 // Changed WikiLink to omit version if current (RecentChanges)
2933 // Revision 1.56 2004/04/19 09:13:24 rurban
2934 // new pref: googleLink
2936 // Revision 1.54 2004/04/18 00:24:45 rurban
2937 // re-use our simple prepare: just for table prefix warnings
2939 // Revision 1.53 2004/04/12 18:29:15 rurban
2940 // exp. Session auth for already authenticated users from another app
2942 // Revision 1.52 2004/04/12 13:04:50 rurban
2943 // added auth_create: self-registering Db users
2945 // removed rating recommendations
2946 // ziplib reformatting
2948 // Revision 1.51 2004/04/11 10:42:02 rurban
2949 // pgsrc/CreatePagePlugin
2951 // Revision 1.50 2004/04/10 05:34:35 rurban
2954 // Revision 1.49 2004/04/07 23:13:18 rurban
2955 // fixed pear/File_Passwd for Windows
2956 // fixed FilePassUser sessions (filehandle revive) and password update
2958 // Revision 1.48 2004/04/06 20:00:10 rurban
2959 // Cleanup of special PageList column types
2960 // Added support of plugin and theme specific Pagelist Types
2961 // Added support for theme specific UserPreferences
2962 // Added session support for ip-based throttling
2963 // sql table schema change: ALTER TABLE session ADD sess_ip CHAR(15);
2964 // Enhanced postgres schema
2965 // Added DB_Session_dba support
2967 // Revision 1.47 2004/04/02 15:06:55 rurban
2968 // fixed a nasty ADODB_mysql session update bug
2969 // improved UserPreferences layout (tabled hints)
2970 // fixed UserPreferences auth handling
2971 // improved auth stability
2972 // improved old cookie handling: fixed deletion of old cookies with paths
2974 // Revision 1.46 2004/04/01 06:29:51 rurban
2976 // RateIt also for ADODB
2978 // Revision 1.45 2004/03/30 02:14:03 rurban
2979 // fixed yet another Prefs bug
2980 // added generic PearDb_iter
2981 // $request->appendValidators no so strict as before
2982 // added some box plugin methods
2983 // PageList commalist for condensed output
2985 // Revision 1.44 2004/03/27 22:01:03 rurban
2986 // two catches by Konstantin Zadorozhny
2988 // Revision 1.43 2004/03/27 19:40:09 rurban
2989 // init fix and validator reset
2991 // Revision 1.40 2004/03/25 22:54:31 rurban
2994 // Revision 1.38 2004/03/25 17:37:36 rurban
2995 // helper to patch to and from php5 (workaround for stricter parser, no macros in php)
2997 // Revision 1.37 2004/03/25 17:00:31 rurban
2998 // more code to convert old-style pref array to new hash
3000 // Revision 1.36 2004/03/24 19:39:02 rurban
3001 // php5 workaround code (plus some interim debugging code in XmlElement)
3002 // php5 doesn't work yet with the current XmlElement class constructors,
3003 // WikiUserNew does work better than php4.
3004 // rewrote WikiUserNew user upgrading to ease php5 update
3005 // fixed pref handling in WikiUserNew
3006 // added Email Notification
3007 // added simple Email verification
3008 // removed emailVerify userpref subclass: just a email property
3009 // changed pref binary storage layout: numarray => hash of non default values
3010 // print optimize message only if really done.
3011 // forced new cookie policy: delete pref cookies, use only WIKI_ID as plain string.
3012 // prefs should be stored in db or homepage, besides the current session.
3014 // Revision 1.35 2004/03/18 22:18:31 rurban
3015 // workaround for php5 object upgrading problem
3017 // Revision 1.34 2004/03/18 21:41:09 rurban
3018 // fixed sqlite support
3019 // WikiUserNew: PHP5 fixes: don't assign $this (untested)
3021 // Revision 1.33 2004/03/16 15:42:04 rurban
3022 // more fixes for undefined property warnings
3024 // Revision 1.32 2004/03/14 16:30:52 rurban
3025 // db-handle session revivification, dba fixes
3027 // Revision 1.31 2004/03/12 23:20:58 rurban
3028 // pref fixes (base64)
3030 // Revision 1.30 2004/03/12 20:59:17 rurban
3031 // important cookie fix by Konstantin Zadorozhny
3032 // new editpage feature: JS_SEARCHREPLACE
3034 // Revision 1.29 2004/03/11 13:30:47 rurban
3035 // fixed File Auth for user and group
3036 // missing only getMembersOf(Authenticated Users),getMembersOf(Every),getMembersOf(Signed Users)
3038 // Revision 1.28 2004/03/08 18:17:09 rurban
3039 // added more WikiGroup::getMembersOf methods, esp. for special groups
3040 // fixed $LDAP_SET_OPTIONS
3041 // fixed _AuthInfo group methods
3043 // Revision 1.27 2004/03/01 09:35:13 rurban
3044 // fixed DbPassuser pref init; lost userid
3046 // Revision 1.26 2004/02/29 04:10:56 rurban
3047 // new POP3 auth (thanks to BiloBilo: pentothal at despammed dot com)
3048 // fixed syntax error in index.php
3050 // Revision 1.25 2004/02/28 22:25:07 rurban
3051 // First PagePerm implementation:
3053 // $Theme->setAnonEditUnknownLinks(false);
3055 // Layout improvement with dangling links for mostly closed wiki's:
3056 // If false, only users with edit permissions will be presented the
3057 // special wikiunknown class with "?" and Tooltip.
3058 // If true (default), any user will see the ?, but will be presented
3059 // the PrintLoginForm on a click.
3061 // Revision 1.24 2004/02/28 21:14:08 rurban
3062 // generally more PHPDOC docs
3063 // see http://xarch.tu-graz.ac.at/home/rurban/phpwiki/xref/
3064 // fxied WikiUserNew pref handling: empty theme not stored, save only
3065 // changed prefs, sql prefs improved, fixed password update,
3066 // removed REPLACE sql (dangerous)
3067 // moved gettext init after the locale was guessed
3068 // + some minor changes
3070 // Revision 1.23 2004/02/27 13:21:17 rurban
3071 // several performance improvements, esp. with peardb
3073 // storepass seperated from prefs if defined so
3074 // stacked and strict still not working
3076 // Revision 1.22 2004/02/27 05:15:40 rurban
3077 // more stability. detected by Micki
3079 // Revision 1.21 2004/02/26 20:43:49 rurban
3080 // new HttpAuthPassUser class (forces http auth if in the auth loop)
3081 // fixed user upgrade: don't return _PassUser in the first hand.
3083 // Revision 1.20 2004/02/26 01:29:11 rurban
3084 // important fixes: endless loops in certain cases. minor rewrite
3086 // Revision 1.19 2004/02/25 17:15:17 rurban
3087 // improve stability
3089 // Revision 1.18 2004/02/24 15:20:05 rurban
3090 // fixed minor warnings: unchecked args, POST => Get urls for sortby e.g.
3092 // Revision 1.17 2004/02/17 12:16:42 rurban
3093 // started with changePass support. not yet used.
3095 // Revision 1.16 2004/02/15 22:23:45 rurban
3096 // oops, fixed showstopper (endless recursion)
3098 // Revision 1.15 2004/02/15 21:34:37 rurban
3099 // PageList enhanced and improved.
3100 // fixed new WikiAdmin... plugins
3101 // editpage, Theme with exp. htmlarea framework
3102 // (htmlarea yet committed, this is really questionable)
3103 // WikiUser... code with better session handling for prefs
3104 // enhanced UserPreferences (again)
3105 // RecentChanges for show_deleted: how should pages be deleted then?
3107 // Revision 1.14 2004/02/15 17:30:13 rurban
3108 // workaround for lost db connnection handle on session restauration (->_auth_dbi)
3109 // fixed getPreferences() (esp. from sessions)
3110 // fixed setPreferences() (update and set),
3111 // fixed AdoDb DB statements,
3112 // update prefs only at UserPreferences POST (for testing)
3113 // unified db prefs methods (but in external pref classes yet)
3115 // Revision 1.13 2004/02/09 03:58:12 rurban
3116 // for now default DB_SESSION to false
3118 // * not existing perms will now query the parent, and not
3119 // return the default perm
3120 // * added pagePermissions func which returns the object per page
3121 // * added getAccessDescription
3123 // * added global ->prepare (not yet used) with smart user/pref/member table prefixing.
3124 // * force init of authdbh in the 2 db classes
3126 // * fixed session handling (not triple auth request anymore)
3127 // * don't store cookie prefs with sessions
3128 // stdlib: global obj2hash helper from _AuthInfo, also needed for PagePerm
3130 // Revision 1.12 2004/02/07 10:41:25 rurban
3131 // fixed auth from session (still double code but works)
3133 // fixed DbPassUser upgrade and policy=old
3136 // Revision 1.11 2004/02/03 09:45:39 rurban
3137 // LDAP cleanup, start of new Pref classes
3139 // Revision 1.10 2004/02/01 09:14:11 rurban
3140 // Started with Group_Ldap (not yet ready)
3141 // added new _AuthInfo plugin to help in auth problems (warning: may display passwords)
3142 // fixed some configurator vars
3143 // renamed LDAP_AUTH_SEARCH to LDAP_BASE_DN
3144 // changed PHPWIKI_VERSION from 1.3.8a to 1.3.8pre
3145 // USE_DB_SESSION defaults to true on SQL
3146 // changed GROUP_METHOD definition to string, not constants
3147 // changed sample user DBAuthParams from UPDATE to REPLACE to be able to
3148 // create users. (Not to be used with external databases generally, but
3149 // with the default internal user table)
3151 // fixed the IndexAsConfigProblem logic. this was flawed:
3152 // scripts which are the same virtual path defined their own lib/main call
3153 // (hmm, have to test this better, phpwiki.sf.net/demo works again)
3155 // Revision 1.9 2004/01/30 19:57:58 rurban
3156 // fixed DBAuthParams['pref_select']: wrong _auth_dbi object used.
3158 // Revision 1.8 2004/01/30 18:46:15 rurban
3159 // fix "lib/WikiUserNew.php:572: Notice[8]: Undefined variable: DBParams"
3161 // Revision 1.7 2004/01/27 23:23:39 rurban
3162 // renamed ->Username => _userid for consistency
3163 // renamed mayCheckPassword => mayCheckPass
3164 // fixed recursion problem in WikiUserNew
3165 // fixed bogo login (but not quite 100% ready yet, password storage)
3167 // Revision 1.6 2004/01/26 09:17:49 rurban
3168 // * changed stored pref representation as before.
3169 // the array of objects is 1) bigger and 2)
3170 // less portable. If we would import packed pref
3171 // objects and the object definition was changed, PHP would fail.
3172 // This doesn't happen with an simple array of non-default values.
3173 // * use $prefs->retrieve and $prefs->store methods, where retrieve
3174 // understands the interim format of array of objects also.
3175 // * simplified $prefs->get() and fixed $prefs->set()
3176 // * added $user->_userid and class '_WikiUser' portability functions
3177 // * fixed $user object ->_level upgrading, mostly using sessions.
3178 // this fixes yesterdays problems with loosing authorization level.
3179 // * fixed WikiUserNew::checkPass to return the _level
3180 // * fixed WikiUserNew::isSignedIn
3181 // * added explodePageList to class PageList, support sortby arg
3182 // * fixed UserPreferences for WikiUserNew
3183 // * fixed WikiPlugin for empty defaults array
3184 // * UnfoldSubpages: added pagename arg, renamed pages arg,
3185 // removed sort arg, support sortby arg
3187 // Revision 1.5 2004/01/25 03:05:00 rurban
3188 // First working version, but has some problems with the current main loop.
3189 // Implemented new auth method dispatcher and policies, all the external
3190 // _PassUser classes (also for ADODB and Pear DB).
3191 // The two global funcs UserExists() and CheckPass() are probably not needed,
3192 // since the auth loop is done recursively inside the class code, upgrading
3193 // the user class within itself.
3194 // Note: When a higher user class is returned, this doesn't mean that the user
3195 // is authorized, $user->_level is still low, and only upgraded on successful
3198 // Revision 1.4 2003/12/07 19:29:48 carstenklapp
3199 // Code Housecleaning: fixed syntax errors. (php -l *.php)
3201 // Revision 1.3 2003/12/06 19:10:46 carstenklapp
3202 // Finished off logic for determining user class, including
3203 // PassUser. Removed ability of BogoUser to save prefs into a page.
3205 // Revision 1.2 2003/12/03 21:45:48 carstenklapp
3206 // Added admin user, password user, and preference classes. Added
3207 // password checking functions for users and the admin. (Now the easy
3208 // parts are nearly done).
3210 // Revision 1.1 2003/12/02 05:46:36 carstenklapp
3211 // Complete rewrite of WikiUser.php.
3213 // This should make it easier to hook in user permission groups etc. some
3214 // time in the future. Most importantly, to finally get UserPreferences
3215 // fully working properly for all classes of users: AnonUser, BogoUser,
3216 // AdminUser; whether they have a NamesakePage (PersonalHomePage) or not,
3217 // want a cookie or not, and to bring back optional AutoLogin with the
3218 // UserName stored in a cookie--something that was lost after PhpWiki had
3219 // dropped the default http auth login method.
3221 // Added WikiUser classes which will (almost) work together with existing
3222 // UserPreferences class. Other parts of PhpWiki need to be updated yet
3223 // before this code can be hooked up.
3229 // c-basic-offset: 4
3230 // c-hanging-comment-ender-p: nil
3231 // indent-tabs-mode: nil