3 /* Copyright (C) 2004,2005,2006,2007,2009 $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 name, authlevel and user's preferences.
27 * This object might get upgraded during the login step and later also.
28 * There exist three preferences storage methods: cookie, homepage and db,
29 * and multiple password checking methods.
30 * See index.php for $USER_AUTH_ORDER[] and USER_AUTH_POLICY if
31 * ALLOW_USER_PASSWORDS is defined.
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 config/config.ini
62 * 1) Now a ForbiddenUser is returned instead of false.
63 * 2) Previously ALLOW_ANON_USER = false meant that anon users cannot edit,
64 * but may browse. Now with ALLOW_ANON_USER = false he may not browse,
65 * which is needed to disable browse PagePermissions.
66 * I added now ALLOW_ANON_EDIT = true to makes things clear.
67 * (which replaces REQUIRE_SIGNIN_BEFORE_EDIT)
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.
82 * Update: not needed anymore. we use eval to fool the load-time syntax checker.
84 * 6) enforced new cookie policy: prefs don't get stored in cookies
85 * anymore, only in homepage and/or database, but always in the
86 * current session. old pref cookies will get deleted.
88 * 7) Certain themes should be able to extend the predefined list
89 * of preferences. Display/editing is done in the theme specific userprefs.tmpl,
90 * but storage must be extended to the Get/SetPreferences methods.
91 * <theme>/themeinfo.php must provide CustomUserPreferences:
92 * A list of name => _UserPreference class pairs.
95 define('WIKIAUTH_FORBIDDEN', -1); // Completely not allowed.
96 define('WIKIAUTH_ANON', 0); // Not signed in.
97 define('WIKIAUTH_BOGO', 1); // Any valid WikiWord is enough.
98 define('WIKIAUTH_USER', 2); // Bogo user with a password.
99 define('WIKIAUTH_ADMIN', 10); // UserName == ADMIN_USER.
100 define('WIKIAUTH_UNOBTAINABLE', 100); // Permissions that no user can achieve
102 //if (!defined('COOKIE_EXPIRATION_DAYS')) define('COOKIE_EXPIRATION_DAYS', 365);
103 //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);
116 /* EMAIL VERIFICATION
117 * On certain nets or hosts the email domain cannot be determined automatically from the DNS.
118 * Provide some overrides here.
119 * ( username @ ) domain => mail-domain
121 $EMailHosts = array('avl.com' => 'mail.avl.com');
124 * There are be the following constants in config/config.ini to
125 * establish login parameters:
127 * ALLOW_ANON_USER default true
128 * ALLOW_ANON_EDIT default true
129 * ALLOW_BOGO_LOGIN default true
130 * ALLOW_USER_PASSWORDS default true
131 * PASSWORD_LENGTH_MINIMUM default 0
133 * To require user passwords for editing:
134 * ALLOW_ANON_USER = true
135 * ALLOW_ANON_EDIT = false (before named REQUIRE_SIGNIN_BEFORE_EDIT)
136 * ALLOW_BOGO_LOGIN = false
137 * ALLOW_USER_PASSWORDS = true
139 * To establish a COMPLETELY private wiki, such as an internal
141 * ALLOW_ANON_USER = false
142 * (and probably require user passwords as described above). In this
143 * case the user will be prompted to login immediately upon accessing
146 * There are other possible combinations, but the typical wiki (such
147 * as http://PhpWiki.sf.net/phpwiki) would usually just leave all four
152 // The last object in the row is the bad guy...
153 if (!is_array($USER_AUTH_ORDER))
154 $USER_AUTH_ORDER = array("Forbidden");
156 $USER_AUTH_ORDER[] = "Forbidden";
158 // Local convenience functions.
159 function _isAnonUserAllowed() {
160 return (defined('ALLOW_ANON_USER') && ALLOW_ANON_USER);
162 function _isBogoUserAllowed() {
163 return (defined('ALLOW_BOGO_LOGIN') && ALLOW_BOGO_LOGIN);
165 function _isUserPasswordsAllowed() {
166 return (defined('ALLOW_USER_PASSWORDS') && ALLOW_USER_PASSWORDS);
169 // Possibly upgrade userobject functions.
170 function _determineAdminUserOrOtherUser($UserName) {
171 // Sanity check. User name is a condition of the definition of the
172 // _AdminUser, _BogoUser and _passuser.
174 return $GLOBALS['ForbiddenUser'];
176 //FIXME: check admin membership later at checkPass. Now we cannot raise the level.
177 //$group = &WikiGroup::getGroup($GLOBALS['request']);
178 if ($UserName == ADMIN_USER)
179 return new _AdminUser($UserName);
180 /* elseif ($group->isMember(GROUP_ADMIN)) { // unneeded code
181 return _determineBogoUserOrPassUser($UserName);
185 return _determineBogoUserOrPassUser($UserName);
188 function _determineBogoUserOrPassUser($UserName) {
189 global $ForbiddenUser;
191 // Sanity check. User name is a condition of the definition of
192 // _BogoUser and _PassUser.
194 return $ForbiddenUser;
196 // Check for password and possibly upgrade user object.
197 // $_BogoUser = new _BogoUser($UserName);
198 if (_isBogoUserAllowed() and isWikiWord($UserName)) {
199 include_once("lib/WikiUser/BogoLogin.php");
200 $_BogoUser = new _BogoLoginPassUser($UserName);
201 if ($_BogoUser->userExists() or $GLOBALS['request']->getArg('auth'))
204 if (_isUserPasswordsAllowed()) {
205 // PassUsers override BogoUsers if a password is stored
206 if (isset($_BogoUser) and isset($_BogoUser->_prefs)
207 and $_BogoUser->_prefs->get('passwd'))
208 return new _PassUser($UserName, $_BogoUser->_prefs);
210 $_PassUser = new _PassUser($UserName,
211 isset($_BogoUser) ? $_BogoUser->_prefs : false);
212 if ($_PassUser->userExists() or $GLOBALS['request']->getArg('auth')) {
213 if (isset($GLOBALS['request']->_user_class))
214 $class = $GLOBALS['request']->_user_class;
215 elseif (strtolower(get_class($_PassUser)) == "_passuser")
216 $class = $_PassUser->nextClass();
218 $class = get_class($_PassUser);
219 if ($user = new $class($UserName, $_PassUser->_prefs)) {
227 // No Bogo- or PassUser exists, or
228 // passwords are not allowed, and bogo is disallowed too.
229 // (Only the admin can sign in).
230 return $ForbiddenUser;
234 * Primary WikiUser function, called by lib/main.php.
236 * This determines the user's type and returns an appropriate user
237 * object. lib/main.php then querys the resultant object for password
238 * validity as necessary.
240 * If an _AnonUser object is returned, the user may only browse pages
241 * (and save prefs in a cookie).
243 * To disable access but provide prefs the global $ForbiddenUser class
244 * is returned. (was previously false)
247 function WikiUser ($UserName = '') {
248 global $ForbiddenUser, $HTTP_SESSION_VARS;
250 //Maybe: Check sessionvar for username & save username into
251 //sessionvar (may be more appropriate to do this in lib/main.php).
253 $ForbiddenUser = new _ForbiddenUser($UserName);
254 // Found a user name.
255 return _determineAdminUserOrOtherUser($UserName);
257 elseif (!empty($HTTP_SESSION_VARS['userid'])) {
258 // Found a user name.
259 $ForbiddenUser = new _ForbiddenUser($_SESSION['userid']);
260 return _determineAdminUserOrOtherUser($_SESSION['userid']);
263 // Check for autologin pref in cookie and possibly upgrade
264 // user object to another type.
265 $_AnonUser = new _AnonUser();
266 if ($UserName = $_AnonUser->_userid && $_AnonUser->_prefs->get('autologin')) {
267 // Found a user name.
268 $ForbiddenUser = new _ForbiddenUser($UserName);
269 return _determineAdminUserOrOtherUser($UserName);
272 $ForbiddenUser = new _ForbiddenUser();
273 if (_isAnonUserAllowed())
275 return $ForbiddenUser; // User must sign in to browse pages.
277 return $ForbiddenUser; // User must sign in with a password.
280 trigger_error("DEBUG: Note: End of function reached in WikiUser." . " "
281 . "Unexpectedly, an appropriate user class could not be determined.");
282 return $ForbiddenUser; // Failsafe.
287 * WikiUser.php use the name 'WikiUser'
289 function WikiUserClassname() {
295 * Upgrade olduser by copying properties from user to olduser.
296 * We are not sure yet, for which php's a simple $this = $user works reliably,
297 * (on php4 it works ok, on php5 it's currently disallowed on the parser level)
298 * that's why try it the hard way.
300 function UpgradeUser ($user, $newuser) {
301 if (isa($user,'_WikiUser') and isa($newuser,'_WikiUser')) {
302 // populate the upgraded class $newuser with the values from the current user object
303 //only _auth_level, _current_method, _current_index,
304 if (!empty($user->_level) and
305 $user->_level > $newuser->_level)
306 $newuser->_level = $user->_level;
307 if (!empty($user->_current_index) and
308 $user->_current_index > $newuser->_current_index) {
309 $newuser->_current_index = $user->_current_index;
310 $newuser->_current_method = $user->_current_method;
312 if (!empty($user->_authmethod))
313 $newuser->_authmethod = $user->_authmethod;
314 $GLOBALS['request']->_user_class = get_class($newuser);
316 foreach (get_object_vars($user) as $k => $v) {
317 if (!empty($v)) $olduser->$k = $v;
320 $newuser->hasHomePage(); // revive db handle, because these don't survive sessions
321 //$GLOBALS['request']->_user = $olduser;
329 * Probably not needed, since we use the various user objects methods so far.
330 * Anyway, here it is, looping through all available objects.
332 function UserExists ($UserName) {
334 if (!($user = $request->getUser()))
335 $user = WikiUser($UserName);
338 if ($user->userExists($UserName)) {
339 $request->_user = $user;
342 if (isa($user,'_BogoUser'))
343 $user = new _PassUser($UserName,$user->_prefs);
344 $class = $user->nextClass();
345 if ($user = new $class($UserName, $user->_prefs)) {
346 return $user->userExists($UserName);
348 $request->_user = $GLOBALS['ForbiddenUser'];
352 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
355 * Base WikiUser class.
360 var $_level = WIKIAUTH_ANON;
362 var $_HomePagehandle = false;
365 function _WikiUser($UserName='', $prefs=false) {
367 $this->_userid = $UserName;
368 $this->_HomePagehandle = false;
370 $this->hasHomePage();
372 if (empty($this->_prefs)) {
373 if ($prefs) $this->_prefs = $prefs;
374 else $this->getPreferences();
378 function UserName() {
379 if (!empty($this->_userid))
380 return $this->_userid;
383 function getPreferences() {
384 trigger_error("DEBUG: Note: undefined _WikiUser class trying to load prefs." . " "
385 . "New subclasses of _WikiUser must override this function.");
389 function setPreferences($prefs, $id_only) {
390 trigger_error("DEBUG: Note: undefined _WikiUser class trying to save prefs."
392 . "New subclasses of _WikiUser must override this function.");
396 function userExists() {
397 return $this->hasHomePage();
400 function checkPass($submitted_password) {
401 // By definition, an undefined user class cannot sign in.
402 trigger_error("DEBUG: Warning: undefined _WikiUser class trying to sign in."
404 . "New subclasses of _WikiUser must override this function.");
408 // returns page_handle to user's home page or false if none
409 function hasHomePage() {
410 if ($this->_userid) {
411 if (!empty($this->_HomePagehandle) and is_object($this->_HomePagehandle)) {
412 return $this->_HomePagehandle->exists();
415 // check db again (maybe someone else created it since
418 $this->_HomePagehandle = $request->getPage($this->_userid);
419 return $this->_HomePagehandle->exists();
427 function createHomePage() {
429 $versiondata = array('author' => ADMIN_USER);
430 $request->_dbi->save(_("Automatically created user homepage to be able to store UserPreferences.").
431 "\n{{Template/UserPage}}",
433 $request->_dbi->touch();
434 $this->_HomePagehandle = $request->getPage($this->_userid);
437 // innocent helper: case-insensitive position in _auth_methods
438 function array_position ($string, $array) {
439 $string = strtolower($string);
440 for ($found = 0; $found < count($array); $found++) {
441 if (strtolower($array[$found]) == $string)
447 function nextAuthMethodIndex() {
448 if (empty($this->_auth_methods))
449 $this->_auth_methods = $GLOBALS['USER_AUTH_ORDER'];
450 if (empty($this->_current_index)) {
451 if (strtolower(get_class($this)) != '_passuser') {
452 $this->_current_method = substr(get_class($this),1,-8);
453 $this->_current_index = $this->array_position($this->_current_method,
454 $this->_auth_methods);
456 $this->_current_index = -1;
459 $this->_current_index++;
460 if ($this->_current_index >= count($this->_auth_methods))
462 $this->_current_method = $this->_auth_methods[$this->_current_index];
463 return $this->_current_index;
466 function AuthMethod($index = false) {
467 return $this->_auth_methods[ $index === false
468 ? count($this->_auth_methods)-1
472 // upgrade the user object
473 function nextClass() {
474 $method = $this->AuthMethod($this->nextAuthMethodIndex());
475 include_once("lib/WikiUser/$method.php");
476 return "_".$method."PassUser";
479 //Fixme: for _HttpAuthPassUser
480 function PrintLoginForm (&$request, $args, $fail_message = false,
481 $seperate_page = false) {
482 include_once('lib/Template.php');
483 // Call update_locale in case the system's default language is not 'en'.
484 // (We have no user pref for lang at this point yet, no one is logged in.)
485 if ($GLOBALS['LANG'] != DEFAULT_LANGUAGE)
486 update_locale(DEFAULT_LANGUAGE);
487 $userid = $this->_userid;
489 extract($args); // fixme
491 $require_level = max(0, min(WIKIAUTH_ADMIN, (int)$require_level));
493 $pagename = $request->getArg('pagename');
495 $login = Template('login',
496 compact('pagename', 'userid', 'require_level',
497 'fail_message', 'pass_required', 'nocache'));
498 // check if the html template was already processed
499 $seperate_page = $seperate_page ? true : !alreadyTemplateProcessed('html');
500 if ($seperate_page) {
501 $page = $request->getPage($pagename);
502 $revision = $page->getCurrentRevision();
503 return GeneratePage($login,_("Sign In"), $revision);
505 return $login->printExpansion();
509 /** Signed in but not password checked or empty password.
511 function isSignedIn() {
512 return (isa($this,'_BogoUser') or isa($this,'_PassUser'));
515 /** This is password checked for sure.
517 function isAuthenticated() {
518 //return isa($this,'_PassUser');
519 //return isa($this,'_BogoUser') || isa($this,'_PassUser');
520 return $this->_level >= WIKIAUTH_BOGO;
523 function isAdmin () {
525 if ($this->_level == WIKIAUTH_ADMIN) return true;
526 if (!$this->isSignedIn()) return false;
527 if (!$this->isAuthenticated()) return false;
529 if (!$group) $group = &$GLOBALS['request']->getGroup();
530 return ($this->_level > WIKIAUTH_BOGO and $group->isMember(GROUP_ADMIN));
533 /** Name or IP for a signed user. UserName could come from a cookie e.g.
536 return ( $this->UserName()
538 : $GLOBALS['request']->get('REMOTE_ADDR') );
541 /** Name for an authenticated user. No IP here.
543 function getAuthenticatedId() {
544 return ( $this->isAuthenticated()
546 : ''); //$GLOBALS['request']->get('REMOTE_ADDR') );
549 function hasAuthority ($require_level) {
550 return $this->_level >= $require_level;
553 /* This is quite restrictive and not according the login description online.
554 Any word char (A-Za-z0-9_), " ", ".", "@" and "-"
555 The backends may loosen or tighten this.
557 function isValidName ($userid = false) {
558 if (!$userid) $userid = $this->_userid;
559 if (!$userid) return false;
560 if (defined('GFORGE') and GFORGE) {
563 return preg_match("/^[\-\w\.@ ]+$/U", $userid) and strlen($userid) < 32;
567 * Called on an auth_args POST request, such as login, logout or signin.
568 * TODO: Check BogoLogin users with empty password. (self-signed users)
570 function AuthCheck ($postargs) {
571 // Normalize args, and extract.
572 $keys = array('userid', 'passwd', 'require_level', 'login', 'logout',
574 foreach ($keys as $key)
575 $args[$key] = isset($postargs[$key]) ? $postargs[$key] : false;
577 $require_level = max(0, min(WIKIAUTH_ADMIN, (int)$require_level));
579 if ($logout) { // Log out
580 if (LOGIN_LOG and is_writeable(LOGIN_LOG)) {
582 $zone_offset = Request_AccessLogEntry::_zone_offset();
583 $ncsa_time = date("d/M/Y:H:i:s", time());
584 $entry = sprintf('%s - %s - [%s %s] "%s" %s - "%s" "%s"',
585 (string) $request->get('REMOTE_HOST'),
586 (string) $request->_user->_userid,
587 $ncsa_time, $zone_offset,
588 "logout ".get_class($request->_user),
590 (string) $request->get('HTTP_REFERER'),
591 (string) $request->get('HTTP_USER_AGENT')
593 if (($fp = fopen(LOGIN_LOG, "a"))) {
595 fputs($fp, "$entry\n");
598 //error_log("$entry\n", 3, LOGIN_LOG);
600 if (method_exists($GLOBALS['request']->_user, "logout")) { //_HttpAuthPassUser
601 $GLOBALS['request']->_user->logout();
603 $user = new _AnonUser();
605 $user->_level = WIKIAUTH_ANON;
608 return false; // User hit cancel button.
609 elseif (!$login && !$userid)
610 return false; // Nothing to do?
612 if (!$this->isValidName($userid))
613 return _("Invalid username.");;
615 $authlevel = $this->checkPass($passwd === false ? '' : $passwd);
617 if (LOGIN_LOG and is_writeable(LOGIN_LOG)) {
619 $zone_offset = Request_AccessLogEntry::_zone_offset();
620 $ncsa_time = date("d/M/Y:H:i:s", time());
621 $manglepasswd = $passwd;
622 for ($i=0; $i<strlen($manglepasswd); $i++) {
623 $c = substr($manglepasswd,$i,1);
624 if (ord($c) < 32) $manglepasswd[$i] = "<";
625 elseif ($c == '*') $manglepasswd[$i] = "*";
626 elseif ($c == '?') $manglepasswd[$i] = "?";
627 elseif ($c == '(') $manglepasswd[$i] = "(";
628 elseif ($c == ')') $manglepasswd[$i] = ")";
629 elseif ($c == "\\") $manglepasswd[$i] = "\\";
630 elseif (ord($c) < 127) $manglepasswd[$i] = "x";
631 elseif (ord($c) >= 127) $manglepasswd[$i] = ">";
633 $entry = sprintf('%s - %s - [%s %s] "%s" %s - "%s" "%s"',
634 $request->get('REMOTE_HOST'),
635 (string) $request->_user->_userid,
636 $ncsa_time, $zone_offset,
637 "login $userid/$manglepasswd => $authlevel ".get_class($request->_user),
638 $authlevel > 0 ? "200" : "403",
639 (string) $request->get('HTTP_REFERER'),
640 (string) $request->get('HTTP_USER_AGENT')
642 if (($fp = fopen(LOGIN_LOG, "a"))) {
644 fputs($fp, "$entry\n");
647 //error_log("$entry\n", 3, LOGIN_LOG);
650 if ($authlevel <= 0) { // anon or forbidden
652 return _("Invalid password.");
654 return _("Invalid password or userid.");
655 } elseif ($authlevel < $require_level) { // auth ok, but not enough
656 if (!empty($this->_current_method) and strtolower(get_class($this)) == '_passuser')
659 $class = "_" . $this->_current_method . "PassUser";
660 include_once("lib/WikiUser/".$this->_current_method.".php");
661 $user = new $class($userid,$this->_prefs);
662 if (!check_php_version(5))
663 eval("\$this = \$user;");
664 // /*PHP5 patch*/$this = $user;
665 $this->_level = $authlevel;
668 $this->_userid = $userid;
669 $this->_level = $authlevel;
670 return _("Insufficient permissions.");
674 //$user = $GLOBALS['request']->_user;
675 if (!empty($this->_current_method) and
676 strtolower(get_class($this)) == '_passuser')
679 $class = "_" . $this->_current_method . "PassUser";
680 include_once("lib/WikiUser/".$this->_current_method.".php");
681 $user = new $class($userid, $this->_prefs);
682 if (!check_php_version(5))
683 eval("\$this = \$user;");
684 // /*PHP5 patch*/$this = $user;
685 $user->_level = $authlevel;
688 $this->_userid = $userid;
689 $this->_level = $authlevel;
696 * Not authenticated in user, but he may be signed in. Basicly with view access only.
697 * prefs are stored in cookies, but only the userid.
702 var $_level = WIKIAUTH_ANON; // var in php-5.0.0RC1 deprecated
704 /** Anon only gets to load and save prefs in a cookie, that's it.
706 function getPreferences() {
709 if (empty($this->_prefs))
710 $this->_prefs = new UserPreferences;
711 $UserName = $this->UserName();
713 // Try to read deprecated 1.3.x style cookies
714 if ($cookie = $request->cookies->get_old(WIKI_NAME)) {
715 if (! $unboxedcookie = $this->_prefs->retrieve($cookie)) {
716 trigger_error(_("Empty Preferences or format of UserPreferences cookie not recognised.")
718 . sprintf("%s='%s'", WIKI_NAME, $cookie)
720 . _("Default preferences will be used."),
724 * Only set if it matches the UserName who is
725 * signing in or if this really is an Anon login (no
726 * username). (Remember, _BogoUser and higher inherit this
729 if (! $UserName || $UserName == @$unboxedcookie['userid']) {
730 $updated = $this->_prefs->updatePrefs($unboxedcookie);
731 //$this->_prefs = new UserPreferences($unboxedcookie);
732 $UserName = @$unboxedcookie['userid'];
733 if (is_string($UserName) and (substr($UserName,0,2) != 's:'))
734 $this->_userid = $UserName;
738 // v1.3.8 policy: don't set PhpWiki cookies, only plaintext WIKI_ID cookies
740 $request->deleteCookieVar(WIKI_NAME);
742 // Try to read deprecated 1.3.4 style cookies
743 if (! $UserName and ($cookie = $request->cookies->get_old("WIKI_PREF2"))) {
744 if (! $unboxedcookie = $this->_prefs->retrieve($cookie)) {
745 if (! $UserName || $UserName == $unboxedcookie['userid']) {
746 $updated = $this->_prefs->updatePrefs($unboxedcookie);
747 //$this->_prefs = new UserPreferences($unboxedcookie);
748 $UserName = $unboxedcookie['userid'];
749 if (is_string($UserName) and (substr($UserName,0,2) != 's:'))
750 $this->_userid = $UserName;
755 $request->deleteCookieVar("WIKI_PREF2");
759 // Try reading userid from old PhpWiki cookie formats:
760 if ($cookie = $request->cookies->get_old(getCookieName())) {
761 if (is_string($cookie) and (substr($cookie,0,2) != 's:'))
763 elseif (is_array($cookie) and !empty($cookie['userid']))
764 $UserName = $cookie['userid'];
766 if (! $UserName and !headers_sent())
767 $request->deleteCookieVar(getCookieName());
769 $this->_userid = $UserName;
772 // initializeTheme() needs at least an empty object
774 if (empty($this->_prefs))
775 $this->_prefs = new UserPreferences;
777 return $this->_prefs;
780 /** _AnonUser::setPreferences(): Save prefs in a cookie and session and update all global vars
782 * Allow for multiple wikis in same domain. Encode only the
783 * _prefs array of the UserPreference object. Ideally the
784 * prefs array should just be imploded into a single string or
785 * something so it is completely human readable by the end
786 * user. In that case stricter error checking will be needed
787 * when loading the cookie.
789 function setPreferences($prefs, $id_only=false) {
790 if (!is_object($prefs)) {
791 if (is_object($this->_prefs)) {
792 $updated = $this->_prefs->updatePrefs($prefs);
793 $prefs =& $this->_prefs;
795 // update the prefs values from scratch. This could leed to unnecessary
796 // side-effects: duplicate emailVerified, ...
797 $this->_prefs = new UserPreferences($prefs);
801 if (!isset($this->_prefs))
802 $this->_prefs =& $prefs;
804 $updated = $this->_prefs->isChanged($prefs);
807 if ($id_only and !headers_sent()) {
809 // new 1.3.8 policy: no array cookies, only plain userid string as in
810 // the pre 1.3.x versions.
811 // prefs should be stored besides the session in the homepagehandle or in a db.
812 $request->setCookieVar(getCookieName(), $this->_userid,
813 COOKIE_EXPIRATION_DAYS, COOKIE_DOMAIN);
814 //$request->setCookieVar(WIKI_NAME, array('userid' => $prefs->get('userid')),
815 // COOKIE_EXPIRATION_DAYS, COOKIE_DOMAIN);
818 if (is_object($prefs)) {
819 $packed = $prefs->store();
820 $unpacked = $prefs->unpack($packed);
821 if (count($unpacked)) {
822 foreach (array('_method','_select','_update','_insert') as $param) {
823 if (!empty($this->_prefs->{$param}))
824 $prefs->{$param} = $this->_prefs->{$param};
826 $this->_prefs = $prefs;
832 function userExists() {
836 function checkPass($submitted_password) {
838 // this might happen on a old-style signin button.
840 // By definition, the _AnonUser does not HAVE a password
841 // (compared to _BogoUser, who has an EMPTY password).
842 trigger_error("DEBUG: Warning: _AnonUser unexpectedly asked to checkPass()." . " "
843 . "Check isa(\$user, '_PassUser'), or: isa(\$user, '_AdminUser') etc. first." . " "
844 . "New subclasses of _WikiUser must override this function.");
851 * Helper class to finish the PassUser auth loop.
852 * This is added automatically to USER_AUTH_ORDER.
857 var $_level = WIKIAUTH_FORBIDDEN;
859 function checkPass($submitted_password) {
860 return WIKIAUTH_FORBIDDEN;
863 function userExists() {
864 if ($this->_HomePagehandle) return true;
870 * Do NOT extend _BogoUser to other classes, for checkPass()
871 * security. (In case of defects in code logic of the new class!)
872 * The intermediate step between anon and passuser.
873 * We also have the _BogoLoginPassUser class with stricter
874 * password checking, which fits into the auth loop.
875 * Note: This class is not called anymore by WikiUser()
880 function userExists() {
881 if (isWikiWord($this->_userid)) {
882 $this->_level = WIKIAUTH_BOGO;
885 $this->_level = WIKIAUTH_ANON;
890 function checkPass($submitted_password) {
891 // By definition, BogoUser has an empty password.
893 return $this->_level;
900 * Called if ALLOW_USER_PASSWORDS and Anon and Bogo failed.
902 * The classes for all subsequent auth methods extend from this class.
903 * This handles the auth method type dispatcher according $USER_AUTH_ORDER,
904 * the three auth method policies first-only, strict and stacked
905 * and the two methods for prefs: homepage or database,
906 * if $DBAuthParams['pref_select'] is defined.
908 * Default is PersonalPage auth and prefs.
910 * @author: Reini Urban
914 var $_auth_dbi, $_prefs;
915 var $_current_method, $_current_index;
917 // check and prepare the auth and pref methods only once
918 function _PassUser($UserName='', $prefs=false) {
919 //global $DBAuthParams, $DBParams;
921 /*if (!$this->isValidName($UserName))
923 $this->_userid = $UserName;
924 if ($this->hasHomePage())
925 $this->_HomePagehandle = $GLOBALS['request']->getPage($this->_userid);
927 $this->_authmethod = substr(get_class($this),1,-8);
928 if ($this->_authmethod == 'a') $this->_authmethod = 'admin';
930 // Check the configured Prefs methods
931 $dbi = $this->getAuthDbh();
932 $dbh = $GLOBALS['request']->getDbh();
935 and !isset($this->_prefs->_select)
936 and $dbh->getAuthParam('pref_select'))
938 if (!$this->_prefs) {
939 $this->_prefs = new UserPreferences();
942 $this->_prefs->_method = $dbh->getParam('dbtype');
943 $this->_prefs->_select = $this->prepare($dbh->getAuthParam('pref_select'), "userid");
945 if ( !isset($this->_prefs->_update) and $dbh->getAuthParam('pref_update')) {
946 $this->_prefs->_update = $this->prepare($dbh->getAuthParam('pref_update'),
947 array("userid", "pref_blob"));
950 if (!$this->_prefs) {
951 $this->_prefs = new UserPreferences();
954 $this->_prefs->_method = 'HomePage';
957 if (! $this->_prefs or isset($need_pref) ) {
958 if ($prefs) $this->_prefs = $prefs;
959 else $this->getPreferences();
962 // Upgrade to the next parent _PassUser class. Avoid recursion.
963 if ( strtolower(get_class($this)) === '_passuser' ) {
964 //auth policy: Check the order of the configured auth methods
965 // 1. first-only: Upgrade the class here in the constructor
966 // 2. old: ignore USER_AUTH_ORDER and try to use all available methods as
967 /// in the previous PhpWiki releases (slow)
968 // 3. strict: upgrade the class after checking the user existance in userExists()
969 // 4. stacked: upgrade the class after the password verification in checkPass()
970 // Methods: PersonalPage, HttpAuth, DB, Ldap, Imap, File
971 //if (!defined('USER_AUTH_POLICY')) define('USER_AUTH_POLICY','old');
972 if (defined('USER_AUTH_POLICY')) {
973 // policy 1: only pre-define one method for all users
974 if (USER_AUTH_POLICY === 'first-only') {
975 $class = $this->nextClass();
976 return new $class($UserName,$this->_prefs);
978 // Use the default behaviour from the previous versions:
979 elseif (USER_AUTH_POLICY === 'old') {
980 // Default: try to be smart
981 // On php5 we can directly return and upgrade the Object,
982 // before we have to upgrade it manually.
983 if (!empty($GLOBALS['PHP_AUTH_USER']) or !empty($_SERVER['REMOTE_USER'])) {
984 include_once("lib/WikiUser/HttpAuth.php");
985 if (check_php_version(5))
986 return new _HttpAuthPassUser($UserName,$this->_prefs);
988 $user = new _HttpAuthPassUser($UserName,$this->_prefs);
989 eval("\$this = \$user;");
990 // /*PHP5 patch*/$this = $user;
993 } elseif (in_array('Db', $dbh->getAuthParam('USER_AUTH_ORDER')) and
994 $dbh->getAuthParam('auth_check') and
995 ($dbh->getAuthParam('auth_dsn') or $dbh->getParam('dsn'))) {
996 if (check_php_version(5))
997 return new _DbPassUser($UserName,$this->_prefs);
999 $user = new _DbPassUser($UserName,$this->_prefs);
1000 eval("\$this = \$user;");
1001 // /*PHP5 patch*/$this = $user;
1004 } elseif (in_array('LDAP', $dbh->getAuthParam('USER_AUTH_ORDER')) and
1005 defined('LDAP_AUTH_HOST') and defined('LDAP_BASE_DN') and
1006 function_exists('ldap_connect')) {
1007 include_once("lib/WikiUser/LDAP.php");
1008 if (check_php_version(5))
1009 return new _LDAPPassUser($UserName,$this->_prefs);
1011 $user = new _LDAPPassUser($UserName,$this->_prefs);
1012 eval("\$this = \$user;");
1013 // /*PHP5 patch*/$this = $user;
1016 } elseif (in_array('IMAP', $dbh->getAuthParam('USER_AUTH_ORDER')) and
1017 defined('IMAP_AUTH_HOST') and function_exists('imap_open')) {
1018 include_once("lib/WikiUser/IMAP.php");
1019 if (check_php_version(5))
1020 return new _IMAPPassUser($UserName,$this->_prefs);
1022 $user = new _IMAPPassUser($UserName,$this->_prefs);
1023 eval("\$this = \$user;");
1024 // /*PHP5 patch*/$this = $user;
1027 } elseif (in_array('File', $dbh->getAuthParam('USER_AUTH_ORDER')) and
1028 defined('AUTH_USER_FILE') and file_exists(AUTH_USER_FILE)) {
1029 include_once("lib/WikiUser/File.php");
1030 if (check_php_version(5))
1031 return new _FilePassUser($UserName, $this->_prefs);
1033 $user = new _FilePassUser($UserName, $this->_prefs);
1034 eval("\$this = \$user;");
1035 // /*PHP5 patch*/$this = $user;
1039 include_once("lib/WikiUser/PersonalPage.php");
1040 if (check_php_version(5))
1041 return new _PersonalPagePassUser($UserName,$this->_prefs);
1043 $user = new _PersonalPagePassUser($UserName,$this->_prefs);
1044 eval("\$this = \$user;");
1045 // /*PHP5 patch*/$this = $user;
1051 // else use the page methods defined in _PassUser.
1057 function getAuthDbh () {
1058 global $request; //, $DBParams, $DBAuthParams;
1060 $dbh = $request->getDbh();
1061 // session restauration doesn't re-connect to the database automatically,
1062 // so dirty it here, to force a reconnect.
1063 if (isset($this->_auth_dbi)) {
1064 if (($dbh->getParam('dbtype') == 'SQL') and empty($this->_auth_dbi->connection))
1065 unset($this->_auth_dbi);
1066 if (($dbh->getParam('dbtype') == 'ADODB') and empty($this->_auth_dbi->_connectionID))
1067 unset($this->_auth_dbi);
1069 if (empty($this->_auth_dbi)) {
1070 if ($dbh->getParam('dbtype') != 'SQL'
1071 and $dbh->getParam('dbtype') != 'ADODB'
1072 and $dbh->getParam('dbtype') != 'PDO')
1074 if (empty($GLOBALS['DBAuthParams']))
1076 if (!$dbh->getAuthParam('auth_dsn')) {
1077 $dbh = $request->getDbh(); // use phpwiki database
1078 } elseif ($dbh->getAuthParam('auth_dsn') == $dbh->getParam('dsn')) {
1079 $dbh = $request->getDbh(); // same phpwiki database
1080 } else { // use another external database handle. needs PHP >= 4.1
1081 $local_params = array_merge($GLOBALS['DBParams'],$GLOBALS['DBAuthParams']);
1082 $local_params['dsn'] = $local_params['auth_dsn'];
1083 $dbh = WikiDB::open($local_params);
1085 $this->_auth_dbi =& $dbh->_backend->_dbh;
1087 return $this->_auth_dbi;
1090 function _normalize_stmt_var($var, $oldstyle = false) {
1091 static $valid_variables = array('userid','password','pref_blob','groupname');
1092 // old-style: "'$userid'"
1093 // new-style: '"\$userid"' or just "userid"
1094 $new = str_replace(array("'",'"','\$','$'),'',$var);
1095 if (!in_array($new, $valid_variables)) {
1096 trigger_error("Unknown DBAuthParam statement variable: ". $new, E_USER_ERROR);
1099 return !$oldstyle ? "'$".$new."'" : '\$'.$new;
1102 // TODO: use it again for the auth and member tables
1103 // sprintfstyle vs prepare style: %s or ?
1104 // multiple vars should be executed via prepare(?,?)+execute,
1105 // single vars with execute(sprintf(quote(var)))
1106 // help with position independency
1107 function prepare ($stmt, $variables, $oldstyle = false, $sprintfstyle = true) {
1109 $dbi = $request->getDbh();
1110 $this->getAuthDbh();
1111 // "'\$userid"' => %s
1112 // variables can be old-style: '"\$userid"' or new-style: "'$userid'" or just "userid"
1113 // old-style strings don't survive pear/Config/IniConfig treatment, that's why we changed it.
1115 if (is_array($variables)) {
1116 //$sprintfstyle = false;
1117 for ($i=0; $i < count($variables); $i++) {
1118 $var = $this->_normalize_stmt_var($variables[$i], $oldstyle);
1120 trigger_error(sprintf("DbAuthParams: Undefined or empty statement variable %s in %s",
1121 $variables[$i], $stmt), E_USER_WARNING);
1122 $variables[$i] = $var;
1123 if (!$var) $new[] = '';
1125 $s = "%" . ($i+1) . "s";
1126 $new[] = $sprintfstyle ? $s : "?";
1130 $var = $this->_normalize_stmt_var($variables, $oldstyle);
1132 trigger_error(sprintf("DbAuthParams: Undefined or empty statement variable %s in %s",
1133 $variables, $stmt), E_USER_WARNING);
1135 if (!$var) $new = '';
1136 else $new = $sprintfstyle ? '%s' : "?";
1138 $prefix = $dbi->getParam('prefix');
1139 // probably prefix table names if in same database
1140 if ($prefix and isset($this->_auth_dbi) and isset($dbi->_backend->_dbh) and
1141 ($dbi->getAuthParam('auth_dsn') and $dbi->getParam('dsn') == $dbi->getAuthParam('auth_dsn')))
1143 if (!stristr($stmt, $prefix)) {
1145 $stmt = str_replace(array(" user "," pref "," member "),
1146 array(" ".$prefix."user ",
1147 " ".$prefix."pref ",
1148 " ".$prefix."member "), $stmt);
1149 //Do it automatically for the lazy admin? Esp. on sf.net it's nice to have
1150 trigger_error("Need to prefix the DBAUTH tablename in config/config.ini:\n $oldstmt \n=> $stmt",
1154 // Preparate the SELECT statement, for ADODB and PearDB (MDB not).
1155 // Simple sprintf-style.
1156 $new_stmt = str_replace($variables, $new, $stmt);
1157 if ($new_stmt == $stmt) {
1159 trigger_error(sprintf("DbAuthParams: Invalid statement in %s",
1160 $stmt), E_USER_WARNING);
1162 trigger_error(sprintf("DbAuthParams: Old statement quoting style in %s",
1163 $stmt), E_USER_WARNING);
1164 $new_stmt = $this->prepare($stmt, $variables, 'oldstyle');
1170 function getPreferences() {
1171 if (!empty($this->_prefs->_method)) {
1172 if ($this->_prefs->_method == 'ADODB') {
1173 // FIXME: strange why this should be needed...
1174 include_once("lib/WikiUser/Db.php");
1175 include_once("lib/WikiUser/AdoDb.php");
1176 if (check_php_version(5)) {
1177 $user = new _AdoDbPassUser($this->_userid, $this->_prefs);
1178 return $user->getPreferences();
1180 _AdoDbPassUser::_AdoDbPassUser($this->_userid, $this->_prefs);
1181 return _AdoDbPassUser::getPreferences();
1183 } elseif ($this->_prefs->_method == 'SQL') {
1184 include_once("lib/WikiUser/Db.php");
1185 include_once("lib/WikiUser/PearDb.php");
1186 if (check_php_version(5)) {
1187 $user = new _PearDbPassUser($this->_userid, $this->_prefs);
1188 return $user->getPreferences();
1190 _PearDbPassUser::_PearDbPassUser($this->_userid, $this->_prefs);
1191 return _PearDbPassUser::getPreferences();
1193 } elseif ($this->_prefs->_method == 'PDO') {
1194 include_once("lib/WikiUser/Db.php");
1195 include_once("lib/WikiUser/PdoDb.php");
1196 if (check_php_version(5)) {
1197 $user = new _PdoDbPassUser($this->_userid, $this->_prefs);
1198 return $user->getPreferences();
1200 _PdoDbPassUser::_PdoDbPassUser($this->_userid, $this->_prefs);
1201 return _PdoDbPassUser::getPreferences();
1206 // We don't necessarily have to read the cookie first. Since
1207 // the user has a password, the prefs stored in the homepage
1208 // cannot be arbitrarily altered by other Bogo users.
1209 _AnonUser::getPreferences();
1210 // User may have deleted cookie, retrieve from his
1211 // PersonalPage if there is one.
1212 if (!empty($this->_HomePagehandle)) {
1213 if ($restored_from_page = $this->_prefs->retrieve
1214 ($this->_HomePagehandle->get('pref'))) {
1215 $updated = $this->_prefs->updatePrefs($restored_from_page,'init');
1216 //$this->_prefs = new UserPreferences($restored_from_page);
1217 return $this->_prefs;
1220 return $this->_prefs;
1223 function setPreferences($prefs, $id_only=false) {
1224 if (!empty($this->_prefs->_method)) {
1225 if ($this->_prefs->_method == 'ADODB') {
1226 // FIXME: strange why this should be needed...
1227 include_once("lib/WikiUser/Db.php");
1228 include_once("lib/WikiUser/AdoDb.php");
1229 if (check_php_version(5)) {
1230 $user = new _AdoDbPassUser($this->_userid, $prefs);
1231 return $user->setPreferences($prefs, $id_only);
1233 _AdoDbPassUser::_AdoDbPassUser($this->_userid, $prefs);
1234 return _AdoDbPassUser::setPreferences($prefs, $id_only);
1237 elseif ($this->_prefs->_method == 'SQL') {
1238 include_once("lib/WikiUser/Db.php");
1239 include_once("lib/WikiUser/PearDb.php");
1240 if (check_php_version(5)) {
1241 $user = new _PearDbPassUser($this->_userid, $prefs);
1242 return $user->setPreferences($prefs, $id_only);
1244 _PearDbPassUser::_PearDbPassUser($this->_userid, $prefs);
1245 return _PearDbPassUser::setPreferences($prefs, $id_only);
1248 elseif ($this->_prefs->_method == 'PDO') {
1249 include_once("lib/WikiUser/Db.php");
1250 include_once("lib/WikiUser/PdoDb.php");
1251 if (check_php_version(5)) {
1252 $user = new _PdoDbPassUser($this->_userid, $prefs);
1253 return $user->setPreferences($prefs, $id_only);
1255 _PdoDbPassUser::_PdoDbPassUser($this->_userid, $prefs);
1256 return _PdoDbPassUser::setPreferences($prefs, $id_only);
1260 if ($updated = _AnonUser::setPreferences($prefs, $id_only)) {
1261 // Encode only the _prefs array of the UserPreference object
1262 // If no DB method exists to store the prefs we must store it in the page, not in the cookies.
1263 if (empty($this->_HomePagehandle)) {
1264 $this->_HomePagehandle = $GLOBALS['request']->getPage($this->_userid);
1266 if (! $this->_HomePagehandle->exists() ) {
1267 $this->createHomePage();
1269 if (!empty($this->_HomePagehandle) and !$id_only) {
1270 $this->_HomePagehandle->set('pref', $this->_prefs->store());
1276 function mayChangePass() {
1280 //The default method is getting the password from prefs.
1281 // child methods obtain $stored_password from external auth.
1282 function userExists() {
1283 //if ($this->_HomePagehandle) return true;
1284 if (strtolower(get_class($this)) == "_passuser") {
1285 $class = $this->nextClass();
1286 $user = new $class($this->_userid, $this->_prefs);
1291 if (!check_php_version(5))
1292 eval("\$this = \$user;");
1293 $user = UpgradeUser($this, $user);
1294 if ($user->userExists()) {
1295 $user = UpgradeUser($this, $user);
1298 // prevent endless loop. does this work on all PHP's?
1299 // it just has to set the classname, what it correctly does.
1300 $class = $user->nextClass();
1301 if ($class == "_ForbiddenPassUser")
1307 //The default method is getting the password from prefs.
1308 // child methods obtain $stored_password from external auth.
1309 function checkPass($submitted_password) {
1310 $stored_password = $this->_prefs->get('passwd');
1311 if ($this->_checkPass($submitted_password, $stored_password)) {
1312 $this->_level = WIKIAUTH_USER;
1313 return $this->_level;
1315 if ((USER_AUTH_POLICY === 'strict') and $this->userExists()) {
1316 $this->_level = WIKIAUTH_FORBIDDEN;
1317 return $this->_level;
1319 return $this->_tryNextPass($submitted_password);
1324 function _checkPassLength($submitted_password) {
1325 if (strlen($submitted_password) < PASSWORD_LENGTH_MINIMUM) {
1326 trigger_error(_("The length of the password is shorter than the system policy allows."));
1333 * The basic password checker for all PassUser objects.
1334 * Uses global ENCRYPTED_PASSWD and PASSWORD_LENGTH_MINIMUM.
1335 * Empty passwords are always false!
1336 * PASSWORD_LENGTH_MINIMUM is enforced here and in the preference set method.
1337 * @see UserPreferences::set
1339 * DBPassUser password's have their own crypt definition.
1340 * That's why DBPassUser::checkPass() doesn't call this method, if
1341 * the db password method is 'plain', which means that the DB SQL
1342 * statement just returns 1 or 0. To use CRYPT() or PASSWORD() and
1343 * don't store plain passwords in the DB.
1345 * TODO: remove crypt() function check from config.php:396 ??
1347 function _checkPass($submitted_password, $stored_password) {
1348 if (!empty($submitted_password)) {
1349 // This works only on plaintext passwords.
1350 if (!ENCRYPTED_PASSWD and (strlen($stored_password) < PASSWORD_LENGTH_MINIMUM)) {
1351 // With the EditMetaData plugin
1352 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."));
1355 if (!$this->_checkPassLength($submitted_password)) {
1358 if (ENCRYPTED_PASSWD) {
1359 // Verify against encrypted password.
1360 if (function_exists('crypt')) {
1361 if (crypt($submitted_password, $stored_password) == $stored_password )
1362 return true; // matches encrypted password
1367 trigger_error(_("The crypt function is not available in this version of PHP.") . " "
1368 . _("Please set ENCRYPTED_PASSWD to false in config/config.ini and probably change ADMIN_PASSWD."),
1374 // Verify against cleartext password.
1375 if ($submitted_password == $stored_password)
1378 // Check whether we forgot to enable ENCRYPTED_PASSWD
1379 if (function_exists('crypt')) {
1380 if (crypt($submitted_password, $stored_password) == $stored_password) {
1381 trigger_error(_("Please set ENCRYPTED_PASSWD to true in config/config.ini."),
1392 /** The default method is storing the password in prefs.
1393 * Child methods (DB, File) may store in external auth also, but this
1394 * must be explicitly enabled.
1395 * This may be called by plugin/UserPreferences or by ->SetPreferences()
1397 function changePass($submitted_password) {
1398 $stored_password = $this->_prefs->get('passwd');
1399 // check if authenticated
1400 if (!$this->isAuthenticated()) return false;
1401 if (ENCRYPTED_PASSWD) {
1402 $submitted_password = crypt($submitted_password);
1404 // check other restrictions, with side-effects only.
1405 $result = $this->_checkPass($submitted_password, $stored_password);
1406 if ($stored_password != $submitted_password) {
1407 $this->_prefs->set('passwd', $submitted_password);
1408 //update the storage (session, homepage, ...)
1409 $this->SetPreferences($this->_prefs);
1412 //Todo: return an error msg to the caller what failed?
1413 // same password or no privilege
1414 return ENCRYPTED_PASSWD ? true : false;
1417 function _tryNextPass($submitted_password) {
1418 if (DEBUG & _DEBUG_LOGIN) {
1419 $class = strtolower(get_class($this));
1420 if (substr($class,-10) == "dbpassuser") $class = "_dbpassuser";
1421 $GLOBALS['USER_AUTH_ERROR'][$class] = 'wrongpass';
1423 if (USER_AUTH_POLICY === 'strict') {
1424 $class = $this->nextClass();
1425 if ($user = new $class($this->_userid,$this->_prefs)) {
1426 if ($user->userExists()) {
1427 return $user->checkPass($submitted_password);
1431 if (USER_AUTH_POLICY === 'stacked' or USER_AUTH_POLICY === 'old') {
1432 $class = $this->nextClass();
1433 if ($user = new $class($this->_userid,$this->_prefs))
1434 return $user->checkPass($submitted_password);
1436 return $this->_level;
1439 function _tryNextUser() {
1440 if (DEBUG & _DEBUG_LOGIN) {
1441 $class = strtolower(get_class($this));
1442 if (substr($class,-10) == "dbpassuser") $class = "_dbpassuser";
1443 $GLOBALS['USER_AUTH_ERROR'][$class] = 'nosuchuser';
1445 if (USER_AUTH_POLICY === 'strict'
1446 or USER_AUTH_POLICY === 'stacked') {
1447 $class = $this->nextClass();
1448 while ($user = new $class($this->_userid, $this->_prefs)) {
1449 if (!check_php_version(5))
1450 eval("\$this = \$user;");
1451 $user = UpgradeUser($this, $user);
1452 if ($user->userExists()) {
1453 $user = UpgradeUser($this, $user);
1456 $class = $this->nextClass();
1465 * Insert more auth classes here...
1466 * For example a customized db class for another db connection
1467 * or a socket-based auth server.
1473 * For security, this class should not be extended. Instead, extend
1474 * from _PassUser (think of this as unix "root").
1476 * FIXME: This should be a singleton class. Only ADMIN_USER may be of class AdminUser!
1477 * Other members of the Administrators group must raise their level otherwise somehow.
1478 * Currently every member is a AdminUser, which will not work for the various
1484 function mayChangePass() {
1487 function checkPass($submitted_password) {
1488 if ($this->_userid == ADMIN_USER)
1489 $stored_password = ADMIN_PASSWD;
1491 // Should not happen! Only ADMIN_USER should use this class.
1492 // return $this->_tryNextPass($submitted_password); // ???
1493 // TODO: safety check if really member of the ADMIN group?
1494 $stored_password = $this->_pref->get('passwd');
1496 if ($this->_checkPass($submitted_password, $stored_password)) {
1497 $this->_level = WIKIAUTH_ADMIN;
1498 if (!empty($GLOBALS['HTTP_SERVER_VARS']['PHP_AUTH_USER']) and class_exists("_HttpAuthPassUser")) {
1500 _HttpAuthPassUser::_fake_auth($this->_userid, $submitted_password);
1502 return $this->_level;
1504 return $this->_tryNextPass($submitted_password);
1505 //$this->_level = WIKIAUTH_ANON;
1506 //return $this->_level;
1510 function storePass($submitted_password) {
1511 if ($this->_userid == ADMIN_USER)
1514 // should not happen! only ADMIN_USER should use this class.
1515 return parent::storePass($submitted_password);
1520 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
1522 * Various data classes for the preference types,
1523 * to support get, set, sanify (range checking, ...)
1524 * update() will do the neccessary side-effects if a
1525 * setting gets changed (theme, language, ...)
1528 class _UserPreference
1532 function _UserPreference ($default_value) {
1533 $this->default_value = $default_value;
1536 function sanify ($value) {
1537 return (string)$value;
1540 function get ($name) {
1541 if (isset($this->{$name}))
1542 return $this->{$name};
1544 return $this->default_value;
1547 function getraw ($name) {
1548 if (!empty($this->{$name}))
1549 return $this->{$name};
1552 // stores the value as $this->$name, and not as $this->value (clever?)
1553 function set ($name, $value) {
1555 $value = $this->sanify($value);
1556 if ($this->get($name) != $value) {
1557 $this->update($value);
1560 if ($value != $this->default_value) {
1561 $this->{$name} = $value;
1563 unset($this->{$name});
1568 // default: no side-effects
1569 function update ($value) {
1574 class _UserPreference_numeric
1575 extends _UserPreference
1577 function _UserPreference_numeric ($default, $minval = false,
1579 $this->_UserPreference((double)$default);
1580 $this->_minval = (double)$minval;
1581 $this->_maxval = (double)$maxval;
1584 function sanify ($value) {
1585 $value = (double)$value;
1586 if ($this->_minval !== false && $value < $this->_minval)
1587 $value = $this->_minval;
1588 if ($this->_maxval !== false && $value > $this->_maxval)
1589 $value = $this->_maxval;
1594 class _UserPreference_int
1595 extends _UserPreference_numeric
1597 function _UserPreference_int ($default, $minval = false, $maxval = false) {
1598 $this->_UserPreference_numeric((int)$default, (int)$minval, (int)$maxval);
1601 function sanify ($value) {
1602 return (int)parent::sanify((int)$value);
1606 class _UserPreference_bool
1607 extends _UserPreference
1609 function _UserPreference_bool ($default = false) {
1610 $this->_UserPreference((bool)$default);
1613 function sanify ($value) {
1614 if (is_array($value)) {
1615 /* This allows for constructs like:
1617 * <input type="hidden" name="pref[boolPref][]" value="0" />
1618 * <input type="checkbox" name="pref[boolPref][]" value="1" />
1620 * (If the checkbox is not checked, only the hidden input
1621 * gets sent. If the checkbox is sent, both inputs get
1624 foreach ($value as $val) {
1630 return (bool) $value;
1634 class _UserPreference_language
1635 extends _UserPreference
1637 function _UserPreference_language ($default = DEFAULT_LANGUAGE) {
1638 $this->_UserPreference($default);
1641 // FIXME: check for valid locale
1642 function sanify ($value) {
1643 // Revert to DEFAULT_LANGUAGE if user does not specify
1644 // language in UserPreferences or chooses <system language>.
1645 if ($value == '' or empty($value))
1646 $value = DEFAULT_LANGUAGE;
1648 return (string) $value;
1651 function update ($newvalue) {
1652 if (! $this->_init ) {
1653 // invalidate etag to force fresh output
1654 $GLOBALS['request']->setValidators(array('%mtime' => false));
1655 update_locale($newvalue ? $newvalue : $GLOBALS['LANG']);
1660 class _UserPreference_theme
1661 extends _UserPreference
1663 function _UserPreference_theme ($default = THEME) {
1664 $this->_UserPreference($default);
1667 function sanify ($value) {
1668 if (!empty($value) and FindFile($this->_themefile($value)))
1670 return $this->default_value;
1673 function update ($newvalue) {
1675 // invalidate etag to force fresh output
1676 if (! $this->_init )
1677 $GLOBALS['request']->setValidators(array('%mtime' => false));
1679 include_once($this->_themefile($newvalue));
1680 if (empty($WikiTheme))
1681 include_once($this->_themefile(THEME));
1684 function _themefile ($theme) {
1685 return "themes/$theme/themeinfo.php";
1689 class _UserPreference_notify
1690 extends _UserPreference
1692 function sanify ($value) {
1696 return $this->default_value;
1699 /** update to global user prefs: side-effect on set notify changes
1700 * use a global_data notify hash:
1701 * notify = array('pagematch' => array(userid => ('email' => mail,
1702 * 'verified' => 0|1),
1706 function update ($value) {
1707 if (!empty($this->_init)) return;
1708 $dbh = $GLOBALS['request']->getDbh();
1709 $notify = $dbh->get('notify');
1714 // expand to existing pages only or store matches?
1715 // for now we store (glob-style) matches which is easier for the user
1716 $pages = $this->_page_split($value);
1717 // Limitation: only current user.
1718 $user = $GLOBALS['request']->getUser();
1719 if (!$user or !method_exists($user,'UserName')) return;
1720 // This fails with php5 and a WIKI_ID cookie:
1721 $userid = $user->UserName();
1722 $email = $user->_prefs->get('email');
1723 $verified = $user->_prefs->_prefs['email']->getraw('emailVerified');
1724 // check existing notify hash and possibly delete pages for email
1725 if (!empty($data)) {
1726 foreach ($data as $page => $users) {
1727 if (isset($data[$page][$userid]) and !in_array($page, $pages)) {
1728 unset($data[$page][$userid]);
1730 if (count($data[$page]) == 0)
1731 unset($data[$page]);
1734 // add the new pages
1735 if (!empty($pages)) {
1736 foreach ($pages as $page) {
1737 if (!isset($data[$page]))
1738 $data[$page] = array();
1739 if (!isset($data[$page][$userid])) {
1740 // should we really store the verification notice here or
1741 // check it dynamically at every page->save?
1743 $data[$page][$userid] = array('email' => $email,
1744 'verified' => $verified);
1746 $data[$page][$userid] = array('email' => $email);
1751 // store users changes
1752 $dbh->set('notify',$data);
1755 /** split the user-given comma or whitespace delimited pagenames
1758 function _page_split($value) {
1759 return preg_split('/[\s,]+/',$value,-1,PREG_SPLIT_NO_EMPTY);
1763 class _UserPreference_email
1764 extends _UserPreference
1766 function sanify($value) {
1767 // check for valid email address
1768 if ($this->get('email') == $value and $this->getraw('emailVerified'))
1771 if ($value == 1 or $value === true)
1773 list($ok,$msg) = ValidateMail($value,'noconnect');
1777 trigger_error("E-Mail Validation Error: ".$msg, E_USER_WARNING);
1778 return $this->default_value;
1782 /** Side-effect on email changes:
1783 * Send a verification mail or for now just a notification email.
1784 * For true verification (value = 2), we'd need a mailserver hook.
1786 function update($value) {
1787 if (!empty($this->_init)) return;
1788 $verified = $this->getraw('emailVerified');
1790 if (($value == 1 or $value === true) and $verified)
1792 if (!empty($value) and !$verified) {
1793 list($ok,$msg) = ValidateMail($value);
1794 if ($ok and mail($value,"[".WIKI_NAME ."] "._("Email Verification"),
1795 sprintf(_("Welcome to %s!\nYour email account is verified and\nwill be used to send page change notifications.\nSee %s"),
1796 WIKI_NAME, WikiURL($GLOBALS['request']->getArg('pagename'),'',true)))) {
1797 $this->set('emailVerified',1);
1799 trigger_error($msg, E_USER_WARNING);
1805 /** Check for valid email address
1806 fixed version from http://www.zend.com/zend/spotlight/ev12apr.php
1807 Note: too strict, Bug #1053681
1809 function ValidateMail($email, $noconnect=false) {
1811 $HTTP_HOST = $GLOBALS['request']->get('HTTP_HOST');
1813 // if this check is too strict (like invalid mail addresses in a local network only)
1814 // uncomment the following line:
1815 //return array(true,"not validated");
1816 // see http://sourceforge.net/tracker/index.php?func=detail&aid=1053681&group_id=6121&atid=106121
1820 // This is Paul Warren's (pdw@ex-parrot.com) monster regex for RFC822
1821 // addresses, from the Perl module Mail::RFC822::Address, reduced to
1822 // accept single RFC822 addresses without comments only. (The original
1823 // accepts groups and properly commented addresses also.)
1824 $lwsp = "(?:(?:\\r\\n)?[ \\t])";
1826 $specials = '()<>@,;:\\\\".\\[\\]';
1827 $controls = '\\000-\\031';
1829 $dtext = "[^\\[\\]\\r\\\\]";
1830 $domain_literal = "\\[(?:$dtext|\\\\.)*\\]$lwsp*";
1832 $quoted_string = "\"(?:[^\\\"\\r\\\\]|\\\\.|$lwsp)*\"$lwsp*";
1834 $atom = "[^$specials $controls]+(?:$lwsp+|\\Z|(?=[\\[\"$specials]))";
1835 $word = "(?:$atom|$quoted_string)";
1836 $localpart = "$word(?:\\.$lwsp*$word)*";
1838 $sub_domain = "(?:$atom|$domain_literal)";
1839 $domain = "$sub_domain(?:\\.$lwsp*$sub_domain)*";
1841 $addr_spec = "$localpart\@$lwsp*$domain";
1844 $route = "(?:\@$domain(?:,\@$lwsp*$domain)*:$lwsp*)";
1845 $route_addr = "\\<$lwsp*$route?$addr_spec\\>$lwsp*";
1846 $mailbox = "(?:$addr_spec|$phrase$route_addr)";
1848 $rfc822re = "/$lwsp*$mailbox/";
1849 unset($domain, $route_addr, $route, $phrase, $addr_spec, $sub_domain, $localpart,
1850 $atom, $word, $quoted_string);
1851 unset($dtext, $controls, $specials, $lwsp, $domain_literal);
1853 if (!preg_match($rfc822re, $email)) {
1855 $result[1] = sprintf(_("E-Mail address '%s' is not properly formatted"), $email);
1859 return array(true, sprintf(_("E-Mail address '%s' is properly formatted"), $email));
1861 list ( $Username, $Domain ) = split ("@", $email);
1862 //Todo: getmxrr workaround on windows or manual input field to verify it manually
1863 if (!isWindows() and getmxrr($Domain, $MXHost)) { // avoid warning on Windows.
1864 $ConnectAddress = $MXHost[0];
1866 $ConnectAddress = $Domain;
1867 if (isset($EMailHosts[ $Domain ])) {
1868 $ConnectAddress = $EMailHosts[ $Domain ];
1871 $Connect = @fsockopen ( $ConnectAddress, 25 );
1873 if (ereg("^220", $Out = fgets($Connect, 1024))) {
1874 fputs ($Connect, "HELO $HTTP_HOST\r\n");
1875 $Out = fgets ( $Connect, 1024 );
1876 fputs ($Connect, "MAIL FROM: <".$email.">\r\n");
1877 $From = fgets ( $Connect, 1024 );
1878 fputs ($Connect, "RCPT TO: <".$email.">\r\n");
1879 $To = fgets ($Connect, 1024);
1880 fputs ($Connect, "QUIT\r\n");
1882 if (!ereg ("^250", $From)) {
1884 $result[1]="Server rejected address: ". $From;
1887 if (!ereg ( "^250", $To )) {
1889 $result[1]="Server rejected address: ". $To;
1894 $result[1] = "No response from server";
1899 $result[1]="Can not connect E-Mail server.";
1903 $result[1]="E-Mail address '$email' appears to be valid.";
1905 } // end of function
1907 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
1912 * This object holds the $request->_prefs subobjects.
1913 * A simple packed array of non-default values get's stored as cookie,
1914 * homepage, or database, which are converted to the array of
1916 * We don't store the objects, because otherwise we will
1917 * not be able to upgrade any subobject. And it's a waste of space also.
1920 class UserPreferences
1922 function UserPreferences($saved_prefs = false) {
1923 // userid stored too, to ensure the prefs are being loaded for
1924 // the correct (currently signing in) userid if stored in a
1926 // Update: for db prefs we disallow passwd.
1927 // userid is needed for pref reflexion. current pref must know its username,
1928 // if some app needs prefs from different users, different from current user.
1931 'userid' => new _UserPreference(''),
1932 'passwd' => new _UserPreference(''),
1933 'autologin' => new _UserPreference_bool(),
1934 //'emailVerified' => new _UserPreference_emailVerified(),
1935 //fixed: store emailVerified as email parameter, 1.3.8
1936 'email' => new _UserPreference_email(''),
1937 'notifyPages' => new _UserPreference_notify(''), // 1.3.8
1938 'theme' => new _UserPreference_theme(THEME),
1939 'lang' => new _UserPreference_language(DEFAULT_LANGUAGE),
1940 'editWidth' => new _UserPreference_int(EDITWIDTH_DEFAULT_COLS,
1942 EDITWIDTH_MAX_COLS),
1943 'noLinkIcons' => new _UserPreference_bool(), // 1.3.8
1944 'editHeight' => new _UserPreference_int(EDITHEIGHT_DEFAULT_ROWS,
1945 EDITHEIGHT_MIN_ROWS,
1946 EDITHEIGHT_MAX_ROWS),
1947 'timeOffset' => new _UserPreference_numeric(TIMEOFFSET_DEFAULT_HOURS,
1948 TIMEOFFSET_MIN_HOURS,
1949 TIMEOFFSET_MAX_HOURS),
1950 'ownModifications' => new _UserPreference_bool(),
1951 'majorModificationsOnly' => new _UserPreference_bool(),
1952 'relativeDates' => new _UserPreference_bool(),
1953 'googleLink' => new _UserPreference_bool(), // 1.3.10
1954 'doubleClickEdit' => new _UserPreference_bool(), // 1.3.11
1956 // add custom theme-specific pref types:
1957 // FIXME: on theme changes the wiki_user session pref object will fail.
1958 // We will silently ignore this.
1959 if (!empty($customUserPreferenceColumns))
1960 $this->_prefs = array_merge($this->_prefs, $customUserPreferenceColumns);
1962 if (isset($this->_method) and $this->_method == 'SQL') {
1963 //unset($this->_prefs['userid']);
1964 unset($this->_prefs['passwd']);
1967 if (is_array($saved_prefs)) {
1968 foreach ($saved_prefs as $name => $value)
1969 $this->set($name, $value);
1973 function _getPref($name) {
1974 if ($name == 'emailVerified')
1976 if (!isset($this->_prefs[$name])) {
1977 if ($name == 'passwd2') return false;
1978 if ($name == 'passwd') return false;
1979 trigger_error("$name: unknown preference", E_USER_NOTICE);
1982 return $this->_prefs[$name];
1985 // get the value or default_value of the subobject
1986 function get($name) {
1987 if ($_pref = $this->_getPref($name))
1988 if ($name == 'emailVerified')
1989 return $_pref->getraw($name);
1991 return $_pref->get($name);
1996 // check and set the new value in the subobject
1997 function set($name, $value) {
1998 $pref = $this->_getPref($name);
1999 if ($pref === false)
2002 /* do it here or outside? */
2003 if ($name == 'passwd' and
2004 defined('PASSWORD_LENGTH_MINIMUM') and
2005 strlen($value) <= PASSWORD_LENGTH_MINIMUM ) {
2006 //TODO: How to notify the user?
2010 if ($name == 'theme' and $value == '')
2013 // Fix Fatal error for undefined value. Thanks to Jim Ford and Joel Schaubert
2014 if ((!$value and $pref->default_value)
2015 or ($value and !isset($pref->{$name})) // bug #1355533
2016 or ($value and ($pref->{$name} != $pref->default_value)))
2018 if ($name == 'emailVerified') $newvalue = $value;
2019 else $newvalue = $pref->sanify($value);
2020 $pref->set($name, $newvalue);
2022 $this->_prefs[$name] =& $pref;
2026 * use init to avoid update on set
2028 function updatePrefs($prefs, $init = false) {
2030 if ($init) $this->_init = $init;
2031 if (is_object($prefs)) {
2032 $type = 'emailVerified'; $obj =& $this->_prefs['email'];
2033 $obj->_init = $init;
2034 if ($obj->get($type) !== $prefs->get($type)) {
2035 if ($obj->set($type, $prefs->get($type)))
2038 foreach (array_keys($this->_prefs) as $type) {
2039 $obj =& $this->_prefs[$type];
2040 $obj->_init = $init;
2041 if ($prefs->get($type) !== $obj->get($type)) {
2042 // special systemdefault prefs: (probably not needed)
2043 if ($type == 'theme' and $prefs->get($type) == '' and
2044 $obj->get($type) == THEME) continue;
2045 if ($type == 'lang' and $prefs->get($type) == '' and
2046 $obj->get($type) == DEFAULT_LANGUAGE) continue;
2047 if ($this->_prefs[$type]->set($type, $prefs->get($type)))
2051 } elseif (is_array($prefs)) {
2052 //unset($this->_prefs['userid']);
2054 if (isset($this->_method) and
2055 ($this->_method == 'SQL' or $this->_method == 'ADODB')) {
2056 unset($this->_prefs['passwd']);
2059 // emailVerified at first, the rest later
2060 $type = 'emailVerified'; $obj =& $this->_prefs['email'];
2061 $obj->_init = $init;
2062 if (isset($prefs[$type]) and $obj->get($type) !== $prefs[$type]) {
2063 if ($obj->set($type,$prefs[$type]))
2066 foreach (array_keys($this->_prefs) as $type) {
2067 $obj =& $this->_prefs[$type];
2068 $obj->_init = $init;
2069 if (!isset($prefs[$type]) and isa($obj,"_UserPreference_bool"))
2070 $prefs[$type] = false;
2071 if (isset($prefs[$type]) and isa($obj,"_UserPreference_int"))
2072 $prefs[$type] = (int) $prefs[$type];
2073 if (isset($prefs[$type]) and $obj->get($type) != $prefs[$type]) {
2074 // special systemdefault prefs:
2075 if ($type == 'theme' and $prefs[$type] == '' and
2076 $obj->get($type) == THEME) continue;
2077 if ($type == 'lang' and $prefs[$type] == '' and
2078 $obj->get($type) == DEFAULT_LANGUAGE) continue;
2079 if ($obj->set($type,$prefs[$type]))
2087 // For now convert just array of objects => array of values
2088 // Todo: the specialized subobjects must override this.
2091 foreach ($this->_prefs as $name => $object) {
2092 if ($value = $object->getraw($name))
2093 $prefs[$name] = $value;
2094 if ($name == 'email' and ($value = $object->getraw('emailVerified')))
2095 $prefs['emailVerified'] = $value;
2096 if ($name == 'passwd' and $value and ENCRYPTED_PASSWD) {
2097 if (strlen($value) != strlen(crypt('test')))
2098 $prefs['passwd'] = crypt($value);
2099 else // already crypted
2100 $prefs['passwd'] = $value;
2103 return $this->pack($prefs);
2106 // packed string or array of values => array of values
2107 // Todo: the specialized subobjects must override this.
2108 function retrieve($packed) {
2109 if (is_string($packed) and (substr($packed, 0, 2) == "a:"))
2110 $packed = unserialize($packed);
2111 if (!is_array($packed)) return false;
2113 foreach ($packed as $name => $packed_pref) {
2114 if (is_string($packed_pref)
2115 and isSerialized($packed_pref)
2116 and substr($packed_pref, 0, 2) == "O:")
2118 //legacy: check if it's an old array of objects
2119 // Looks like a serialized object.
2120 // This might fail if the object definition does not exist anymore.
2121 // object with ->$name and ->default_value vars.
2122 $pref = @unserialize($packed_pref);
2123 if (is_object($pref))
2124 $prefs[$name] = $pref->get($name);
2125 // fix old-style prefs
2126 } elseif (is_numeric($name) and is_array($packed_pref)) {
2127 if (count($packed_pref) == 1) {
2128 list($name,$value) = each($packed_pref);
2129 $prefs[$name] = $value;
2132 if (isSerialized($packed_pref))
2133 $prefs[$name] = @unserialize($packed_pref);
2134 if (empty($prefs[$name]) and isSerialized(base64_decode($packed_pref)))
2135 $prefs[$name] = @unserialize(base64_decode($packed_pref));
2136 // patched by frederik@pandora.be
2137 if (empty($prefs[$name]))
2138 $prefs[$name] = $packed_pref;
2145 * Check if the given prefs object is different from the current prefs object
2147 function isChanged($other) {
2148 foreach ($this->_prefs as $type => $obj) {
2149 if ($obj->get($type) !== $other->get($type))
2155 function defaultPreferences() {
2157 foreach ($this->_prefs as $key => $obj) {
2158 $prefs[$key] = $obj->default_value;
2165 return $this->_prefs;
2168 function pack($nonpacked) {
2169 return serialize($nonpacked);
2172 function unpack($packed) {
2175 //$packed = base64_decode($packed);
2176 if (substr($packed, 0, 2) == "O:") {
2177 // Looks like a serialized object
2178 return unserialize($packed);
2180 if (substr($packed, 0, 2) == "a:") {
2181 return unserialize($packed);
2183 //trigger_error("DEBUG: Can't unpack bad UserPreferences",
2189 return wikihash($this->_prefs);
2193 /** TODO: new pref storage classes
2194 * These are currently user specific and should be rewritten to be pref specific.
2195 * i.e. $this == $user->_prefs
2198 class CookieUserPreferences
2199 extends UserPreferences
2201 function CookieUserPreferences ($saved_prefs = false) {
2202 //_AnonUser::_AnonUser('',$saved_prefs);
2203 UserPreferences::UserPreferences($saved_prefs);
2207 class PageUserPreferences
2208 extends UserPreferences
2210 function PageUserPreferences ($saved_prefs = false) {
2211 UserPreferences::UserPreferences($saved_prefs);
2215 class PearDbUserPreferences
2216 extends UserPreferences
2218 function PearDbUserPreferences ($saved_prefs = false) {
2219 UserPreferences::UserPreferences($saved_prefs);
2223 class AdoDbUserPreferences
2224 extends UserPreferences
2226 function AdoDbUserPreferences ($saved_prefs = false) {
2227 UserPreferences::UserPreferences($saved_prefs);
2229 function getPreferences() {
2230 // override the generic slow method here for efficiency
2231 _AnonUser::getPreferences();
2232 $this->getAuthDbh();
2233 if (isset($this->_select)) {
2234 $dbh = & $this->_auth_dbi;
2235 $rs = $dbh->Execute(sprintf($this->_select,$dbh->qstr($this->_userid)));
2239 $prefs_blob = $rs->fields['pref_blob'];
2241 if ($restored_from_db = $this->_prefs->retrieve($prefs_blob)) {
2242 $updated = $this->_prefs->updatePrefs($restored_from_db);
2243 //$this->_prefs = new UserPreferences($restored_from_db);
2244 return $this->_prefs;
2248 if (empty($this->_prefs->_prefs) and $this->_HomePagehandle) {
2249 if ($restored_from_page = $this->_prefs->retrieve
2250 ($this->_HomePagehandle->get('pref'))) {
2251 $updated = $this->_prefs->updatePrefs($restored_from_page);
2252 //$this->_prefs = new UserPreferences($restored_from_page);
2253 return $this->_prefs;
2256 return $this->_prefs;
2264 // c-basic-offset: 4
2265 // c-hanging-comment-ender-p: nil
2266 // indent-tabs-mode: nil