]> CyberLeo.Net >> Repos - SourceForge/phpwiki.git/blob - lib/WikiUserNew.php
Special isValidName for Gforge
[SourceForge/phpwiki.git] / lib / WikiUserNew.php
1 <?php //-*-php-*-
2 rcs_id('$Id$');
3 /* Copyright (C) 2004,2005,2006,2007 $ThePhpWikiProgrammingTeam
4  *
5  * This file is part of PhpWiki.
6  * 
7  * PhpWiki is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 2 of the License, or
10  * (at your option) any later version.
11  * 
12  * PhpWiki is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  * 
17  * You should have received a copy of the GNU General Public License
18  * along with PhpWiki; if not, write to the Free Software
19  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
20  */
21 /**
22  * This is a complete OOP rewrite of the old WikiUser code with various
23  * configurable external authentication methods.
24  *
25  * There's only one entry point, the function WikiUser which returns 
26  * a WikiUser object, which contains the name, authlevel and user's preferences.
27  * This object might get upgraded during the login step and later also.
28  * There exist three preferences storage methods: cookie, homepage and db,
29  * and multiple password checking methods.
30  * See index.php for $USER_AUTH_ORDER[] and USER_AUTH_POLICY if 
31  * ALLOW_USER_PASSWORDS is defined.
32  *
33  * Each user object must define the two preferences methods 
34  *  getPreferences(), setPreferences(), 
35  * and the following 1-4 auth methods
36  *  checkPass()  must be defined by all classes,
37  *  userExists() only if USER_AUTH_POLICY'=='strict' 
38  *  mayChangePass()  only if the password is storable.
39  *  storePass()  only if the password is storable.
40  *
41  * WikiUser() given no name, returns an _AnonUser (anonymous user)
42  * object, who may or may not have a cookie. 
43  * However, if the there's a cookie with the userid or a session, 
44  * the user is upgraded to the matching user object.
45  * Given a user name, returns a _BogoUser object, who may or may not 
46  * have a cookie and/or PersonalPage, one of the various _PassUser objects 
47  * or an _AdminUser object.
48  * BTW: A BogoUser is a userid (loginname) as valid WikiWord, who might 
49  * have stored a password or not. If so, his account is secure, if not
50  * anybody can use it, because the username is visible e.g. in RecentChanges.
51  *
52  * Takes care of passwords, all preference loading/storing in the
53  * user's page and any cookies. lib/main.php will query the user object to
54  * verify the password as appropriate.
55  *
56  * @author: Reini Urban (the tricky parts), 
57  *          Carsten Klapp (started rolling the ball)
58  *
59  * Random architectural notes, sorted by date:
60  * 2004-01-25 rurban
61  * Test it by defining ENABLE_USER_NEW in config/config.ini
62  * 1) Now a ForbiddenUser is returned instead of false.
63  * 2) Previously ALLOW_ANON_USER = false meant that anon users cannot edit, 
64  *    but may browse. Now with ALLOW_ANON_USER = false he may not browse, 
65  *    which is needed to disable browse PagePermissions.
66  *    I added now ALLOW_ANON_EDIT = true to makes things clear. 
67  *    (which replaces REQUIRE_SIGNIN_BEFORE_EDIT)
68  * 2004-02-27 rurban:
69  * 3) Removed pear prepare. Performance hog, and using integers as 
70  *    handler doesn't help. Do simple sprintf as with adodb. And a prepare
71  *    in the object init is no advantage, because in the init loop a lot of 
72  *    objects are tried, but not used.
73  * 4) Already gotten prefs are passed to the next object to avoid 
74  *    duplicate getPreferences() calls.
75  * 2004-03-18 rurban
76  * 5) Major php-5 problem: $this re-assignment is disallowed by the parser
77  *    So we cannot just discrimate with 
78  *      if (!check_php_version(5))
79  *          $this = $user;
80  *    A /php5-patch.php is provided, which patches the src automatically 
81  *    for php4 and php5. Default is php4.
82  *    Update: not needed anymore. we use eval to fool the load-time syntax checker.
83  * 2004-03-24 rurban
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.
87  * 2004-04-04 rurban
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.
93  */
94
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
101
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);
107
108 if (!defined('EDITHEIGHT_MIN_ROWS'))     define('EDITHEIGHT_MIN_ROWS',      5);
109 if (!defined('EDITHEIGHT_MAX_ROWS'))     define('EDITHEIGHT_MAX_ROWS',     80);
110 if (!defined('EDITHEIGHT_DEFAULT_ROWS')) define('EDITHEIGHT_DEFAULT_ROWS', 22);
111
112 define('TIMEOFFSET_MIN_HOURS', -26);
113 define('TIMEOFFSET_MAX_HOURS',  26);
114 if (!defined('TIMEOFFSET_DEFAULT_HOURS')) define('TIMEOFFSET_DEFAULT_HOURS', 0);
115
116 /* 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
120  */
121 $EMailHosts = array('avl.com' => 'mail.avl.com');
122
123 /**
124  * There are be the following constants in config/config.ini to 
125  * establish login parameters:
126  *
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
132  *
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
138  *
139  * To establish a COMPLETELY private wiki, such as an internal
140  * corporate one:
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
144  * any page.
145  *
146  * There are other possible combinations, but the typical wiki (such
147  * as http://PhpWiki.sf.net/phpwiki) would usually just leave all four 
148  * enabled.
149  *
150  */
151
152 // The last object in the row is the bad guy...
153 if (!is_array($USER_AUTH_ORDER))
154     $USER_AUTH_ORDER = array("Forbidden");
155 else
156     $USER_AUTH_ORDER[] = "Forbidden";
157
158 // Local convenience functions.
159 function _isAnonUserAllowed() {
160     return (defined('ALLOW_ANON_USER') && ALLOW_ANON_USER);
161 }
162 function _isBogoUserAllowed() {
163     return (defined('ALLOW_BOGO_LOGIN') && ALLOW_BOGO_LOGIN);
164 }
165 function _isUserPasswordsAllowed() {
166     return (defined('ALLOW_USER_PASSWORDS') && ALLOW_USER_PASSWORDS);
167 }
168
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.
173     if (!$UserName)
174         return $GLOBALS['ForbiddenUser'];
175
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);
182     }
183     */
184     else
185         return _determineBogoUserOrPassUser($UserName);
186 }
187
188 function _determineBogoUserOrPassUser($UserName) {
189     global $ForbiddenUser;
190
191     // Sanity check. User name is a condition of the definition of
192     // _BogoUser and _PassUser.
193     if (!$UserName)
194         return $ForbiddenUser;
195
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'))
202             return $_BogoUser;
203     }
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);
209         else { 
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();
217                 else
218                     $class = get_class($_PassUser);
219                 if ($user = new $class($UserName, $_PassUser->_prefs)) {
220                     return $user;
221                 } else {
222                     return $_PassUser;
223                 }
224             }
225         }
226     }
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;
231 }
232
233 /**
234  * Primary WikiUser function, called by lib/main.php.
235  * 
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.
239  *
240  * If an _AnonUser object is returned, the user may only browse pages
241  * (and save prefs in a cookie).
242  *
243  * To disable access but provide prefs the global $ForbiddenUser class 
244  * is returned. (was previously false)
245  * 
246  */
247 function WikiUser ($UserName = '') {
248     global $ForbiddenUser, $HTTP_SESSION_VARS;
249
250     //Maybe: Check sessionvar for username & save username into
251     //sessionvar (may be more appropriate to do this in lib/main.php).
252     if ($UserName) {
253         $ForbiddenUser = new _ForbiddenUser($UserName);
254         // Found a user name.
255         return _determineAdminUserOrOtherUser($UserName);
256     }
257     elseif (!empty($HTTP_SESSION_VARS['userid'])) {
258         // Found a user name.
259         $ForbiddenUser = new _ForbiddenUser($_SESSION['userid']);
260         return _determineAdminUserOrOtherUser($_SESSION['userid']);
261     }
262     else {
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);
270         }
271         else {
272             $ForbiddenUser = new _ForbiddenUser();
273             if (_isAnonUserAllowed())
274                 return $_AnonUser;
275             return $ForbiddenUser; // User must sign in to browse pages.
276         }
277         return $ForbiddenUser;     // User must sign in with a password.
278     }
279     /*
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.
283     */
284 }
285
286 /**
287  * WikiUser.php use the name 'WikiUser'
288  */
289 function WikiUserClassname() {
290     return '_WikiUser';
291 }
292
293
294 /**
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.
299  */
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;
311         }
312         if (!empty($user->_authmethod))
313             $newuser->_authmethod = $user->_authmethod;
314         $GLOBALS['request']->_user_class = get_class($newuser);
315         /*
316         foreach (get_object_vars($user) as $k => $v) {
317             if (!empty($v)) $olduser->$k = $v;  
318         }
319         */
320         $newuser->hasHomePage(); // revive db handle, because these don't survive sessions
321         //$GLOBALS['request']->_user = $olduser;
322         return $newuser;
323     } else {
324         return false;
325     }
326 }
327
328 /**
329  * Probably not needed, since we use the various user objects methods so far.
330  * Anyway, here it is, looping through all available objects.
331  */
332 function UserExists ($UserName) {
333     global $request;
334     if (!($user = $request->getUser()))
335         $user = WikiUser($UserName);
336     if (!$user) 
337         return false;
338     if ($user->userExists($UserName)) {
339         $request->_user = $user;
340         return true;
341     }
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);
347     }
348     $request->_user = $GLOBALS['ForbiddenUser'];
349     return false;
350 }
351
352 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
353
354 /** 
355  * Base WikiUser class.
356  */
357 class _WikiUser
358 {
359      var $_userid = '';
360      var $_level = WIKIAUTH_ANON;
361      var $_prefs = false;
362      var $_HomePagehandle = false;
363
364     // constructor
365     function _WikiUser($UserName='', $prefs=false) {
366
367         $this->_userid = $UserName;
368         $this->_HomePagehandle = false;
369         if ($UserName) {
370             $this->hasHomePage();
371         }
372         if (empty($this->_prefs)) {
373             if ($prefs) $this->_prefs = $prefs;
374             else $this->getPreferences();
375         }
376     }
377
378     function UserName() {
379         if (!empty($this->_userid))
380             return $this->_userid;
381     }
382
383     function getPreferences() {
384         trigger_error("DEBUG: Note: undefined _WikiUser class trying to load prefs." . " "
385                       . "New subclasses of _WikiUser must override this function.");
386         return false;
387     }
388
389     function setPreferences($prefs, $id_only) {
390         trigger_error("DEBUG: Note: undefined _WikiUser class trying to save prefs." 
391                       . " "
392                       . "New subclasses of _WikiUser must override this function.");
393         return false;
394     }
395
396     function userExists() {
397         return $this->hasHomePage();
398     }
399
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." 
403                       . " "
404                       . "New subclasses of _WikiUser must override this function.");
405         return false;
406     }
407
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();
413             }
414             else {
415                 // check db again (maybe someone else created it since
416                 // we logged in.)
417                 global $request;
418                 $this->_HomePagehandle = $request->getPage($this->_userid);
419                 return $this->_HomePagehandle->exists();
420             }
421         }
422         // nope
423         return false;
424     }
425
426     // 
427     function createHomePage() {
428         global $request;
429         $versiondata = array('author' => _("The PhpWiki programming team"));
430         $request->_dbi->save(_("Automatically created user homepage to be able to store UserPreferences.").
431                              "\n{{Template/UserPage}}",
432                              1, $versiondata);
433         $request->_dbi->touch();                             
434         $this->_HomePagehandle = $request->getPage($this->_userid);
435     }
436     
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)
442                 return $found;
443         }
444         return false;
445     }
446
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);
455             } else {
456                 $this->_current_index = -1;
457             }
458         }
459         $this->_current_index++;
460         if ($this->_current_index >= count($this->_auth_methods))
461             return false;
462         $this->_current_method = $this->_auth_methods[$this->_current_index];
463         return $this->_current_index;
464     }
465
466     function AuthMethod($index = false) {
467         return $this->_auth_methods[ $index === false 
468                                      ? count($this->_auth_methods)-1 
469                                      : $index];
470     }
471
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";
477     }
478
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;
488         $require_level = 0;
489         extract($args); // fixme
490
491         $require_level = max(0, min(WIKIAUTH_ADMIN, (int)$require_level));
492
493         $pagename = $request->getArg('pagename');
494         $nocache = 1;
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);
504         } else {
505             return $login->printExpansion();
506         }
507     }
508
509     /** Signed in but not password checked or empty password.
510      */
511     function isSignedIn() {
512         return (isa($this,'_BogoUser') or isa($this,'_PassUser'));
513     }
514
515     /** This is password checked for sure.
516      */
517     function isAuthenticated() {
518         //return isa($this,'_PassUser');
519         //return isa($this,'_BogoUser') || isa($this,'_PassUser');
520         return $this->_level >= WIKIAUTH_BOGO;
521     }
522
523     function isAdmin () {
524         static $group; 
525         if ($this->_level == WIKIAUTH_ADMIN) return true;
526         if (!$this->isSignedIn()) return false;
527         if (!$this->isAuthenticated()) return false;
528
529         if (!$group) $group = &$GLOBALS['request']->getGroup();
530         return ($this->_level > WIKIAUTH_BOGO and $group->isMember(GROUP_ADMIN));
531     }
532
533     /** Name or IP for a signed user. UserName could come from a cookie e.g.
534      */
535     function getId () {
536         return ( $this->UserName()
537                  ? $this->UserName()
538                  : $GLOBALS['request']->get('REMOTE_ADDR') );
539     }
540
541     /** Name for an authenticated user. No IP here.
542      */
543     function getAuthenticatedId() {
544         return ( $this->isAuthenticated()
545                  ? $this->_userid
546                  : ''); //$GLOBALS['request']->get('REMOTE_ADDR') );
547     }
548
549     function hasAuthority ($require_level) {
550         return $this->_level >= $require_level;
551     }
552
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.
556     */
557     function isValidName ($userid = false) {
558         if (!$userid) $userid = $this->_userid;
559         if (!$userid) return false;
560         if (defined('GFORGE') and GFORGE) {
561             return true;
562         }
563         return preg_match("/^[\-\w\.@ ]+$/U", $userid) and strlen($userid) < 32;
564     }
565
566     /**
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)
569      */
570     function AuthCheck ($postargs) {
571         // Normalize args, and extract.
572         $keys = array('userid', 'passwd', 'require_level', 'login', 'logout',
573                       'cancel');
574         foreach ($keys as $key)
575             $args[$key] = isset($postargs[$key]) ? $postargs[$key] : false;
576         extract($args);
577         $require_level = max(0, min(WIKIAUTH_ADMIN, (int)$require_level));
578
579         if ($logout) { // Log out
580             if (LOGIN_LOG and is_writeable(LOGIN_LOG)) {
581                 global $request;
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),
589                                  "401",
590                                  (string) $request->get('HTTP_REFERER'),
591                                  (string) $request->get('HTTP_USER_AGENT')
592                                  );
593                 if (($fp = fopen(LOGIN_LOG, "a"))) {
594                     flock($fp, LOCK_EX);
595                     fputs($fp, "$entry\n");
596                     fclose($fp);
597                 }
598                 //error_log("$entry\n", 3, LOGIN_LOG);
599             }
600             if (method_exists($GLOBALS['request']->_user, "logout")) { //_HttpAuthPassUser
601                 $GLOBALS['request']->_user->logout();
602             }
603             $user = new _AnonUser();
604             $user->_userid = '';
605             $user->_level = WIKIAUTH_ANON;
606             return $user; 
607         } elseif ($cancel)
608             return false;        // User hit cancel button.
609         elseif (!$login && !$userid)
610             return false;       // Nothing to do?
611
612         if (!$this->isValidName($userid))
613             return _("Invalid username.");;
614
615         $authlevel = $this->checkPass($passwd === false ? '' : $passwd);
616
617         if (LOGIN_LOG and is_writeable(LOGIN_LOG)) {
618             global $request;
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] = ">";
632             }
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')
641                              );
642             if (($fp = fopen(LOGIN_LOG, "a"))) {
643                 flock($fp, LOCK_EX);
644                 fputs($fp, "$entry\n");
645                 fclose($fp);
646             }
647             //error_log("$entry\n", 3, LOGIN_LOG);
648         }
649
650         if ($authlevel <= 0) { // anon or forbidden
651             if ($passwd)
652                 return _("Invalid password.");
653             else
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') 
657             {
658                 // upgrade class
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;
666                 return $user;
667             }
668             $this->_userid = $userid;
669             $this->_level = $authlevel;
670             return _("Insufficient permissions.");
671         }
672
673         // Successful login.
674         //$user = $GLOBALS['request']->_user;
675         if (!empty($this->_current_method) and 
676             strtolower(get_class($this)) == '_passuser') 
677         {
678             // upgrade class
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;
686             return $user;
687         }
688         $this->_userid = $userid;
689         $this->_level = $authlevel;
690         return $this;
691     }
692
693 }
694
695 /**
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.
698  */
699 class _AnonUser
700 extends _WikiUser
701 {
702     var $_level = WIKIAUTH_ANON;        // var in php-5.0.0RC1 deprecated
703
704     /** Anon only gets to load and save prefs in a cookie, that's it.
705      */
706     function getPreferences() {
707         global $request;
708
709         if (empty($this->_prefs))
710             $this->_prefs = new UserPreferences;
711         $UserName = $this->UserName();
712
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.") 
717                               . "\n"
718                               . sprintf("%s='%s'", WIKI_NAME, $cookie)
719                               . "\n"
720                               . _("Default preferences will be used."),
721                               E_USER_NOTICE);
722             }
723             /**
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
727              * function too!).
728              */
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;
735                 else 
736                     $UserName = false;    
737             }
738             // v1.3.8 policy: don't set PhpWiki cookies, only plaintext WIKI_ID cookies
739             if (!headers_sent())
740                 $request->deleteCookieVar(WIKI_NAME);
741         }
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;
751                     else 
752                         $UserName = false;    
753                 }
754                 if (!headers_sent())
755                     $request->deleteCookieVar("WIKI_PREF2");
756             }
757         }
758         if (! $UserName ) {
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:'))
762                     $UserName = $cookie;
763                 elseif (is_array($cookie) and !empty($cookie['userid']))
764                     $UserName = $cookie['userid'];
765             }
766             if (! $UserName and !headers_sent())
767                 $request->deleteCookieVar(getCookieName());
768             else
769                 $this->_userid = $UserName;
770         }
771
772         // initializeTheme() needs at least an empty object
773         /*
774          if (empty($this->_prefs))
775             $this->_prefs = new UserPreferences;
776         */
777         return $this->_prefs;
778     }
779
780     /** _AnonUser::setPreferences(): Save prefs in a cookie and session and update all global vars
781      *
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.
788      */
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;
794             } else {
795                 // update the prefs values from scratch. This could leed to unnecessary
796                 // side-effects: duplicate emailVerified, ...
797                 $this->_prefs = new UserPreferences($prefs);
798                 $updated = true;
799             }
800         } else {
801             if (!isset($this->_prefs))
802                 $this->_prefs =& $prefs;
803             else
804                 $updated = $this->_prefs->isChanged($prefs);
805         }
806         if ($updated) {
807             if ($id_only and !headers_sent()) {
808                 global $request;
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);
816             }
817         }
818         $packed = $prefs->store();
819         $unpacked = $prefs->unpack($packed);
820         if (count($unpacked)) {
821             foreach (array('_method','_select','_update','_insert') as $param) {
822                 if (!empty($this->_prefs->{$param}))
823                     $prefs->{$param} = $this->_prefs->{$param};
824             }
825             $this->_prefs = $prefs;
826         }
827         return $updated;
828     }
829
830     function userExists() {
831         return true;
832     }
833
834     function checkPass($submitted_password) {
835         return false;
836         // this might happen on a old-style signin button.
837
838         // By definition, the _AnonUser does not HAVE a password
839         // (compared to _BogoUser, who has an EMPTY password).
840         trigger_error("DEBUG: Warning: _AnonUser unexpectedly asked to checkPass()." . " "
841                       . "Check isa(\$user, '_PassUser'), or: isa(\$user, '_AdminUser') etc. first." . " "
842                       . "New subclasses of _WikiUser must override this function.");
843         return false;
844     }
845
846 }
847
848 /** 
849  * Helper class to finish the PassUser auth loop. 
850  * This is added automatically to USER_AUTH_ORDER.
851  */
852 class _ForbiddenUser
853 extends _AnonUser
854 {
855     var $_level = WIKIAUTH_FORBIDDEN;
856
857     function checkPass($submitted_password) {
858         return WIKIAUTH_FORBIDDEN;
859     }
860
861     function userExists() {
862         if ($this->_HomePagehandle) return true;
863         return false;
864     }
865 }
866
867 /**
868  * Do NOT extend _BogoUser to other classes, for checkPass()
869  * security. (In case of defects in code logic of the new class!)
870  * The intermediate step between anon and passuser.
871  * We also have the _BogoLoginPassUser class with stricter 
872  * password checking, which fits into the auth loop.
873  * Note: This class is not called anymore by WikiUser()
874  */
875 class _BogoUser
876 extends _AnonUser
877 {
878     function userExists() {
879         if (isWikiWord($this->_userid)) {
880             $this->_level = WIKIAUTH_BOGO;
881             return true;
882         } else {
883             $this->_level = WIKIAUTH_ANON;
884             return false;
885         }
886     }
887
888     function checkPass($submitted_password) {
889         // By definition, BogoUser has an empty password.
890         $this->userExists();
891         return $this->_level;
892     }
893 }
894
895 class _PassUser
896 extends _AnonUser
897 /**
898  * Called if ALLOW_USER_PASSWORDS and Anon and Bogo failed.
899  *
900  * The classes for all subsequent auth methods extend from this class. 
901  * This handles the auth method type dispatcher according $USER_AUTH_ORDER, 
902  * the three auth method policies first-only, strict and stacked
903  * and the two methods for prefs: homepage or database, 
904  * if $DBAuthParams['pref_select'] is defined.
905  *
906  * Default is PersonalPage auth and prefs.
907  * 
908  * @author: Reini Urban
909  * @tables: pref
910  */
911 {
912     var $_auth_dbi, $_prefs;
913     var $_current_method, $_current_index;
914
915     // check and prepare the auth and pref methods only once
916     function _PassUser($UserName='', $prefs=false) {
917         //global $DBAuthParams, $DBParams;
918         if ($UserName) {
919             /*if (!$this->isValidName($UserName))
920                 return false;*/
921             $this->_userid = $UserName;
922             if ($this->hasHomePage())
923                 $this->_HomePagehandle = $GLOBALS['request']->getPage($this->_userid);
924         }
925         $this->_authmethod = substr(get_class($this),1,-8);
926         if ($this->_authmethod == 'a') $this->_authmethod = 'admin';
927
928         // Check the configured Prefs methods
929         $dbi = $this->getAuthDbh();
930         $dbh = $GLOBALS['request']->getDbh();
931         if ( $dbi and !isset($this->_prefs->_select) and $dbh->getAuthParam('pref_select')) {
932             if (!$this->_prefs) {
933                 $this->_prefs = new UserPreferences();
934                 $need_pref = true;
935             }
936             $this->_prefs->_method = $dbh->getParam('dbtype');
937             $this->_prefs->_select = $this->prepare($dbh->getAuthParam('pref_select'), "userid");
938             // read-only prefs?
939             if ( !isset($this->_prefs->_update) and $dbh->getAuthParam('pref_update')) {
940                 $this->_prefs->_update = $this->prepare($dbh->getAuthParam('pref_update'), 
941                                                         array("userid", "pref_blob"));
942             }
943         } else {
944             if (!$this->_prefs) {
945                 $this->_prefs = new UserPreferences();
946                 $need_pref = true;
947             }
948             $this->_prefs->_method = 'HomePage';
949         }
950         
951         if (! $this->_prefs or isset($need_pref) ) {
952             if ($prefs) $this->_prefs = $prefs;
953             else $this->getPreferences();
954         }
955         
956         // Upgrade to the next parent _PassUser class. Avoid recursion.
957         if ( strtolower(get_class($this)) === '_passuser' ) {
958             //auth policy: Check the order of the configured auth methods
959             // 1. first-only: Upgrade the class here in the constructor
960             // 2. old:       ignore USER_AUTH_ORDER and try to use all available methods as 
961             ///              in the previous PhpWiki releases (slow)
962             // 3. strict:    upgrade the class after checking the user existance in userExists()
963             // 4. stacked:   upgrade the class after the password verification in checkPass()
964             // Methods: PersonalPage, HttpAuth, DB, Ldap, Imap, File
965             //if (!defined('USER_AUTH_POLICY')) define('USER_AUTH_POLICY','old');
966             if (defined('USER_AUTH_POLICY')) {
967                 // policy 1: only pre-define one method for all users
968                 if (USER_AUTH_POLICY === 'first-only') {
969                     $class = $this->nextClass();
970                     return new $class($UserName,$this->_prefs);
971                 }
972                 // Use the default behaviour from the previous versions:
973                 elseif (USER_AUTH_POLICY === 'old') {
974                     // Default: try to be smart
975                     // On php5 we can directly return and upgrade the Object,
976                     // before we have to upgrade it manually.
977                     if (!empty($GLOBALS['PHP_AUTH_USER']) or !empty($_SERVER['REMOTE_USER'])) {
978                         include_once("lib/WikiUser/HttpAuth.php");
979                         if (check_php_version(5))
980                             return new _HttpAuthPassUser($UserName,$this->_prefs);
981                         else {
982                             $user = new _HttpAuthPassUser($UserName,$this->_prefs);
983                             eval("\$this = \$user;");
984                             // /*PHP5 patch*/$this = $user;
985                             return $user;
986                         }
987                     } elseif (in_array('Db', $dbh->getAuthParam('USER_AUTH_ORDER')) and
988                               $dbh->getAuthParam('auth_check') and
989                               ($dbh->getAuthParam('auth_dsn') or $dbh->getParam('dsn'))) {
990                         if (check_php_version(5))
991                             return new _DbPassUser($UserName,$this->_prefs);
992                         else {
993                             $user = new _DbPassUser($UserName,$this->_prefs);
994                             eval("\$this = \$user;");
995                             // /*PHP5 patch*/$this = $user;
996                             return $user;
997                         }
998                     } elseif (in_array('LDAP', $dbh->getAuthParam('USER_AUTH_ORDER')) and
999                               defined('LDAP_AUTH_HOST') and defined('LDAP_BASE_DN') and 
1000                               function_exists('ldap_connect')) {
1001                         include_once("lib/WikiUser/LDAP.php");
1002                         if (check_php_version(5))
1003                             return new _LDAPPassUser($UserName,$this->_prefs);
1004                         else {
1005                             $user = new _LDAPPassUser($UserName,$this->_prefs);
1006                             eval("\$this = \$user;");
1007                             // /*PHP5 patch*/$this = $user;
1008                             return $user;
1009                         }
1010                     } elseif (in_array('IMAP', $dbh->getAuthParam('USER_AUTH_ORDER')) and
1011                               defined('IMAP_AUTH_HOST') and function_exists('imap_open')) {
1012                         include_once("lib/WikiUser/IMAP.php");
1013                         if (check_php_version(5))
1014                             return new _IMAPPassUser($UserName,$this->_prefs);
1015                         else {
1016                             $user = new _IMAPPassUser($UserName,$this->_prefs);
1017                             eval("\$this = \$user;");
1018                             // /*PHP5 patch*/$this = $user;
1019                             return $user;
1020                         }
1021                     } elseif (in_array('File', $dbh->getAuthParam('USER_AUTH_ORDER')) and
1022                               defined('AUTH_USER_FILE') and file_exists(AUTH_USER_FILE)) {
1023                         include_once("lib/WikiUser/File.php");
1024                         if (check_php_version(5))
1025                             return new _FilePassUser($UserName, $this->_prefs);
1026                         else {
1027                             $user = new _FilePassUser($UserName, $this->_prefs);
1028                             eval("\$this = \$user;");
1029                             // /*PHP5 patch*/$this = $user;
1030                             return $user;
1031                         }
1032                     } else {
1033                         include_once("lib/WikiUser/PersonalPage.php");
1034                         if (check_php_version(5))
1035                             return new _PersonalPagePassUser($UserName,$this->_prefs);
1036                         else {
1037                             $user = new _PersonalPagePassUser($UserName,$this->_prefs);
1038                             eval("\$this = \$user;");
1039                             // /*PHP5 patch*/$this = $user;
1040                             return $user;
1041                         }
1042                     }
1043                 }
1044                 else 
1045                     // else use the page methods defined in _PassUser.
1046                     return $this;
1047             }
1048         }
1049     }
1050
1051     function getAuthDbh () {
1052         global $request; //, $DBParams, $DBAuthParams;
1053
1054         $dbh = $request->getDbh();
1055         // session restauration doesn't re-connect to the database automatically, 
1056         // so dirty it here, to force a reconnect.
1057         if (isset($this->_auth_dbi)) {
1058             if (($dbh->getParam('dbtype') == 'SQL') and empty($this->_auth_dbi->connection))
1059                 unset($this->_auth_dbi);
1060             if (($dbh->getParam('dbtype') == 'ADODB') and empty($this->_auth_dbi->_connectionID))
1061                 unset($this->_auth_dbi);
1062         }
1063         if (empty($this->_auth_dbi)) {
1064             if ($dbh->getParam('dbtype') != 'SQL' 
1065                 and $dbh->getParam('dbtype') != 'ADODB'
1066                 and $dbh->getParam('dbtype') != 'PDO')
1067                 return false;
1068             if (empty($GLOBALS['DBAuthParams']))
1069                 return false;
1070             if (!$dbh->getAuthParam('auth_dsn')) {
1071                 $dbh = $request->getDbh(); // use phpwiki database 
1072             } elseif ($dbh->getAuthParam('auth_dsn') == $dbh->getParam('dsn')) {
1073                 $dbh = $request->getDbh(); // same phpwiki database 
1074             } else { // use another external database handle. needs PHP >= 4.1
1075                 $local_params = array_merge($GLOBALS['DBParams'],$GLOBALS['DBAuthParams']);
1076                 $local_params['dsn'] = $local_params['auth_dsn'];
1077                 $dbh = WikiDB::open($local_params);
1078             }       
1079             $this->_auth_dbi =& $dbh->_backend->_dbh;    
1080         }
1081         return $this->_auth_dbi;
1082     }
1083
1084     function _normalize_stmt_var($var, $oldstyle = false) {
1085         static $valid_variables = array('userid','password','pref_blob','groupname');
1086         // old-style: "'$userid'"
1087         // new-style: '"\$userid"' or just "userid"
1088         $new = str_replace(array("'",'"','\$','$'),'',$var);
1089         if (!in_array($new, $valid_variables)) {
1090             trigger_error("Unknown DBAuthParam statement variable: ". $new, E_USER_ERROR);
1091             return false;
1092         }
1093         return !$oldstyle ? "'$".$new."'" : '\$'.$new;
1094     }
1095
1096     // TODO: use it again for the auth and member tables
1097     // sprintfstyle vs prepare style: %s or ?
1098     //   multiple vars should be executed via prepare(?,?)+execute, 
1099     //   single vars with execute(sprintf(quote(var)))
1100     // help with position independency
1101     function prepare ($stmt, $variables, $oldstyle = false, $sprintfstyle = true) {
1102         global $request;
1103         $dbi = $request->getDbh();
1104         $this->getAuthDbh();
1105         // "'\$userid"' => %s
1106         // variables can be old-style: '"\$userid"' or new-style: "'$userid'" or just "userid"
1107         // old-style strings don't survive pear/Config/IniConfig treatment, that's why we changed it.
1108         $new = array();
1109         if (is_array($variables)) {
1110             //$sprintfstyle = false;
1111             for ($i=0; $i < count($variables); $i++) { 
1112                 $var = $this->_normalize_stmt_var($variables[$i], $oldstyle);
1113                 if (!$var)
1114                     trigger_error(sprintf("DbAuthParams: Undefined or empty statement variable %s in %s",
1115                                           $variables[$i], $stmt), E_USER_WARNING);
1116                 $variables[$i] = $var;
1117                 if (!$var) $new[] = '';
1118                 else {
1119                     $s = "%" . ($i+1) . "s";    
1120                     $new[] = $sprintfstyle ? $s : "?";
1121                 }
1122             }
1123         } else {
1124             $var = $this->_normalize_stmt_var($variables, $oldstyle);
1125             if (!$var)
1126                 trigger_error(sprintf("DbAuthParams: Undefined or empty statement variable %s in %s",
1127                                       $variables, $stmt), E_USER_WARNING);
1128             $variables = $var;
1129             if (!$var) $new = ''; 
1130             else $new = $sprintfstyle ? '%s' : "?"; 
1131         }
1132         $prefix = $dbi->getParam('prefix');
1133         // probably prefix table names if in same database
1134         if ($prefix and isset($this->_auth_dbi) and isset($dbi->_backend->_dbh) and 
1135             ($dbi->getAuthParam('auth_dsn') and $dbi->getParam('dsn') == $dbi->getAuthParam('auth_dsn')))
1136         {
1137             if (!stristr($stmt, $prefix)) {
1138                 $oldstmt = $stmt;
1139                 $stmt = str_replace(array(" user "," pref "," member "),
1140                                     array(" ".$prefix."user ",
1141                                           " ".$prefix."pref ",
1142                                           " ".$prefix."member "), $stmt);
1143                 //Do it automatically for the lazy admin? Esp. on sf.net it's nice to have
1144                 trigger_error("Need to prefix the DBAUTH tablename in config/config.ini:\n  $oldstmt \n=> $stmt",
1145                               E_USER_WARNING);
1146             }
1147         }
1148         // Preparate the SELECT statement, for ADODB and PearDB (MDB not).
1149         // Simple sprintf-style.
1150         $new_stmt = str_replace($variables, $new, $stmt);
1151         if ($new_stmt == $stmt) {
1152             if ($oldstyle) {
1153                 trigger_error(sprintf("DbAuthParams: Invalid statement in %s",
1154                                   $stmt), E_USER_WARNING);
1155             } else {
1156                 trigger_error(sprintf("DbAuthParams: Old statement quoting style in %s",
1157                                   $stmt), E_USER_WARNING);
1158                 $new_stmt = $this->prepare($stmt, $variables, 'oldstyle');
1159             }
1160         }
1161         return $new_stmt;
1162     }
1163
1164     function getPreferences() {
1165         if (!empty($this->_prefs->_method)) {
1166             if ($this->_prefs->_method == 'ADODB') {
1167                 // FIXME: strange why this should be needed...
1168                 include_once("lib/WikiUser/Db.php");
1169                 include_once("lib/WikiUser/AdoDb.php");
1170                 $user = new _AdoDbPassUser($this->_userid, $this->_prefs);
1171                 return $user->getPreferences();
1172             } elseif ($this->_prefs->_method == 'SQL') {
1173                 include_once("lib/WikiUser/Db.php");
1174                 include_once("lib/WikiUser/PearDb.php");
1175                 $user = new _PearDbPassUser($this->_userid, $this->_prefs);
1176                 return $user->getPreferences();
1177             } elseif ($this->_prefs->_method == 'PDO') {
1178                 include_once("lib/WikiUser/Db.php");
1179                 include_once("lib/WikiUser/PdoDb.php");
1180                 $user = new _PdoDbPassUser($this->_userid, $this->_prefs);
1181                 return $user->getPreferences();
1182             }
1183         }
1184
1185         // We don't necessarily have to read the cookie first. Since
1186         // the user has a password, the prefs stored in the homepage
1187         // cannot be arbitrarily altered by other Bogo users.
1188         _AnonUser::getPreferences();
1189         // User may have deleted cookie, retrieve from his
1190         // PersonalPage if there is one.
1191         if (!empty($this->_HomePagehandle)) {
1192             if ($restored_from_page = $this->_prefs->retrieve
1193                 ($this->_HomePagehandle->get('pref'))) {
1194                 $updated = $this->_prefs->updatePrefs($restored_from_page,'init');
1195                 //$this->_prefs = new UserPreferences($restored_from_page);
1196                 return $this->_prefs;
1197             }
1198         }
1199         return $this->_prefs;
1200     }
1201
1202     function setPreferences($prefs, $id_only=false) {
1203         if (!empty($this->_prefs->_method)) {
1204             if ($this->_prefs->_method == 'ADODB') {
1205                 // FIXME: strange why this should be needed...
1206                 include_once("lib/WikiUser/Db.php");
1207                 include_once("lib/WikiUser/AdoDb.php");
1208                 $user = new _AdoDbPassUser($this->_userid, $prefs);
1209                 return $user->setPreferences($prefs, $id_only);
1210             }
1211             elseif ($this->_prefs->_method == 'SQL') {
1212                 include_once("lib/WikiUser/Db.php");
1213                 include_once("lib/WikiUser/PearDb.php");
1214                 $user = new _PearDbPassUser($this->_userid, $prefs);
1215                 return $user->setPreferences($prefs, $id_only);
1216             }
1217             elseif ($this->_prefs->_method == 'PDO') {
1218                 include_once("lib/WikiUser/Db.php");
1219                 include_once("lib/WikiUser/PdoDb.php");
1220                 $user = new _PdoDbPassUser($this->_userid, $prefs);
1221                 return $user->setPreferences($prefs, $id_only);
1222             }
1223         }
1224         if ($updated = _AnonUser::setPreferences($prefs, $id_only)) {
1225             // Encode only the _prefs array of the UserPreference object
1226             // If no DB method exists to store the prefs we must store it in the page, not in the cookies.
1227             if (empty($this->_HomePagehandle)) {
1228                 $this->_HomePagehandle = $GLOBALS['request']->getPage($this->_userid);
1229             }
1230             if (! $this->_HomePagehandle->exists() ) {
1231                 $this->createHomePage();
1232             }
1233             if (!empty($this->_HomePagehandle) and !$id_only) {
1234                 $this->_HomePagehandle->set('pref', $this->_prefs->store());
1235             }
1236         }
1237         return $updated;
1238     }
1239
1240     function mayChangePass() {
1241         return true;
1242     }
1243
1244     //The default method is getting the password from prefs. 
1245     // child methods obtain $stored_password from external auth.
1246     function userExists() {
1247         //if ($this->_HomePagehandle) return true;
1248         if (strtolower(get_class($this)) == "_passuser") {
1249             $class = $this->nextClass();
1250             $user = new $class($this->_userid, $this->_prefs);
1251         } else {
1252             $user = $this;
1253         }
1254         while ($user) {
1255             if (!check_php_version(5))
1256                 eval("\$this = \$user;");
1257             $user = UpgradeUser($this, $user);
1258             if ($user->userExists()) {
1259                 $user = UpgradeUser($this, $user);
1260                 return true;
1261             }
1262             // prevent endless loop. does this work on all PHP's?
1263             // it just has to set the classname, what it correctly does.
1264             $class = $user->nextClass();
1265             if ($class == "_ForbiddenPassUser")
1266                 return false;
1267         }
1268         return false;
1269     }
1270
1271     //The default method is getting the password from prefs. 
1272     // child methods obtain $stored_password from external auth.
1273     function checkPass($submitted_password) {
1274         $stored_password = $this->_prefs->get('passwd');
1275         if ($this->_checkPass($submitted_password, $stored_password)) {
1276             $this->_level = WIKIAUTH_USER;
1277             return $this->_level;
1278         } else {
1279             if ((USER_AUTH_POLICY === 'strict') and $this->userExists()) {
1280                 $this->_level = WIKIAUTH_FORBIDDEN;
1281                 return $this->_level;
1282             }
1283             return $this->_tryNextPass($submitted_password);
1284         }
1285     }
1286
1287
1288     function _checkPassLength($submitted_password) {
1289         if (strlen($submitted_password) < PASSWORD_LENGTH_MINIMUM) {
1290             trigger_error(_("The length of the password is shorter than the system policy allows."));
1291             return false;
1292         }
1293         return true;
1294     }
1295
1296     /**
1297      * The basic password checker for all PassUser objects.
1298      * Uses global ENCRYPTED_PASSWD and PASSWORD_LENGTH_MINIMUM.
1299      * Empty passwords are always false!
1300      * PASSWORD_LENGTH_MINIMUM is enforced here and in the preference set method.
1301      * @see UserPreferences::set
1302      *
1303      * DBPassUser password's have their own crypt definition.
1304      * That's why DBPassUser::checkPass() doesn't call this method, if 
1305      * the db password method is 'plain', which means that the DB SQL 
1306      * statement just returns 1 or 0. To use CRYPT() or PASSWORD() and 
1307      * don't store plain passwords in the DB.
1308      * 
1309      * TODO: remove crypt() function check from config.php:396 ??
1310      */
1311     function _checkPass($submitted_password, $stored_password) {
1312         if (!empty($submitted_password)) {
1313             // This works only on plaintext passwords.
1314             if (!ENCRYPTED_PASSWD and (strlen($stored_password) < PASSWORD_LENGTH_MINIMUM)) {
1315                 // With the EditMetaData plugin
1316                 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."));
1317                 return false;
1318             }
1319             if (!$this->_checkPassLength($submitted_password)) {
1320                 return false;
1321             }
1322             if (ENCRYPTED_PASSWD) {
1323                 // Verify against encrypted password.
1324                 if (function_exists('crypt')) {
1325                     if (crypt($submitted_password, $stored_password) == $stored_password )
1326                         return true; // matches encrypted password
1327                     else
1328                         return false;
1329                 }
1330                 else {
1331                     trigger_error(_("The crypt function is not available in this version of PHP.") . " "
1332                                   . _("Please set ENCRYPTED_PASSWD to false in config/config.ini and probably change ADMIN_PASSWD."),
1333                                   E_USER_WARNING);
1334                     return false;
1335                 }
1336             }
1337             else {
1338                 // Verify against cleartext password.
1339                 if ($submitted_password == $stored_password)
1340                     return true;
1341                 else {
1342                     // Check whether we forgot to enable ENCRYPTED_PASSWD
1343                     if (function_exists('crypt')) {
1344                         if (crypt($submitted_password, $stored_password) == $stored_password) {
1345                             trigger_error(_("Please set ENCRYPTED_PASSWD to true in config/config.ini."),
1346                                           E_USER_WARNING);
1347                             return true;
1348                         }
1349                     }
1350                 }
1351             }
1352         }
1353         return false;
1354     }
1355
1356     /** The default method is storing the password in prefs. 
1357      *  Child methods (DB, File) may store in external auth also, but this 
1358      *  must be explicitly enabled.
1359      *  This may be called by plugin/UserPreferences or by ->SetPreferences()
1360      */
1361     function changePass($submitted_password) {
1362         $stored_password = $this->_prefs->get('passwd');
1363         // check if authenticated
1364         if (!$this->isAuthenticated()) return false;
1365         if (ENCRYPTED_PASSWD) {
1366             $submitted_password = crypt($submitted_password);
1367         }
1368         // check other restrictions, with side-effects only.
1369         $result = $this->_checkPass($submitted_password, $stored_password);
1370         if ($stored_password != $submitted_password) {
1371             $this->_prefs->set('passwd', $submitted_password);
1372             //update the storage (session, homepage, ...)
1373             $this->SetPreferences($this->_prefs);
1374             return true;
1375         }
1376         //Todo: return an error msg to the caller what failed? 
1377         // same password or no privilege
1378         return ENCRYPTED_PASSWD ? true : false;
1379     }
1380
1381     function _tryNextPass($submitted_password) {
1382         if (DEBUG & _DEBUG_LOGIN) {
1383             $class = strtolower(get_class($this));
1384             if (substr($class,-10) == "dbpassuser") $class = "_dbpassuser";
1385             $GLOBALS['USER_AUTH_ERROR'][$class] = 'wrongpass';
1386         }
1387         if (USER_AUTH_POLICY === 'strict') {
1388             $class = $this->nextClass();
1389             if ($user = new $class($this->_userid,$this->_prefs)) {
1390                 if ($user->userExists()) {
1391                     return $user->checkPass($submitted_password);
1392                 }
1393             }
1394         }
1395         if (USER_AUTH_POLICY === 'stacked' or USER_AUTH_POLICY === 'old') {
1396             $class = $this->nextClass();
1397             if ($user = new $class($this->_userid,$this->_prefs))
1398                 return $user->checkPass($submitted_password);
1399         }
1400         return $this->_level;
1401     }
1402
1403     function _tryNextUser() {
1404         if (DEBUG & _DEBUG_LOGIN) {
1405             $class = strtolower(get_class($this));
1406             if (substr($class,-10) == "dbpassuser") $class = "_dbpassuser";
1407             $GLOBALS['USER_AUTH_ERROR'][$class] = 'nosuchuser';
1408         }
1409         if (USER_AUTH_POLICY === 'strict'
1410             or USER_AUTH_POLICY === 'stacked') {
1411             $class = $this->nextClass();
1412             while ($user = new $class($this->_userid, $this->_prefs)) {
1413                 if (!check_php_version(5))
1414                     eval("\$this = \$user;");
1415                 $user = UpgradeUser($this, $user);
1416                 if ($user->userExists()) {
1417                     $user = UpgradeUser($this, $user);
1418                     return true;
1419                 }
1420                 $class = $this->nextClass();
1421             }
1422         }
1423         return false;
1424     }
1425
1426 }
1427
1428 /**
1429  * Insert more auth classes here...
1430  * For example a customized db class for another db connection 
1431  * or a socket-based auth server.
1432  *
1433  */
1434
1435
1436 /**
1437  * For security, this class should not be extended. Instead, extend
1438  * from _PassUser (think of this as unix "root").
1439  *
1440  * FIXME: This should be a singleton class. Only ADMIN_USER may be of class AdminUser!
1441  * Other members of the Administrators group must raise their level otherwise somehow.
1442  * Currently every member is a AdminUser, which will not work for the various 
1443  * storage methods.
1444  */
1445 class _AdminUser
1446 extends _PassUser
1447 {
1448     function mayChangePass() {
1449         return false;
1450     }
1451     function checkPass($submitted_password) {
1452         if ($this->_userid == ADMIN_USER)
1453             $stored_password = ADMIN_PASSWD;
1454         else {
1455             // Should not happen! Only ADMIN_USER should use this class.
1456             // return $this->_tryNextPass($submitted_password); // ???
1457             // TODO: safety check if really member of the ADMIN group?
1458             $stored_password = $this->_pref->get('passwd');
1459         }
1460         if ($this->_checkPass($submitted_password, $stored_password)) {
1461             $this->_level = WIKIAUTH_ADMIN;
1462             if (!empty($GLOBALS['HTTP_SERVER_VARS']['PHP_AUTH_USER']) and class_exists("_HttpAuthPassUser")) {
1463                 // fake http auth
1464                 _HttpAuthPassUser::_fake_auth($this->_userid, $submitted_password);
1465             }
1466             return $this->_level;
1467         } else {
1468             return $this->_tryNextPass($submitted_password);
1469             //$this->_level = WIKIAUTH_ANON;
1470             //return $this->_level;
1471         }
1472     }
1473
1474     function storePass($submitted_password) {
1475         if ($this->_userid == ADMIN_USER)
1476             return false;
1477         else {
1478             // should not happen! only ADMIN_USER should use this class.
1479             return parent::storePass($submitted_password);
1480         }
1481     }
1482 }
1483
1484 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
1485 /**
1486  * Various data classes for the preference types, 
1487  * to support get, set, sanify (range checking, ...)
1488  * update() will do the neccessary side-effects if a 
1489  * setting gets changed (theme, language, ...)
1490 */
1491
1492 class _UserPreference
1493 {
1494     var $default_value;
1495
1496     function _UserPreference ($default_value) {
1497         $this->default_value = $default_value;
1498     }
1499
1500     function sanify ($value) {
1501         return (string)$value;
1502     }
1503
1504     function get ($name) {
1505         if (isset($this->{$name}))
1506             return $this->{$name};
1507         else 
1508             return $this->default_value;
1509     }
1510
1511     function getraw ($name) {
1512         if (!empty($this->{$name}))
1513             return $this->{$name};
1514     }
1515
1516     // stores the value as $this->$name, and not as $this->value (clever?)
1517     function set ($name, $value) {
1518         $return = 0;
1519         $value = $this->sanify($value);
1520         if ($this->get($name) != $value) {
1521             $this->update($value);
1522             $return = 1;
1523         }
1524         if ($value != $this->default_value) {
1525             $this->{$name} = $value;
1526         } else {
1527             unset($this->{$name});
1528         }
1529         return $return;
1530     }
1531
1532     // default: no side-effects 
1533     function update ($value) {
1534         ;
1535     }
1536 }
1537
1538 class _UserPreference_numeric
1539 extends _UserPreference
1540 {
1541     function _UserPreference_numeric ($default, $minval = false,
1542                                       $maxval = false) {
1543         $this->_UserPreference((double)$default);
1544         $this->_minval = (double)$minval;
1545         $this->_maxval = (double)$maxval;
1546     }
1547
1548     function sanify ($value) {
1549         $value = (double)$value;
1550         if ($this->_minval !== false && $value < $this->_minval)
1551             $value = $this->_minval;
1552         if ($this->_maxval !== false && $value > $this->_maxval)
1553             $value = $this->_maxval;
1554         return $value;
1555     }
1556 }
1557
1558 class _UserPreference_int
1559 extends _UserPreference_numeric
1560 {
1561     function _UserPreference_int ($default, $minval = false, $maxval = false) {
1562         $this->_UserPreference_numeric((int)$default, (int)$minval, (int)$maxval);
1563     }
1564
1565     function sanify ($value) {
1566         return (int)parent::sanify((int)$value);
1567     }
1568 }
1569
1570 class _UserPreference_bool
1571 extends _UserPreference
1572 {
1573     function _UserPreference_bool ($default = false) {
1574         $this->_UserPreference((bool)$default);
1575     }
1576
1577     function sanify ($value) {
1578         if (is_array($value)) {
1579             /* This allows for constructs like:
1580              *
1581              *   <input type="hidden" name="pref[boolPref][]" value="0" />
1582              *   <input type="checkbox" name="pref[boolPref][]" value="1" />
1583              *
1584              * (If the checkbox is not checked, only the hidden input
1585              * gets sent. If the checkbox is sent, both inputs get
1586              * sent.)
1587              */
1588             foreach ($value as $val) {
1589                 if ($val)
1590                     return true;
1591             }
1592             return false;
1593         }
1594         return (bool) $value;
1595     }
1596 }
1597
1598 class _UserPreference_language
1599 extends _UserPreference
1600 {
1601     function _UserPreference_language ($default = DEFAULT_LANGUAGE) {
1602         $this->_UserPreference($default);
1603     }
1604
1605     // FIXME: check for valid locale
1606     function sanify ($value) {
1607         // Revert to DEFAULT_LANGUAGE if user does not specify
1608         // language in UserPreferences or chooses <system language>.
1609         if ($value == '' or empty($value))
1610             $value = DEFAULT_LANGUAGE;
1611
1612         return (string) $value;
1613     }
1614     
1615     function update ($newvalue) {
1616         if (! $this->_init ) {
1617             // invalidate etag to force fresh output
1618             $GLOBALS['request']->setValidators(array('%mtime' => false));
1619             update_locale($newvalue ? $newvalue : $GLOBALS['LANG']);
1620         }
1621     }
1622 }
1623
1624 class _UserPreference_theme
1625 extends _UserPreference
1626 {
1627     function _UserPreference_theme ($default = THEME) {
1628         $this->_UserPreference($default);
1629     }
1630
1631     function sanify ($value) {
1632         if (!empty($value) and FindFile($this->_themefile($value)))
1633             return $value;
1634         return $this->default_value;
1635     }
1636
1637     function update ($newvalue) {
1638         global $WikiTheme;
1639         // invalidate etag to force fresh output
1640         if (! $this->_init )
1641             $GLOBALS['request']->setValidators(array('%mtime' => false));
1642         if ($newvalue)
1643             include_once($this->_themefile($newvalue));
1644         if (empty($WikiTheme))
1645             include_once($this->_themefile(THEME));
1646     }
1647
1648     function _themefile ($theme) {
1649         return "themes/$theme/themeinfo.php";
1650     }
1651 }
1652
1653 class _UserPreference_notify
1654 extends _UserPreference
1655 {
1656     function sanify ($value) {
1657         if (!empty($value))
1658             return $value;
1659         else
1660             return $this->default_value;
1661     }
1662
1663     /** update to global user prefs: side-effect on set notify changes
1664      * use a global_data notify hash:
1665      * notify = array('pagematch' => array(userid => ('email' => mail, 
1666      *                                                'verified' => 0|1),
1667      *                                     ...),
1668      *                ...);
1669      */
1670     function update ($value) {
1671         if (!empty($this->_init)) return;
1672         $dbh = $GLOBALS['request']->getDbh();
1673         $notify = $dbh->get('notify');
1674         if (empty($notify))
1675             $data = array();
1676         else 
1677             $data =& $notify;
1678         // expand to existing pages only or store matches?
1679         // for now we store (glob-style) matches which is easier for the user
1680         $pages = $this->_page_split($value);
1681         // Limitation: only current user.
1682         $user = $GLOBALS['request']->getUser();
1683         if (!$user or !method_exists($user,'UserName')) return;
1684         // This fails with php5 and a WIKI_ID cookie:
1685         $userid = $user->UserName();
1686         $email  = $user->_prefs->get('email');
1687         $verified = $user->_prefs->_prefs['email']->getraw('emailVerified');
1688         // check existing notify hash and possibly delete pages for email
1689         if (!empty($data)) {
1690             foreach ($data as $page => $users) {
1691                 if (isset($data[$page][$userid]) and !in_array($page, $pages)) {
1692                     unset($data[$page][$userid]);
1693                 }
1694                 if (count($data[$page]) == 0)
1695                     unset($data[$page]);
1696             }
1697         }
1698         // add the new pages
1699         if (!empty($pages)) {
1700             foreach ($pages as $page) {
1701                 if (!isset($data[$page]))
1702                     $data[$page] = array();
1703                 if (!isset($data[$page][$userid])) {
1704                     // should we really store the verification notice here or 
1705                     // check it dynamically at every page->save?
1706                     if ($verified) {
1707                         $data[$page][$userid] = array('email' => $email,
1708                                                       'verified' => $verified);
1709                     } else {
1710                         $data[$page][$userid] = array('email' => $email);
1711                     }
1712                 }
1713             }
1714         }
1715         // store users changes
1716         $dbh->set('notify',$data);
1717     }
1718
1719     /** split the user-given comma or whitespace delimited pagenames
1720      *  to array
1721      */
1722     function _page_split($value) {
1723         return preg_split('/[\s,]+/',$value,-1,PREG_SPLIT_NO_EMPTY);
1724     }
1725 }
1726
1727 class _UserPreference_email
1728 extends _UserPreference
1729 {
1730     function sanify($value) {
1731         // check for valid email address
1732         if ($this->get('email') == $value and $this->getraw('emailVerified'))
1733             return $value;
1734         // hack!
1735         if ($value == 1 or $value === true)
1736             return $value;
1737         list($ok,$msg) = ValidateMail($value,'noconnect');
1738         if ($ok) {
1739             return $value;
1740         } else {
1741             trigger_error("E-Mail Validation Error: ".$msg, E_USER_WARNING);
1742             return $this->default_value;
1743         }
1744     }
1745     
1746     /** Side-effect on email changes:
1747      * Send a verification mail or for now just a notification email.
1748      * For true verification (value = 2), we'd need a mailserver hook.
1749      */
1750     function update($value) {
1751         if (!empty($this->_init)) return;
1752         $verified = $this->getraw('emailVerified');
1753         // hack!
1754         if (($value == 1 or $value === true) and $verified)
1755             return;
1756         if (!empty($value) and !$verified) {
1757             list($ok,$msg) = ValidateMail($value);
1758             if ($ok and mail($value,"[".WIKI_NAME ."] "._("Email Verification"),
1759                      sprintf(_("Welcome to %s!\nYour email account is verified and\nwill be used to send page change notifications.\nSee %s"),
1760                              WIKI_NAME, WikiURL($GLOBALS['request']->getArg('pagename'),'',true)))) {
1761                 $this->set('emailVerified',1);
1762             } else {
1763                 trigger_error($msg, E_USER_WARNING);
1764             }
1765         }
1766     }
1767 }
1768
1769 /** Check for valid email address
1770     fixed version from http://www.zend.com/zend/spotlight/ev12apr.php
1771     Note: too strict, Bug #1053681
1772  */
1773 function ValidateMail($email, $noconnect=false) {
1774     global $EMailHosts;
1775     $HTTP_HOST = $GLOBALS['request']->get('HTTP_HOST');
1776
1777     // if this check is too strict (like invalid mail addresses in a local network only)
1778     // uncomment the following line:
1779     //return array(true,"not validated");
1780     // see http://sourceforge.net/tracker/index.php?func=detail&aid=1053681&group_id=6121&atid=106121
1781
1782     $result = array();
1783
1784     // This is Paul Warren's (pdw@ex-parrot.com) monster regex for RFC822
1785     // addresses, from the Perl module Mail::RFC822::Address, reduced to
1786     // accept single RFC822 addresses without comments only. (The original
1787     // accepts groups and properly commented addresses also.)
1788     $lwsp = "(?:(?:\\r\\n)?[ \\t])";
1789
1790     $specials = '()<>@,;:\\\\".\\[\\]';
1791     $controls = '\\000-\\031';
1792
1793     $dtext = "[^\\[\\]\\r\\\\]";
1794     $domain_literal = "\\[(?:$dtext|\\\\.)*\\]$lwsp*";
1795
1796     $quoted_string = "\"(?:[^\\\"\\r\\\\]|\\\\.|$lwsp)*\"$lwsp*";
1797
1798     $atom = "[^$specials $controls]+(?:$lwsp+|\\Z|(?=[\\[\"$specials]))";
1799     $word = "(?:$atom|$quoted_string)";
1800     $localpart = "$word(?:\\.$lwsp*$word)*";
1801
1802     $sub_domain = "(?:$atom|$domain_literal)";
1803     $domain = "$sub_domain(?:\\.$lwsp*$sub_domain)*";
1804
1805     $addr_spec = "$localpart\@$lwsp*$domain";
1806
1807     $phrase = "$word*";
1808     $route = "(?:\@$domain(?:,\@$lwsp*$domain)*:$lwsp*)";
1809     $route_addr = "\\<$lwsp*$route?$addr_spec\\>$lwsp*";
1810     $mailbox = "(?:$addr_spec|$phrase$route_addr)";
1811
1812     $rfc822re = "/$lwsp*$mailbox/";
1813     unset($domain, $route_addr, $route, $phrase, $addr_spec, $sub_domain, $localpart, 
1814           $atom, $word, $quoted_string);
1815     unset($dtext, $controls, $specials, $lwsp, $domain_literal);
1816
1817     if (!preg_match($rfc822re, $email)) {
1818         $result[0] = false;
1819         $result[1] = sprintf(_("E-Mail address '%s' is not properly formatted"), $email);
1820         return $result;
1821     }
1822     if ($noconnect)
1823       return array(true, sprintf(_("E-Mail address '%s' is properly formatted"), $email));
1824
1825     list ( $Username, $Domain ) = split ("@", $email);
1826     //Todo: getmxrr workaround on windows or manual input field to verify it manually
1827     if (!isWindows() and getmxrr($Domain, $MXHost)) { // avoid warning on Windows. 
1828         $ConnectAddress = $MXHost[0];
1829     } else {
1830         $ConnectAddress = $Domain;
1831         if (isset($EMailHosts[ $Domain ])) {
1832             $ConnectAddress = $EMailHosts[ $Domain ];
1833         }
1834     }
1835     $Connect = @fsockopen ( $ConnectAddress, 25 );
1836     if ($Connect) {
1837         if (ereg("^220", $Out = fgets($Connect, 1024))) {
1838             fputs ($Connect, "HELO $HTTP_HOST\r\n");
1839             $Out = fgets ( $Connect, 1024 );
1840             fputs ($Connect, "MAIL FROM: <".$email.">\r\n");
1841             $From = fgets ( $Connect, 1024 );
1842             fputs ($Connect, "RCPT TO: <".$email.">\r\n");
1843             $To = fgets ($Connect, 1024);
1844             fputs ($Connect, "QUIT\r\n");
1845             fclose($Connect);
1846             if (!ereg ("^250", $From)) {
1847                 $result[0]=false;
1848                 $result[1]="Server rejected address: ". $From;
1849                 return $result;
1850             }
1851             if (!ereg ( "^250", $To )) {
1852                 $result[0]=false;
1853                 $result[1]="Server rejected address: ". $To;
1854                 return $result;
1855             }
1856         } else {
1857             $result[0] = false;
1858             $result[1] = "No response from server";
1859             return $result;
1860           }
1861     }  else {
1862         $result[0]=false;
1863         $result[1]="Can not connect E-Mail server.";
1864         return $result;
1865     }
1866     $result[0]=true;
1867     $result[1]="E-Mail address '$email' appears to be valid.";
1868     return $result;
1869 } // end of function 
1870
1871 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
1872
1873 /**
1874  * UserPreferences
1875  * 
1876  * This object holds the $request->_prefs subobjects.
1877  * A simple packed array of non-default values get's stored as cookie,
1878  * homepage, or database, which are converted to the array of 
1879  * ->_prefs objects.
1880  * We don't store the objects, because otherwise we will
1881  * not be able to upgrade any subobject. And it's a waste of space also.
1882  *
1883  */
1884 class UserPreferences
1885 {
1886     function UserPreferences($saved_prefs = false) {
1887         // userid stored too, to ensure the prefs are being loaded for
1888         // the correct (currently signing in) userid if stored in a
1889         // cookie.
1890         // Update: for db prefs we disallow passwd. 
1891         // userid is needed for pref reflexion. current pref must know its username, 
1892         // if some app needs prefs from different users, different from current user.
1893         $this->_prefs
1894             = array(
1895                     'userid'        => new _UserPreference(''),
1896                     'passwd'        => new _UserPreference(''),
1897                     'autologin'     => new _UserPreference_bool(),
1898                     //'emailVerified' => new _UserPreference_emailVerified(), 
1899                     //fixed: store emailVerified as email parameter, 1.3.8
1900                     'email'         => new _UserPreference_email(''),
1901                     'notifyPages'   => new _UserPreference_notify(''), // 1.3.8
1902                     'theme'         => new _UserPreference_theme(THEME),
1903                     'lang'          => new _UserPreference_language(DEFAULT_LANGUAGE),
1904                     'editWidth'     => new _UserPreference_int(EDITWIDTH_DEFAULT_COLS,
1905                                                                EDITWIDTH_MIN_COLS,
1906                                                                EDITWIDTH_MAX_COLS),
1907                     'noLinkIcons'   => new _UserPreference_bool(),    // 1.3.8 
1908                     'editHeight'    => new _UserPreference_int(EDITHEIGHT_DEFAULT_ROWS,
1909                                                                EDITHEIGHT_MIN_ROWS,
1910                                                                EDITHEIGHT_MAX_ROWS),
1911                     'timeOffset'    => new _UserPreference_numeric(TIMEOFFSET_DEFAULT_HOURS,
1912                                                                    TIMEOFFSET_MIN_HOURS,
1913                                                                    TIMEOFFSET_MAX_HOURS),
1914                     'relativeDates' => new _UserPreference_bool(),
1915                     'googleLink'    => new _UserPreference_bool(), // 1.3.10
1916                     'doubleClickEdit' => new _UserPreference_bool(), // 1.3.11
1917                     );
1918         // add custom theme-specific pref types:
1919         // FIXME: on theme changes the wiki_user session pref object will fail. 
1920         // We will silently ignore this.
1921         if (!empty($customUserPreferenceColumns))
1922             $this->_prefs = array_merge($this->_prefs, $customUserPreferenceColumns);
1923 /*
1924         if (isset($this->_method) and $this->_method == 'SQL') {
1925             //unset($this->_prefs['userid']);
1926             unset($this->_prefs['passwd']);
1927         }
1928 */
1929         if (is_array($saved_prefs)) {
1930             foreach ($saved_prefs as $name => $value)
1931                 $this->set($name, $value);
1932         }
1933     }
1934
1935     function _getPref($name) {
1936         if ($name == 'emailVerified')
1937             $name = 'email';
1938         if (!isset($this->_prefs[$name])) {
1939             if ($name == 'passwd2') return false;
1940             if ($name == 'passwd') return false;
1941             trigger_error("$name: unknown preference", E_USER_NOTICE);
1942             return false;
1943         }
1944         return $this->_prefs[$name];
1945     }
1946     
1947     // get the value or default_value of the subobject
1948     function get($name) {
1949         if ($_pref = $this->_getPref($name))
1950             if ($name == 'emailVerified')
1951                 return $_pref->getraw($name);
1952             else
1953                 return $_pref->get($name);
1954         else
1955             return false;  
1956     }
1957
1958     // check and set the new value in the subobject
1959     function set($name, $value) {
1960         $pref = $this->_getPref($name);
1961         if ($pref === false)
1962             return false;
1963
1964         /* do it here or outside? */
1965         if ($name == 'passwd' and 
1966             defined('PASSWORD_LENGTH_MINIMUM') and 
1967             strlen($value) <= PASSWORD_LENGTH_MINIMUM ) {
1968             //TODO: How to notify the user?
1969             return false;
1970         }
1971         /*
1972         if ($name == 'theme' and $value == '')
1973            return true;
1974         */
1975         // Fix Fatal error for undefined value. Thanks to Jim Ford and Joel Schaubert
1976         if ((!$value and $pref->default_value)
1977             or ($value and !isset($pref->{$name})) // bug #1355533
1978             or ($value and ($pref->{$name} != $pref->default_value)))
1979         {
1980             if ($name == 'emailVerified') $newvalue = $value;
1981             else $newvalue = $pref->sanify($value);
1982             $pref->set($name, $newvalue);
1983         }
1984         $this->_prefs[$name] =& $pref;
1985         return true;
1986     }
1987     /**
1988      * use init to avoid update on set
1989      */
1990     function updatePrefs($prefs, $init = false) {
1991         $count = 0;
1992         if ($init) $this->_init = $init;
1993         if (is_object($prefs)) {
1994             $type = 'emailVerified'; $obj =& $this->_prefs['email'];
1995             $obj->_init = $init;
1996             if ($obj->get($type) !== $prefs->get($type)) {
1997                 if ($obj->set($type, $prefs->get($type)))
1998                     $count++;
1999             }
2000             foreach (array_keys($this->_prefs) as $type) {
2001                 $obj =& $this->_prefs[$type];
2002                 $obj->_init = $init;
2003                 if ($prefs->get($type) !== $obj->get($type)) {
2004                     // special systemdefault prefs: (probably not needed)
2005                     if ($type == 'theme' and $prefs->get($type) == '' and 
2006                         $obj->get($type) == THEME) continue;
2007                     if ($type == 'lang' and $prefs->get($type) == '' and 
2008                         $obj->get($type) == DEFAULT_LANGUAGE) continue;
2009                     if ($this->_prefs[$type]->set($type, $prefs->get($type)))
2010                         $count++;
2011                 }
2012             }
2013         } elseif (is_array($prefs)) {
2014             //unset($this->_prefs['userid']);
2015             /*
2016             if (isset($this->_method) and 
2017                  ($this->_method == 'SQL' or $this->_method == 'ADODB')) {
2018                 unset($this->_prefs['passwd']);
2019             }
2020             */
2021             // emailVerified at first, the rest later
2022             $type = 'emailVerified'; $obj =& $this->_prefs['email'];
2023             $obj->_init = $init;
2024             if (isset($prefs[$type]) and $obj->get($type) !== $prefs[$type]) {
2025                 if ($obj->set($type,$prefs[$type]))
2026                     $count++;
2027             }
2028             foreach (array_keys($this->_prefs) as $type) {
2029                 $obj =& $this->_prefs[$type];
2030                 $obj->_init = $init;
2031                 if (!isset($prefs[$type]) and isa($obj,"_UserPreference_bool")) 
2032                     $prefs[$type] = false;
2033                 if (isset($prefs[$type]) and isa($obj,"_UserPreference_int"))
2034                     $prefs[$type] = (int) $prefs[$type];
2035                 if (isset($prefs[$type]) and $obj->get($type) != $prefs[$type]) {
2036                     // special systemdefault prefs:
2037                     if ($type == 'theme' and $prefs[$type] == '' and 
2038                         $obj->get($type) == THEME) continue;
2039                     if ($type == 'lang' and $prefs[$type] == '' and 
2040                         $obj->get($type) == DEFAULT_LANGUAGE) continue;
2041                     if ($obj->set($type,$prefs[$type]))
2042                         $count++;
2043                 }
2044             }
2045         }
2046         return $count;
2047     }
2048
2049     // For now convert just array of objects => array of values
2050     // Todo: the specialized subobjects must override this.
2051     function store() {
2052         $prefs = array();
2053         foreach ($this->_prefs as $name => $object) {
2054             if ($value = $object->getraw($name))
2055                 $prefs[$name] = $value;
2056             if ($name == 'email' and ($value = $object->getraw('emailVerified')))
2057                 $prefs['emailVerified'] = $value;
2058             if ($name == 'passwd' and $value and ENCRYPTED_PASSWD) {
2059                 if (strlen($value) != strlen(crypt('test')))
2060                     $prefs['passwd'] = crypt($value);
2061                 else // already crypted
2062                     $prefs['passwd'] = $value;
2063             }
2064         }
2065         return $this->pack($prefs);
2066     }
2067
2068     // packed string or array of values => array of values
2069     // Todo: the specialized subobjects must override this.
2070     function retrieve($packed) {
2071         if (is_string($packed) and (substr($packed, 0, 2) == "a:"))
2072             $packed = unserialize($packed);
2073         if (!is_array($packed)) return false;
2074         $prefs = array();
2075         foreach ($packed as $name => $packed_pref) {
2076             if (is_string($packed_pref) 
2077                 and isSerialized($packed_pref) 
2078                 and substr($packed_pref, 0, 2) == "O:") 
2079             {
2080                 //legacy: check if it's an old array of objects
2081                 // Looks like a serialized object. 
2082                 // This might fail if the object definition does not exist anymore.
2083                 // object with ->$name and ->default_value vars.
2084                 $pref =  @unserialize($packed_pref);
2085                 if (is_object($pref))
2086                     $prefs[$name] = $pref->get($name);
2087             // fix old-style prefs
2088             } elseif (is_numeric($name) and is_array($packed_pref)) {
2089                 if (count($packed_pref) == 1) {
2090                     list($name,$value) = each($packed_pref);
2091                     $prefs[$name] = $value;
2092                 }
2093             } else {
2094                 if (isSerialized($packed_pref))
2095                     $prefs[$name] = @unserialize($packed_pref);
2096                 if (empty($prefs[$name]) and isSerialized(base64_decode($packed_pref)))
2097                     $prefs[$name] = @unserialize(base64_decode($packed_pref));
2098                 // patched by frederik@pandora.be
2099                 if (empty($prefs[$name]))
2100                     $prefs[$name] = $packed_pref;
2101             }
2102         }
2103         return $prefs;
2104     }
2105
2106     /**
2107      * Check if the given prefs object is different from the current prefs object
2108      */
2109     function isChanged($other) {
2110         foreach ($this->_prefs as $type => $obj) {
2111             if ($obj->get($type) !== $other->get($type))
2112                 return true;
2113         }
2114         return false;
2115     }
2116
2117     function defaultPreferences() {
2118         $prefs = array();
2119         foreach ($this->_prefs as $key => $obj) {
2120             $prefs[$key] = $obj->default_value;
2121         }
2122         return $prefs;
2123     }
2124     
2125     // array of objects
2126     function getAll() {
2127         return $this->_prefs;
2128     }
2129
2130     function pack($nonpacked) {
2131         return serialize($nonpacked);
2132     }
2133
2134     function unpack($packed) {
2135         if (!$packed)
2136             return false;
2137         //$packed = base64_decode($packed);
2138         if (substr($packed, 0, 2) == "O:") {
2139             // Looks like a serialized object
2140             return unserialize($packed);
2141         }
2142         if (substr($packed, 0, 2) == "a:") {
2143             return unserialize($packed);
2144         }
2145         //trigger_error("DEBUG: Can't unpack bad UserPreferences",
2146         //E_USER_WARNING);
2147         return false;
2148     }
2149
2150     function hash () {
2151         return wikihash($this->_prefs);
2152     }
2153 }
2154
2155 /** TODO: new pref storage classes
2156  *  These are currently user specific and should be rewritten to be pref specific.
2157  *  i.e. $this == $user->_prefs
2158  */
2159 /*
2160 class CookieUserPreferences
2161 extends UserPreferences
2162 {
2163     function CookieUserPreferences ($saved_prefs = false) {
2164         //_AnonUser::_AnonUser('',$saved_prefs);
2165         UserPreferences::UserPreferences($saved_prefs);
2166     }
2167 }
2168
2169 class PageUserPreferences
2170 extends UserPreferences
2171 {
2172     function PageUserPreferences ($saved_prefs = false) {
2173         UserPreferences::UserPreferences($saved_prefs);
2174     }
2175 }
2176
2177 class PearDbUserPreferences
2178 extends UserPreferences
2179 {
2180     function PearDbUserPreferences ($saved_prefs = false) {
2181         UserPreferences::UserPreferences($saved_prefs);
2182     }
2183 }
2184
2185 class AdoDbUserPreferences
2186 extends UserPreferences
2187 {
2188     function AdoDbUserPreferences ($saved_prefs = false) {
2189         UserPreferences::UserPreferences($saved_prefs);
2190     }
2191     function getPreferences() {
2192         // override the generic slow method here for efficiency
2193         _AnonUser::getPreferences();
2194         $this->getAuthDbh();
2195         if (isset($this->_select)) {
2196             $dbh = & $this->_auth_dbi;
2197             $rs = $dbh->Execute(sprintf($this->_select,$dbh->qstr($this->_userid)));
2198             if ($rs->EOF) {
2199                 $rs->Close();
2200             } else {
2201                 $prefs_blob = $rs->fields['pref_blob'];
2202                 $rs->Close();
2203                 if ($restored_from_db = $this->_prefs->retrieve($prefs_blob)) {
2204                     $updated = $this->_prefs->updatePrefs($restored_from_db);
2205                     //$this->_prefs = new UserPreferences($restored_from_db);
2206                     return $this->_prefs;
2207                 }
2208             }
2209         }
2210         if (empty($this->_prefs->_prefs) and $this->_HomePagehandle) {
2211             if ($restored_from_page = $this->_prefs->retrieve
2212                 ($this->_HomePagehandle->get('pref'))) {
2213                 $updated = $this->_prefs->updatePrefs($restored_from_page);
2214                 //$this->_prefs = new UserPreferences($restored_from_page);
2215                 return $this->_prefs;
2216             }
2217         }
2218         return $this->_prefs;
2219     }
2220 }
2221 */
2222
2223 // Local Variables:
2224 // mode: php
2225 // tab-width: 8
2226 // c-basic-offset: 4
2227 // c-hanging-comment-ender-p: nil
2228 // indent-tabs-mode: nil
2229 // End:
2230 ?>