Minor cleanup, non-functional
[Packages/TYPO3.CMS.git] / t3lib / class.t3lib_userauth.php
1 <?php
2 /***************************************************************
3 * Copyright notice
4 *
5 * (c) 1999-2006 Kasper Skaarhoj (kasperYYYY@typo3.com)
6 * All rights reserved
7 *
8 * This script is part of the TYPO3 project. The TYPO3 project is
9 * free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
13 *
14 * The GNU General Public License can be found at
15 * http://www.gnu.org/copyleft/gpl.html.
16 * A copy is found in the textfile GPL.txt and important notices to the license
17 * from the author is found in LICENSE.txt distributed with these scripts.
18 *
19 *
20 * This script is distributed in the hope that it will be useful,
21 * but WITHOUT ANY WARRANTY; without even the implied warranty of
22 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23 * GNU General Public License for more details.
24 *
25 * This copyright notice MUST APPEAR in all copies of the script!
26 ***************************************************************/
27 /**
28 * Contains a base class for authentication of users in TYPO3, both frontend and backend.
29 *
30 * $Id$
31 * Revised for TYPO3 3.6 July/2003 by Kasper Skaarhoj
32 *
33 * @author Kasper Skaarhoj <kasperYYYY@typo3.com>
34 * @author René Fritz <r.fritz@colorcube.de>
35 */
36 /**
37 * [CLASS/FUNCTION INDEX of SCRIPT]
38 *
39 *
40 *
41 * 111: class t3lib_userAuth
42 * 195: function start()
43 * 329: function checkAuthentication()
44 *
45 * SECTION: User Sessions
46 * 569: function createUserSession ($tempuser)
47 * 606: function fetchUserSession()
48 * 657: function logoff()
49 *
50 * SECTION: SQL Functions
51 * 713: function user_where_clause()
52 * 727: function ipLockClause()
53 * 745: function ipLockClause_remoteIPNumber($parts)
54 * 766: function hashLockClause()
55 * 777: function hashLockClause_getHashInt()
56 *
57 * SECTION: Session and Configuration Handling
58 * 809: function writeUC($variable='')
59 * 824: function unpack_uc($theUC='')
60 * 840: function pushModuleData($module,$data,$noSave=0)
61 * 853: function getModuleData($module,$type='')
62 * 866: function getSessionData($key)
63 * 879: function setAndSaveSessionData($key,$data)
64 *
65 * SECTION: Misc
66 * 912: function getLoginFormData()
67 * 939: function processLoginData($loginData, $security_level='')
68 * 981: function getAuthInfoArray()
69 * 1011: function compareUident($user, $loginData, $security_level='')
70 * 1050: function gc()
71 * 1064: function redirect()
72 * 1086: function writelog($type,$action,$error,$details_nr,$details,$data,$tablename,$recuid,$recpid)
73 * 1095: function checkLogFailures()
74 * 1108: function setBeUserByUid($uid)
75 * 1120: function setBeUserByName($name)
76 * 1131: function getRawUserByUid($uid)
77 * 1149: function getRawUserByName($name)
78 *
79 * SECTION: Create/update user - EXPERIMENTAL
80 * 1188: function fetchUserRecord($dbUser, $username, $extraWhere='' )
81 *
82 * TOTAL FUNCTIONS: 29
83 * (This index is automatically created/updated by the extension "extdeveval")
84 *
85 */
86
87
88 require_once(t3lib_extMgm::extPath('sv').'class.tx_sv_authbase.php');
89
90
91
92
93
94
95
96
97
98 /**
99 * Authentication of users in TYPO3
100 *
101 * This class is used to authenticate a login user.
102 * The class is used by both the frontend and backend. In both cases this class is a parent class to beuserauth and feuserauth
103 *
104 * See Inside TYPO3 for more information about the API of the class and internal variables.
105 *
106 * @author Kasper Skaarhoj <kasperYYYY@typo3.com>
107 * @author René Fritz <r.fritz@colorcube.de>
108 * @package TYPO3
109 * @subpackage t3lib
110 */
111 class t3lib_userAuth {
112 var $global_database = ''; // Which global database to connect to
113 var $session_table = ''; // Table to use for session data.
114 var $name = ''; // Session/Cookie name
115 var $get_name = ''; // Session/GET-var name
116
117 var $user_table = ''; // Table in database with userdata
118 var $username_column = ''; // Column for login-name
119 var $userident_column = ''; // Column for password
120 var $userid_column = ''; // Column for user-id
121 var $lastLogin_column = '';
122
123 var $enablecolumns = Array (
124 'rootLevel' => '', // Boolean: If true, 'AND pid=0' will be a part of the query...
125 'disabled' => '',
126 'starttime' => '',
127 'endtime' => '',
128 'deleted' => ''
129 );
130
131 var $formfield_uname = ''; // formfield with login-name
132 var $formfield_uident = ''; // formfield with password
133 var $formfield_chalvalue = ''; // formfield with a unique value which is used to encrypt the password and username
134 var $formfield_status = ''; // formfield with status: *'login', 'logout'. If empty login is not verified.
135 var $security_level = 'normal'; // sets the level of security. *'normal' = clear-text. 'challenged' = hashed password/username from form in $formfield_uident. 'superchallenged' = hashed password hashed again with username.
136
137 var $auth_include = ''; // this is the name of the include-file containing the login form. If not set, login CAN be anonymous. If set login IS needed.
138
139 var $auth_timeout_field = 0; // Server session lifetime. If > 0: session-timeout in seconds. If false or <0: no timeout. If string: The string is a fieldname from the usertable where the timeout can be found.
140 var $lifetime = 0; // Client session lifetime. 0 = Session-cookies. If session-cookies, the browser will stop the session when the browser is closed. Otherwise this specifies the lifetime of a cookie that keeps the session.
141 var $gc_time = 0; // GarbageCollection. Purge all server session data older than $gc_time seconds. 0 = default to $this->timeout or use 86400 seconds (1 day) if $this->lifetime is 0
142 var $gc_probability = 1; // Possibility (in percent) for GarbageCollection to be run.
143 var $writeStdLog = FALSE; // Decides if the writelog() function is called at login and logout
144 var $writeAttemptLog = FALSE; // If the writelog() functions is called if a login-attempt has be tried without success
145 var $sendNoCacheHeaders = TRUE; // If this is set, headers is sent to assure, caching is NOT done
146 var $getFallBack = FALSE; // If this is set, authentication is also accepted by the $_GET. Notice that the identification is NOT 128bit MD5 hash but reduced. This is done in order to minimize the size for mobile-devices, such as WAP-phones
147 var $hash_length = 32; // The ident-hash is normally 32 characters and should be! But if you are making sites for WAP-devices og other lowbandwidth stuff, you may shorten the length. Never let this value drop below 6. A length of 6 would give you more than 16 mio possibilities.
148 var $getMethodEnabled = FALSE; // Setting this flag true lets user-authetication happen from GET_VARS if POST_VARS are not set. Thus you may supply username/password from the URL.
149 var $lockIP = 4; // If set, will lock the session to the users IP address (all four numbers. Reducing to 1-3 means that only first, second or third part of the IP address is used).
150 var $lockHashKeyWords = 'useragent'; // Keyword list (commalist with no spaces!): "useragent". Each keyword indicates some information that can be included in a integer hash made to lock down usersessions.
151
152 var $warningEmail = ''; // warning -emailaddress:
153 var $warningPeriod = 3600; // Period back in time (in seconds) in which number of failed logins are collected
154 var $warningMax = 3; // The maximum accepted number of warnings before an email is sent
155 var $checkPid = TRUE; // If set, the user-record must $checkPid_value as pid
156 var $checkPid_value=0; // The pid, the user-record must have as page-id
157
158 // Internals
159 var $id; // Internal: Will contain session_id (MD5-hash)
160 var $cookieId; // Internal: Will contain the session_id gotten from cookie or GET method. This is used in statistics as a reliable cookie (one which is known to come from $_COOKIE).
161 var $loginFailure = FALSE; // Indicates if an authentication was started but failed
162 var $loginSessionStarted = FALSE; // Will be set to true if the login session is actually written during auth-check.
163
164 var $user; // Internal: Will contain user- AND session-data from database (joined tables)
165 var $get_URL_ID = ''; // Internal: Will will be set to the url--ready (eg. '&login=ab7ef8d...') GET-auth-var if getFallBack is true. Should be inserted in links!
166
167 var $newSessionID = FALSE; // Will be set to true if a new session ID was created
168 var $forceSetCookie = FALSE; // Will force the session cookie to be set everytime (lifetime must be 0)
169 var $dontSetCookie = FALSE; // Will prevent the setting of the session cookie (takes precedence over forceSetCookie)
170 var $challengeStoredInCookie = FALSE; // If set, the challenge value will be stored in a session as well so the server can check that is was not forged.
171 var $loginType = ''; // Login type, used for services.
172
173 var $svConfig = array(); // "auth" services configuration array from $TYPO3_CONF_VARS['SVCONF']['auth']
174 var $writeDevLog = FALSE; // write messages into the devlog?
175
176
177
178
179
180
181
182
183
184 /**
185 * Starts a user session
186 * Typical configurations will:
187 * a) check if session cookie was set and if not, set one,
188 * b) check if a password/username was sent and if so, try to authenticate the user
189 * c) Lookup a session attached to a user and check timeout etc.
190 * d) Garbage collection, setting of no-cache headers.
191 * If a user is authenticated the database record of the user (array) will be set in the ->user internal variable.
192 *
193 * @return void
194 */
195 function start() {
196 global $TYPO3_CONF_VARS;
197
198 // backend or frontend login - used for auth services
199 $this->loginType = ($this->name=='fe_typo_user') ? 'FE' : 'BE';
200
201 // set level to normal if not already set
202 $this->security_level = $this->security_level ? $this->security_level : 'normal';
203
204 // enable dev logging if set
205 if ($TYPO3_CONF_VARS['SC_OPTIONS']['t3lib/class.t3lib_userauth.php']['writeDevLog']) $this->writeDevLog = TRUE;
206 if ($TYPO3_CONF_VARS['SC_OPTIONS']['t3lib/class.t3lib_userauth.php']['writeDevLog'.$this->loginType]) $this->writeDevLog = TRUE;
207 if (TYPO3_DLOG) $this->writeDevLog = TRUE;
208
209 if ($this->writeDevLog) t3lib_div::devLog('## Beginning of auth logging.', 't3lib_userAuth');
210
211 // Init vars.
212 $mode = '';
213 $this->newSessionID = FALSE;
214 // $id is set to ses_id if cookie is present. Else set to false, which will start a new session
215 $id = isset($_COOKIE[$this->name]) ? stripslashes($_COOKIE[$this->name]) : '';
216 $this->hash_length = t3lib_div::intInRange($this->hash_length,6,32);
217 $this->svConfig = $TYPO3_CONF_VARS['SVCONF']['auth'];
218
219
220 // If fallback to get mode....
221 if (!$id && $this->getFallBack && $this->get_name) {
222 $id = isset($_GET[$this->get_name]) ? t3lib_div::_GET($this->get_name) : '';
223 if (strlen($id)!=$this->hash_length) $id='';
224 $mode='get';
225 }
226 $this->cookieId = $id;
227
228 // If new session...
229 if (!$id) {
230 // New random session-$id is made
231 $id = substr(md5(uniqid('').getmypid()),0,$this->hash_length);
232 // New session
233 $this->newSessionID = TRUE;
234 }
235
236 // Internal var 'id' is set
237 $this->id = $id;
238
239 // If fallback to get mode....
240 if ($mode=='get' && $this->getFallBack && $this->get_name) {
241 $this->get_URL_ID = '&'.$this->get_name.'='.$id;
242 }
243 // Make certain that NO user is set initially
244 $this->user = '';
245
246 // Check to see if anyone has submitted login-information and if so register the user with the session. $this->user[uid] may be used to write log...
247 $this->checkAuthentication();
248
249 // Make certain that NO user is set initially. ->check_authentication may have set a session-record which will provide us with a user record in the next section:
250 unset($this->user);
251
252 // re-read user session
253 $this->user = $this->fetchUserSession();
254
255 if ($this->writeDevLog && is_array($this->user)) t3lib_div::devLog('User session finally read: '.t3lib_div::arrayToLogString($this->user, array($this->userid_column,$this->username_column)), 't3lib_userAuth', -1);
256 if ($this->writeDevLog && !is_array($this->user)) t3lib_div::devLog('No user session found.', 't3lib_userAuth', 2);
257
258 // Setting cookies
259 if ($TYPO3_CONF_VARS['SYS']['cookieDomain']) {
260 if ($TYPO3_CONF_VARS['SYS']['cookieDomain']{0} == '/') {
261 $matchCnt = @preg_match($TYPO3_CONF_VARS['SYS']['cookieDomain'], t3lib_div::getIndpEnv('TYPO3_HOST_ONLY'), $match);
262 if ($matchCnt === FALSE) {
263 t3lib_div::sysLog('The regular expression of $TYPO3_CONF_VARS[SYS][cookieDomain] contains errors. The session is not shared across sub-domains.', 'Core', 3);
264 } elseif ($matchCnt) {
265 $cookieDomain = $match[0];
266 }
267 } else {
268 $cookieDomain = $TYPO3_CONF_VARS['SYS']['cookieDomain'];
269 }
270 }
271
272 // If new session and the cookie is a sessioncookie, we need to set it only once!
273 if ($this->isSetSessionCookie()) {
274 if (!$this->dontSetCookie) {
275 if ($cookieDomain) {
276 SetCookie($this->name, $id, 0, '/', $cookieDomain);
277 } else {
278 SetCookie($this->name, $id, 0, '/');
279 }
280 if ($this->writeDevLog) t3lib_div::devLog('Set new Cookie: '.$id.($cookieDomain ? ', '.$cookieDomain : ''), 't3lib_userAuth');
281 }
282 }
283
284 // If it is NOT a session-cookie, we need to refresh it.
285 if ($this->isRefreshTimeBasedCookie()) {
286 if (!$this->dontSetCookie) {
287 if ($cookieDomain) {
288 SetCookie($this->name, $id, time()+$this->lifetime, '/', $cookieDomain);
289 } else {
290 SetCookie($this->name, $id, time()+$this->lifetime, '/');
291 }
292 if ($this->writeDevLog) t3lib_div::devLog('Update Cookie: '.$id.($cookieDomain ? ', '.$cookieDomain : ''), 't3lib_userAuth');
293 }
294 }
295
296 // Hook for alternative ways of filling the $this->user array (is used by the "timtaw" extension)
297 if (is_array($TYPO3_CONF_VARS['SC_OPTIONS']['t3lib/class.t3lib_userauth.php']['postUserLookUp'])) {
298 foreach ($TYPO3_CONF_VARS['SC_OPTIONS']['t3lib/class.t3lib_userauth.php']['postUserLookUp'] as $funcName) {
299 $_params = array(
300 'pObj' => &$this,
301 );
302 t3lib_div::callUserFunction($funcName,$_params,$this);
303 }
304 }
305
306 // If any redirection (inclusion of file) then it will happen in this function
307 $this->redirect();
308
309 // Set all posible headers that could ensure that the script is not cached on the client-side
310 if ($this->sendNoCacheHeaders) {
311 header('Expires: 0');
312 header('Last-Modified: ' . gmdate('D, d M Y H:i:s') . ' GMT');
313 header('Cache-Control: no-cache, must-revalidate');
314 header('Pragma: no-cache');
315 }
316
317 // Set $this->gc_time if not explicitely specified
318 if ($this->gc_time==0) {
319 $this->gc_time = ($this->auth_timeout_field==0 ? 86400 : $this->auth_timeout_field); // Default to 1 day if $this->auth_timeout_field is 0
320 }
321
322 // If we're lucky we'll get to clean up old sessions....
323 if ((rand()%100) <= $this->gc_probability) {
324 $this->gc();
325 }
326 }
327
328 /**
329 * Determins whether a session cookie needs to be set (lifetime=0)
330 *
331 * @return boolean
332 * @internal
333 */
334 function isSetSessionCookie() {
335 return ($this->newSessionID || $this->forceSetCookie) && $this->lifetime==0;
336 }
337
338 /**
339 * Determins whether a non-session cookie needs to be set (lifetime>0)
340 *
341 * @return boolean
342 * @internal
343 */
344 function isRefreshTimeBasedCookie() {
345 return $this->lifetime > 0;
346 }
347
348 /**
349 * Checks if a submission of username and password is present or use other authentication by auth services
350 *
351 * @return void
352 * @internal
353 */
354 function checkAuthentication() {
355
356 // No user for now - will be searched by service below
357 $tempuserArr = array();
358 $tempuser = FALSE;
359
360 // User is not authenticated by default
361 $authenticated = FALSE;
362
363 // User want to login with passed login data (name/password)
364 $activeLogin = FALSE;
365
366 // Indicates if an active authentication failed (not auto login)
367 $this->loginFailure = FALSE;
368
369 if ($this->writeDevLog) t3lib_div::devLog('Login type: '.$this->loginType, 't3lib_userAuth');
370
371 // The info array provide additional information for auth services
372 $authInfo = $this->getAuthInfoArray();
373
374 // Get Login/Logout data submitted by a form or params
375 $loginData = $this->getLoginFormData();
376
377 if ($this->writeDevLog) t3lib_div::devLog('Login data: '.t3lib_div::arrayToLogString($loginData), 't3lib_userAuth');
378
379
380 // active logout (eg. with "logout" button)
381 if ($loginData['status']=='logout') {
382 if ($this->writeStdLog) $this->writelog(255,2,0,2,'User %s logged out',Array($this->user['username'])); // Logout written to log
383 if ($this->writeDevLog) t3lib_div::devLog('User logged out. Id: '.$this->id, 't3lib_userAuth', -1);
384
385 $this->logoff();
386 }
387
388 // active login (eg. with login form)
389 if ($loginData['status']=='login') {
390 $activeLogin = TRUE;
391
392 if ($this->writeDevLog) t3lib_div::devLog('Active login (eg. with login form)', 't3lib_userAuth');
393
394 // check referer for submitted login values
395 if ($this->formfield_status && $loginData['uident'] && $loginData['uname']) {
396 $httpHost = t3lib_div::getIndpEnv('TYPO3_HOST_ONLY');
397 if (!$this->getMethodEnabled && ($httpHost!=$authInfo['refInfo']['host'] && !$GLOBALS['TYPO3_CONF_VARS']['SYS']['doNotCheckReferer'])) {
398 die('Error: This host address ("'.$httpHost.'") and the referer host ("'.$authInfo['refInfo']['host'].'") mismatches!<br />
399 It\'s possible that the environment variable HTTP_REFERER is not passed to the script because of a proxy.<br />
400 The site administrator can disable this check in the "All Configuration" section of the Install Tool (flag: TYPO3_CONF_VARS[SYS][doNotCheckReferer]).');
401 }
402
403 // delete old user session if any
404 $this->logoff();
405 }
406
407 // Refuse login for _CLI users (used by commandline scripts)
408 if ((strtoupper(substr($loginData['uname'],0,5))=='_CLI_') && (!defined('TYPO3_cliMode') || !TYPO3_cliMode)) { // although TYPO3_cliMode should never be set when using active login...
409 die('Error: You have tried to login using a CLI user. Access prohibited!');
410 }
411 }
412
413
414 // the following code makes auto-login possible (if configured). No submitted data needed
415
416 // re-read user session
417 $authInfo['userSession'] = $this->fetchUserSession();
418 $haveSession = is_array($authInfo['userSession']) ? TRUE : FALSE;
419
420 if ($this->writeDevLog) {
421 if ($haveSession) {
422 t3lib_div::devLog('User session found: '.t3lib_div::arrayToLogString($authInfo['userSession'], array($this->userid_column,$this->username_column)), 't3lib_userAuth', 0);
423 }
424 t3lib_div::devLog('SV setup: '.t3lib_div::arrayToLogString($this->svConfig['setup']), 't3lib_userAuth', 0);
425 }
426
427 // fetch user if ...
428 if ($activeLogin
429 || (!$haveSession && $this->svConfig['setup'][$this->loginType.'_fetchUserIfNoSession'])
430 || $this->svConfig['setup'][$this->loginType.'_alwaysFetchUser']) {
431
432 // use 'auth' service to find the user
433 // first found user will be used
434 $serviceChain = '';
435 $subType = 'getUser'.$this->loginType;
436 while (is_object($serviceObj = t3lib_div::makeInstanceService('auth', $subType, $serviceChain))) {
437 $serviceChain.=','.$serviceObj->getServiceKey();
438 $serviceObj->initAuth($subType, $loginData, $authInfo, $this);
439 if ($row=$serviceObj->getUser()) {
440 $tempuserArr[] = $row;
441
442 if ($this->writeDevLog) t3lib_div::devLog('User found: '.t3lib_div::arrayToLogString($row, array($this->userid_column,$this->username_column)), 't3lib_userAuth', 0);
443
444 // user found, just stop to search for more if not configured to go on
445 if(!$this->svConfig['setup'][$this->loginType.'_fetchAllUsers']) {
446 break;
447 }
448 }
449 unset($serviceObj);
450 }
451 unset($serviceObj);
452
453 if ($this->writeDevLog && $this->svConfig['setup'][$this->loginType.'_alwaysFetchUser']) t3lib_div::devLog($this->loginType.'_alwaysFetchUser option is enabled', 't3lib_userAuth');
454 if ($this->writeDevLog && $serviceChain) t3lib_div::devLog($subType.' auth services called: '.$serviceChain, 't3lib_userAuth');
455 if ($this->writeDevLog && !count($tempuserArr)) t3lib_div::devLog('No user found by services', 't3lib_userAuth');
456 if ($this->writeDevLog && count($tempuserArr)) t3lib_div::devLog(count($tempuserArr).' user records found by services', 't3lib_userAuth');
457 }
458
459
460 // If no new user was set we use the already found user session
461 if (!count($tempuserArr) && $haveSession) {
462 $tempuserArr[] = $authInfo['userSession'];
463 $tempuser = $authInfo['userSession'];
464 // User is authenticated because we found a user session
465 $authenticated = TRUE;
466
467 if ($this->writeDevLog) t3lib_div::devLog('User session used: '.t3lib_div::arrayToLogString($authInfo['userSession'], array($this->userid_column,$this->username_column)), 't3lib_userAuth');
468 }
469
470
471 // Re-auth user when 'auth'-service option is set
472 if ($this->svConfig['setup'][$this->loginType.'_alwaysAuthUser']) {
473 $authenticated = FALSE;
474 if ($this->writeDevLog) t3lib_div::devLog('alwaysAuthUser option is enabled', 't3lib_userAuth');
475 }
476
477
478 // Authenticate the user if needed
479 if (count($tempuserArr) && !$authenticated) {
480
481 foreach ($tempuserArr as $tempuser) {
482
483 // use 'auth' service to authenticate the user
484 // if one service returns FALSE then authentication failed
485 // a service might return 100 which means there's no reason to stop but the user can't be authenticated by that service
486
487 if ($this->writeDevLog) t3lib_div::devLog('Auth user: '.t3lib_div::arrayToLogString($tempuser), 't3lib_userAuth');
488
489 $serviceChain='';
490 $subType = 'authUser'.$this->loginType;
491 while (is_object($serviceObj = t3lib_div::makeInstanceService('auth', $subType, $serviceChain))) {
492 $serviceChain.=','.$serviceObj->getServiceKey();
493 $serviceObj->initAuth($subType, $loginData, $authInfo, $this);
494 if (($ret=$serviceObj->authUser($tempuser)) > 0) {
495
496 // if the service returns >=200 then no more checking is needed - useful for IP checking without password
497 if (intval($ret) >= 200) {
498 $authenticated = TRUE;
499 break;
500 } elseif (intval($ret) >= 100) {
501 // Just go on. User is still not authenticated but there's no reason to stop now.
502 } else {
503 $authenticated = TRUE;
504 }
505
506 } else {
507 $authenticated = FALSE;
508 break;
509 }
510 unset($serviceObj);
511 }
512 unset($serviceObj);
513
514 if ($this->writeDevLog && $serviceChain) t3lib_div::devLog($subType.' auth services called: '.$serviceChain, 't3lib_userAuth');
515
516 if ($authenticated) {
517 // leave foreach() because a user is authenticated
518 break;
519 }
520 }
521 }
522
523 // If user is authenticated a valid user is in $tempuser
524 if ($authenticated) {
525 // reset failure flag
526 $this->loginFailure = FALSE;
527
528
529 // Insert session record if needed:
530 if (!($haveSession && (
531 $tempuser['ses_id']==$this->id || // check if the tempuser has the current session id
532 $tempuser['uid']==$authInfo['userSession']['ses_userid'] // check if the tempuser has the uid of the fetched session user
533 ))) {
534 $this->createUserSession($tempuser);
535
536 // The login session is started.
537 $this->loginSessionStarted = TRUE;
538 }
539
540 // User logged in - write that to the log!
541 if ($this->writeStdLog && $activeLogin) {
542 $this->writelog(255,1,0,1,
543 'User %s logged in from %s (%s)',
544 Array($tempuser[$this->username_column], t3lib_div::getIndpEnv('REMOTE_ADDR'), t3lib_div::getIndpEnv('REMOTE_HOST')),
545 '','','',-1,'',$tempuser['uid']
546 );
547 }
548
549 if ($this->writeDevLog && $activeLogin) t3lib_div::devLog('User '.$tempuser[$this->username_column].' logged in from '.t3lib_div::getIndpEnv('REMOTE_ADDR').' ('.t3lib_div::getIndpEnv('REMOTE_HOST').')', 't3lib_userAuth', -1);
550 if ($this->writeDevLog && !$activeLogin) t3lib_div::devLog('User '.$tempuser[$this->username_column].' authenticated from '.t3lib_div::getIndpEnv('REMOTE_ADDR').' ('.t3lib_div::getIndpEnv('REMOTE_HOST').')', 't3lib_userAuth', -1);
551
552 if($GLOBALS['TYPO3_CONF_VARS']['BE']['lockSSL'] == 3 && $this->user_table == 'be_users') {
553 $requestStr = substr(t3lib_div::getIndpEnv('TYPO3_REQUEST_SCRIPT'), strlen(t3lib_div::getIndpEnv('TYPO3_SITE_URL').TYPO3_mainDir));
554 if($requestStr == 'alt_main.php' && t3lib_div::getIndpEnv('TYPO3_SSL')) {
555 list(,$url) = explode('://',t3lib_div::getIndpEnv('TYPO3_SITE_URL'),2);
556 header('Location: http://'.$url.TYPO3_mainDir.'alt_main.php');
557 exit;
558 }
559 }
560
561 } elseif ($activeLogin || count($tempuserArr)) {
562 $this->loginFailure = TRUE;
563
564 if ($this->writeDevLog && !count($tempuserArr) && $activeLogin) t3lib_div::devLog('Login failed: '.t3lib_div::arrayToLogString($loginData), 't3lib_userAuth', 2);
565 if ($this->writeDevLog && count($tempuserArr)) t3lib_div::devLog('Login failed: '.t3lib_div::arrayToLogString($tempuser, array($this->userid_column,$this->username_column)), 't3lib_userAuth', 2);
566 }
567
568
569 // If there were a login failure, check to see if a warning email should be sent:
570 if ($this->loginFailure && $activeLogin) {
571 if ($this->writeDevLog) t3lib_div::devLog('Call checkLogFailures: '.t3lib_div::arrayToLogString(array('warningEmail'=>$this->warningEmail,'warningPeriod'=>$this->warningPeriod,'warningMax'=>$this->warningMax,)), 't3lib_userAuth', -1);
572
573 $this->checkLogFailures($this->warningEmail, $this->warningPeriod, $this->warningMax);
574 }
575 }
576
577
578
579
580
581
582
583
584
585
586
587
588 /*************************
589 *
590 * User Sessions
591 *
592 *************************/
593
594
595 /**
596 * Creates a user session record.
597 *
598 * @param array user data array
599 * @return void
600 */
601 function createUserSession ($tempuser) {
602
603 if ($this->writeDevLog) t3lib_div::devLog('Create session ses_id = '.$this->id, 't3lib_userAuth');
604
605 // delete session entry first
606 $GLOBALS['TYPO3_DB']->exec_DELETEquery(
607 $this->session_table,
608 'ses_id = '.$GLOBALS['TYPO3_DB']->fullQuoteStr($this->id, $this->session_table).'
609 AND ses_name = '.$GLOBALS['TYPO3_DB']->fullQuoteStr($this->name, $this->session_table)
610 );
611
612 // re-create session entry
613 $insertFields = $this->getNewSessionRecord($tempuser);
614 $GLOBALS['TYPO3_DB']->exec_INSERTquery($this->session_table, $insertFields);
615
616 // Updating lastLogin_column carrying information about last login.
617 if ($this->lastLogin_column) {
618 $GLOBALS['TYPO3_DB']->exec_UPDATEquery(
619 $this->user_table,
620 $this->userid_column.'='.$GLOBALS['TYPO3_DB']->fullQuoteStr($tempuser[$this->userid_column], $this->user_table),
621 array($this->lastLogin_column => $GLOBALS['EXEC_TIME'])
622 );
623 }
624 }
625
626 /**
627 * Returns a new session record for the current user for insertion into the DB.
628 * This function is mainly there as a wrapper for inheriting classes to override it.
629 *
630 * @return array user session record
631 */
632 function getNewSessionRecord($tempuser) {
633 return array(
634 'ses_id' => $this->id,
635 'ses_name' => $this->name,
636 'ses_iplock' => $tempuser['disableIPlock'] ? '[DISABLED]' : $this->ipLockClause_remoteIPNumber($this->lockIP),
637 'ses_hashlock' => $this->hashLockClause_getHashInt(),
638 'ses_userid' => $tempuser[$this->userid_column],
639 'ses_tstamp' => $GLOBALS['EXEC_TIME']
640 );
641 }
642
643 /**
644 * Read the user session from db.
645 *
646 * @return array user session data
647 */
648 function fetchUserSession() {
649
650 $user = '';
651
652 if ($this->writeDevLog) t3lib_div::devLog('Fetch session ses_id = '.$this->id, 't3lib_userAuth');
653
654 // The session_id is used to find user in the database. Two tables are joined: The session-table with user_id of the session and the usertable with its primary key
655 $dbres = $GLOBALS['TYPO3_DB']->exec_SELECTquery(
656 '*',
657 $this->session_table.','.$this->user_table,
658 $this->session_table.'.ses_id = '.$GLOBALS['TYPO3_DB']->fullQuoteStr($this->id, $this->session_table).'
659 AND '.$this->session_table.'.ses_name = '.$GLOBALS['TYPO3_DB']->fullQuoteStr($this->name, $this->session_table).'
660 AND '.$this->session_table.'.ses_userid = '.$this->user_table.'.'.$this->userid_column.'
661 '.$this->ipLockClause().'
662 '.$this->hashLockClause().'
663 '.$this->user_where_clause()
664 );
665
666
667 if ($user = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($dbres)) {
668 // A user was found
669 if (is_string($this->auth_timeout_field)) {
670 $timeout = intval($user[$this->auth_timeout_field]); // Get timeout-time from usertable
671 } else {
672 $timeout = intval($this->auth_timeout_field); // Get timeout from object
673 }
674 // If timeout > 0 (true) and currenttime has not exceeded the latest sessions-time plus the timeout in seconds then accept user
675 // Option later on: We could check that last update was at least x seconds ago in order not to update twice in a row if one script redirects to another...
676 if ($timeout>0 && ($GLOBALS['EXEC_TIME'] < ($user['ses_tstamp']+$timeout))) {
677 $GLOBALS['TYPO3_DB']->exec_UPDATEquery(
678 $this->session_table,
679 'ses_id='.$GLOBALS['TYPO3_DB']->fullQuoteStr($this->id, $this->session_table).'
680 AND ses_name='.$GLOBALS['TYPO3_DB']->fullQuoteStr($this->name, $this->session_table),
681 array('ses_tstamp' => $GLOBALS['EXEC_TIME'])
682 );
683 $user['ses_tstamp'] = $GLOBALS['EXEC_TIME']; // Make sure that the timestamp is also updated in the array
684 } else {
685 $this->logoff(); // delete any user set...
686 }
687 } else {
688 $this->logoff(); // delete any user set...
689 }
690 return $user;
691 }
692
693 /**
694 * Log out current user!
695 * Removes the current session record, sets the internal ->user array to a blank string; Thereby the current user (if any) is effectively logged out!
696 *
697 * @return void
698 */
699 function logoff() {
700 if ($this->writeDevLog) t3lib_div::devLog('logoff: ses_id = '.$this->id, 't3lib_userAuth');
701
702 // Hook for pre-processing the logoff() method, requested and implemented by andreas.otto@dkd.de:
703 if (is_array($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_userauth.php']['logoff_pre_processing'])) {
704 $_params = array();
705 foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_userauth.php']['logoff_pre_processing'] as $_funcRef) {
706 if ($_funcRef) {
707 t3lib_div::callUserFunction($_funcRef,$_params,$this);
708 }
709 }
710 }
711
712 $GLOBALS['TYPO3_DB']->exec_DELETEquery(
713 $this->session_table,
714 'ses_id = '.$GLOBALS['TYPO3_DB']->fullQuoteStr($this->id, $this->session_table).'
715 AND ses_name = '.$GLOBALS['TYPO3_DB']->fullQuoteStr($this->name, $this->session_table)
716 );
717
718 $this->user = '';
719
720 // Hook for post-processing the logoff() method, requested and implemented by andreas.otto@dkd.de:
721 if (is_array($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_userauth.php']['logoff_post_processing'])) {
722 $_params = array();
723 foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_userauth.php']['logoff_post_processing'] as $_funcRef) {
724 if ($_funcRef) {
725 t3lib_div::callUserFunction($_funcRef,$_params,$this);
726 }
727 }
728 }
729 }
730
731
732
733
734
735
736
737
738
739
740
741
742
743 /*************************
744 *
745 * SQL Functions
746 *
747 *************************/
748
749 /**
750 * This returns the where-clause needed to select the user with respect flags like deleted, hidden, starttime, endtime
751 *
752 * @return string
753 * @access private
754 */
755 function user_where_clause() {
756 return (($this->enablecolumns['rootLevel']) ? 'AND '.$this->user_table.'.pid=0 ' : '').
757 (($this->enablecolumns['disabled']) ? ' AND '.$this->user_table.'.'.$this->enablecolumns['disabled'].'=0' : '').
758 (($this->enablecolumns['deleted']) ? ' AND '.$this->user_table.'.'.$this->enablecolumns['deleted'].'=0' : '').
759 (($this->enablecolumns['starttime']) ? ' AND ('.$this->user_table.'.'.$this->enablecolumns['starttime'].'<='.time().')' : '').
760 (($this->enablecolumns['endtime']) ? ' AND ('.$this->user_table.'.'.$this->enablecolumns['endtime'].'=0 OR '.$this->user_table.'.'.$this->enablecolumns['endtime'].'>'.time().')' : '');
761 }
762
763 /**
764 * This returns the where-clause needed to lock a user to the IP address
765 *
766 * @return string
767 * @access private
768 */
769 function ipLockClause() {
770 if ($this->lockIP) {
771 $wherePart = 'AND (
772 '.$this->session_table.'.ses_iplock='.$GLOBALS['TYPO3_DB']->fullQuoteStr($this->ipLockClause_remoteIPNumber($this->lockIP),$this->session_table).'
773 OR '.$this->session_table.'.ses_iplock=\'[DISABLED]\'
774 )';
775 return $wherePart;
776 }
777 }
778
779 /**
780 * Returns the IP address to lock to.
781 * The IP address may be partial based on $parts.
782 *
783 * @param integer 1-4: Indicates how many parts of the IP address to return. 4 means all, 1 means only first number.
784 * @return string (Partial) IP address for REMOTE_ADDR
785 * @access private
786 */
787 function ipLockClause_remoteIPNumber($parts) {
788 $IP = t3lib_div::getIndpEnv('REMOTE_ADDR');
789
790 if ($parts>=4) {
791 return $IP;
792 } else {
793 $parts = t3lib_div::intInRange($parts,1,3);
794 $IPparts = explode('.',$IP);
795 for($a=4;$a>$parts;$a--) {
796 unset($IPparts[$a-1]);
797 }
798 return implode('.',$IPparts);
799 }
800 }
801
802 /**
803 * This returns the where-clause needed to lock a user to a hash integer
804 *
805 * @return string
806 * @access private
807 */
808 function hashLockClause() {
809 $wherePart = 'AND '.$this->session_table.'.ses_hashlock='.intval($this->hashLockClause_getHashInt());
810 return $wherePart;
811 }
812
813 /**
814 * Creates hash integer to lock user to. Depends on configured keywords
815 *
816 * @return integer Hash integer
817 * @access private
818 */
819 function hashLockClause_getHashInt() {
820 $hashStr = '';
821
822 if (t3lib_div::inList($this->lockHashKeyWords,'useragent')) $hashStr.=':'.t3lib_div::getIndpEnv('HTTP_USER_AGENT');
823
824 return t3lib_div::md5int($hashStr);
825 }
826
827
828
829
830
831
832
833
834
835
836
837 /*************************
838 *
839 * Session and Configuration Handling
840 *
841 *************************/
842
843 /**
844 * This writes $variable to the user-record. This is a way of providing session-data.
845 * You can fetch the data again through $this->uc in this class!
846 * If $variable is not an array, $this->uc is saved!
847 *
848 * @param array An array you want to store for the user as session data. If $variable is not supplied (is blank string), the internal variable, ->uc, is stored by default
849 * @return void
850 */
851 function writeUC($variable='') {
852 if (is_array($this->user) && $this->user[$this->userid_column]) {
853 if (!is_array($variable)) { $variable = $this->uc; }
854
855 if ($this->writeDevLog) t3lib_div::devLog('writeUC: '.$this->userid_column.'='.intval($this->user[$this->userid_column]), 't3lib_userAuth');
856 $GLOBALS['TYPO3_DB']->exec_UPDATEquery($this->user_table, $this->userid_column.'='.intval($this->user[$this->userid_column]), array('uc' => serialize($variable)));
857 }
858 }
859
860 /**
861 * Sets $theUC as the internal variable ->uc IF $theUC is an array. If $theUC is false, the 'uc' content from the ->user array will be unserialized and restored in ->uc
862 *
863 * @param mixed If an array, then set as ->uc, otherwise load from user record
864 * @return void
865 */
866 function unpack_uc($theUC='') {
867 if (!$theUC) $theUC=unserialize($this->user['uc']);
868 if (is_array($theUC)) {
869 $this->uc=$theUC;
870 }
871 }
872
873 /**
874 * Stores data for a module.
875 * The data is stored with the session id so you can even check upon retrieval if the module data is from a previous session or from the current session.
876 *
877 * @param string $module is the name of the module ($MCONF['name'])
878 * @param mixed $data is the data you want to store for that module (array, string, ...)
879 * @param boolean If $noSave is set, then the ->uc array (which carries all kinds of user data) is NOT written immediately, but must be written by some subsequent call.
880 * @return void
881 */
882 function pushModuleData($module,$data,$noSave=0) {
883 $this->uc['moduleData'][$module] = $data;
884 $this->uc['moduleSessionID'][$module] = $this->id;
885 if (!$noSave) $this->writeUC();
886 }
887
888 /**
889 * Gets module data for a module (from a loaded ->uc array)
890 *
891 * @param string $module is the name of the module ($MCONF['name'])
892 * @param string If $type = 'ses' then module data is returned only if it was stored in the current session, otherwise data from a previous session will be returned (if available).
893 * @return mixed The module data if available: $this->uc['moduleData'][$module];
894 */
895 function getModuleData($module,$type='') {
896 if ($type!='ses' || $this->uc['moduleSessionID'][$module]==$this->id) {
897 return $this->uc['moduleData'][$module];
898 }
899 }
900
901 /**
902 * Returns the session data stored for $key.
903 * The data will last only for this login session since it is stored in the session table.
904 *
905 * @param string Pointer to an associative key in the session data array which is stored serialized in the field "ses_data" of the session table.
906 * @return mixed
907 */
908 function getSessionData($key) {
909 $sesDat = unserialize($this->user['ses_data']);
910 return $sesDat[$key];
911 }
912
913 /**
914 * Sets the session data ($data) for $key and writes all session data (from ->user['ses_data']) to the database.
915 * The data will last only for this login session since it is stored in the session table.
916 *
917 * @param string Pointer to an associative key in the session data array which is stored serialized in the field "ses_data" of the session table.
918 * @param mixed The variable to store in index $key
919 * @return void
920 */
921 function setAndSaveSessionData($key,$data) {
922 $sesDat = unserialize($this->user['ses_data']);
923 $sesDat[$key] = $data;
924 $this->user['ses_data'] = serialize($sesDat);
925
926 if ($this->writeDevLog) t3lib_div::devLog('setAndSaveSessionData: ses_id = '.$this->user['ses_id'], 't3lib_userAuth');
927 $GLOBALS['TYPO3_DB']->exec_UPDATEquery($this->session_table, 'ses_id='.$GLOBALS['TYPO3_DB']->fullQuoteStr($this->user['ses_id'], $this->session_table), array('ses_data' => $this->user['ses_data']));
928 }
929
930
931
932
933
934
935
936
937
938
939
940
941
942 /*************************
943 *
944 * Misc
945 *
946 *************************/
947
948 /**
949 * Returns an info array with Login/Logout data submitted by a form or params
950 *
951 * @return array
952 * @internal
953 */
954 function getLoginFormData() {
955 $loginData=array();
956 if ($this->getMethodEnabled) {
957 $loginData['status'] = t3lib_div::_GP($this->formfield_status);
958 $loginData['uname'] = t3lib_div::_GP($this->formfield_uname);
959 $loginData['uident'] = t3lib_div::_GP($this->formfield_uident);
960 $loginData['chalvalue'] = t3lib_div::_GP($this->formfield_chalvalue);
961 } else {
962 $loginData['status'] = t3lib_div::_POST($this->formfield_status);
963 $loginData['uname'] = t3lib_div::_POST($this->formfield_uname);
964 $loginData['uident'] = t3lib_div::_POST($this->formfield_uident);
965 $loginData['chalvalue'] = t3lib_div::_POST($this->formfield_chalvalue);
966 }
967 $loginData = $this->processLoginData($loginData);
968
969 return $loginData;
970 }
971
972 /**
973 * Processes Login data submitted by a form or params depending on the
974 * security_level
975 *
976 * @param array login data array
977 * @param string Alternative security_level. Used when authentication services wants to override the default.
978 * @return array processed login data array
979 * @internal
980 */
981 function processLoginData($loginData, $security_level='') {
982 global $TYPO3_CONF_VARS;
983
984 $loginSecurityLevel = $security_level ? $security_level : ($TYPO3_CONF_VARS[$this->loginType]['loginSecurityLevel'] ? $TYPO3_CONF_VARS[$this->loginType]['loginSecurityLevel'] : $this->security_level);
985
986 // Processing data according to the state it was submitted in.
987 // ($loginSecurityLevel should reflect the security level used on the data being submitted in the login form)
988 if ($loginSecurityLevel=='normal') {
989 $loginData['uident_text'] = $loginData['uident'];
990 $loginData['uident_challenged'] = (string)md5($loginData['uname'].':'.$loginData['uident'].':'.$loginData['chalvalue']);
991 $loginData['uident_superchallenged'] = (string)md5($loginData['uname'].':'.(md5($loginData['uident'])).':'.$loginData['chalvalue']);
992 } elseif ($loginSecurityLevel=='challenged') {
993 $loginData['uident_text'] = '';
994 $loginData['uident_challenged'] = $loginData['uident'];
995 $loginData['uident_superchallenged'] = '';
996 } elseif ($loginSecurityLevel=='superchallenged') {
997 $loginData['uident_text'] = '';
998 $loginData['uident_challenged'] = '';
999 $loginData['uident_superchallenged'] = $loginData['uident'];
1000 }
1001
1002 // The password "uident" is set based on the internal security setting of TYPO3
1003 // Example:
1004 // $this->security_level for the backend must be "superchallenged" because passwords are stored as md5-hashes in the be_users table
1005 // $this->security_level for the frontend must be "normal" or "challenged" because passwords are stored as clear-text in the fe_users tables
1006 if ($this->security_level=='normal') {
1007 $loginData['uident'] = $loginData['uident_text'];
1008 } elseif ($this->security_level=='challenged') {
1009 $loginData['uident'] = $loginData['uident_challenged'];
1010 } elseif ($this->security_level=='superchallenged') {
1011 $loginData['uident'] = $loginData['uident_superchallenged'];
1012 }
1013
1014 return $loginData;
1015 }
1016
1017 /**
1018 * Returns an info array which provides additional information for auth services
1019 *
1020 * @return array
1021 * @internal
1022 */
1023 function getAuthInfoArray() {
1024 $authInfo = array();
1025 $authInfo['loginType'] = $this->loginType;
1026 $authInfo['refInfo'] = parse_url(t3lib_div::getIndpEnv('HTTP_REFERER'));
1027 $authInfo['HTTP_HOST'] = t3lib_div::getIndpEnv('HTTP_HOST');
1028 $authInfo['REMOTE_ADDR'] = t3lib_div::getIndpEnv('REMOTE_ADDR');
1029 $authInfo['REMOTE_HOST'] = t3lib_div::getIndpEnv('REMOTE_HOST');
1030 $authInfo['security_level'] = $this->security_level;
1031 $authInfo['showHiddenRecords'] = $this->showHiddenRecords;
1032 // can be overidden in localconf by SVCONF:
1033 $authInfo['db_user']['table'] = $this->user_table;
1034 $authInfo['db_user']['userid_column'] = $this->userid_column;
1035 $authInfo['db_user']['username_column'] = $this->username_column;
1036 $authInfo['db_user']['userident_column'] = $this->userident_column;
1037 $authInfo['db_user']['usergroup_column'] = $this->usergroup_column;
1038 $authInfo['db_user']['enable_clause'] = $this->user_where_clause();
1039 $authInfo['db_user']['checkPidList'] = $this->checkPid ? $this->checkPid_value : '';
1040 $authInfo['db_user']['check_pid_clause'] = $this->checkPid ? ' AND pid IN ('.$GLOBALS['TYPO3_DB']->cleanIntList($authInfo['db_user']['checkPidList']).')' : '';
1041 $authInfo['db_groups']['table'] = $this->usergroup_table;
1042 return $authInfo;
1043 }
1044
1045 /**
1046 * Check the login data with the user record data for builtin login methods
1047 *
1048 * @param array user data array
1049 * @param array login data array
1050 * @param string Alternative security_level. Used when authentication services wants to override the default.
1051 * @return boolean true if login data matched
1052 */
1053 function compareUident($user, $loginData, $security_level='') {
1054
1055 $OK = FALSE;
1056 $security_level = $security_level ? $security_level : $this->security_level;
1057
1058 switch ($security_level) {
1059 case 'superchallenged': // If superchallenged the password in the database ($user[$this->userident_column]) must be a md5-hash of the original password.
1060 case 'challenged':
1061
1062 // Check challenge stored in cookie:
1063 if ($this->challengeStoredInCookie) {
1064 session_start();
1065 if ($_SESSION['login_challenge'] !== $loginData['chalvalue']) {
1066 if ($this->writeDevLog) t3lib_div::devLog('PHP Session stored challenge "'.$_SESSION['login_challenge'].'" and submitted challenge "'.$loginData['chalvalue'].'" did not match, so authentication failed!', 't3lib_userAuth', 2);
1067 $this->logoff();
1068 return FALSE;
1069 }
1070 }
1071
1072 if ((string)$loginData['uident'] === (string)md5($user[$this->username_column].':'.$user[$this->userident_column].':'.$loginData['chalvalue'])) {
1073 $OK = TRUE;
1074 }
1075 break;
1076 default: // normal
1077 if ((string)$loginData['uident'] === (string)$user[$this->userident_column]) {
1078 $OK = TRUE;
1079 }
1080 break;
1081 }
1082
1083 return $OK;
1084 }
1085
1086 /**
1087 * Garbage collector, removing old expired sessions.
1088 *
1089 * @return void
1090 * @internal
1091 */
1092 function gc() {
1093 $GLOBALS['TYPO3_DB']->exec_DELETEquery(
1094 $this->session_table,
1095 'ses_tstamp < '.intval(time()-($this->gc_time)).'
1096 AND ses_name = '.$GLOBALS['TYPO3_DB']->fullQuoteStr($this->name, $this->session_table)
1097 );
1098 }
1099
1100 /**
1101 * Redirect to somewhere. Obsolete, deprecated etc.
1102 *
1103 * @return void
1104 * @ignore
1105 */
1106 function redirect() {
1107 if (!$this->userid && $this->auth_url) { // if no userid AND an include-document for login is given
1108 include ($this->auth_include);
1109 exit;
1110 }
1111 }
1112
1113 /**
1114 * DUMMY: Writes to log database table (in some extension classes)
1115 *
1116 * @param integer $type: denotes which module that has submitted the entry. This is the current list: 1=tce_db; 2=tce_file; 3=system (eg. sys_history save); 4=modules; 254=Personal settings changed; 255=login / out action: 1=login, 2=logout, 3=failed login (+ errorcode 3), 4=failure_warning_email sent
1117 * @param integer $action: denotes which specific operation that wrote the entry (eg. 'delete', 'upload', 'update' and so on...). Specific for each $type. Also used to trigger update of the interface. (see the log-module for the meaning of each number !!)
1118 * @param integer $error: flag. 0 = message, 1 = error (user problem), 2 = System Error (which should not happen), 3 = security notice (admin)
1119 * @param integer $details_nr: The message number. Specific for each $type and $action. in the future this will make it possible to translate errormessages to other languages
1120 * @param string $details: Default text that follows the message
1121 * @param array $data: Data that follows the log. Might be used to carry special information. If an array the first 5 entries (0-4) will be sprintf'ed the details-text...
1122 * @param string $tablename: Special field used by tce_main.php. These ($tablename, $recuid, $recpid) holds the reference to the record which the log-entry is about. (Was used in attic status.php to update the interface.)
1123 * @param integer $recuid: Special field used by tce_main.php. These ($tablename, $recuid, $recpid) holds the reference to the record which the log-entry is about. (Was used in attic status.php to update the interface.)
1124 * @param integer $recpid: Special field used by tce_main.php. These ($tablename, $recuid, $recpid) holds the reference to the record which the log-entry is about. (Was used in attic status.php to update the interface.)
1125 * @return void
1126 * @see t3lib_userauthgroup::writelog()
1127 */
1128 function writelog($type,$action,$error,$details_nr,$details,$data,$tablename,$recuid,$recpid) {
1129 }
1130
1131 /**
1132 * DUMMY: Check login failures (in some extension classes)
1133 *
1134 * @return void
1135 * @ignore
1136 */
1137 function checkLogFailures() {
1138 }
1139
1140 /**
1141 * Raw initialization of the be_user with uid=$uid
1142 * This will circumvent all login procedures and select a be_users record from the database and set the content of ->user to the record selected. Thus the BE_USER object will appear like if a user was authenticated - however without a session id and the fields from the session table of course.
1143 * Will check the users for disabled, start/endtime, etc. ($this->user_where_clause())
1144 *
1145 * @param integer The UID of the backend user to set in ->user
1146 * @return void
1147 * @internal
1148 * @see SC_mod_tools_be_user_index::compareUsers(), SC_mod_user_setup_index::simulateUser(), freesite_admin::startCreate()
1149 */
1150 function setBeUserByUid($uid) {
1151 $this->user = $this->getRawUserByUid($uid);
1152 }
1153
1154 /**
1155 * Raw initialization of the be_user with username=$name
1156 *
1157 * @param string The username to look up.
1158 * @return void
1159 * @see t3lib_userAuth::setBeUserByUid()
1160 * @internal
1161 */
1162 function setBeUserByName($name) {
1163 $this->user = $this->getRawUserByName($name);
1164 }
1165
1166 /**
1167 * Fetching raw user record with uid=$uid
1168 *
1169 * @param integer The UID of the backend user to set in ->user
1170 * @return array user record or FALSE
1171 * @internal
1172 */
1173 function getRawUserByUid($uid) {
1174 $user = FALSE;
1175 $dbres = $GLOBALS['TYPO3_DB']->exec_SELECTquery('*', $this->user_table, 'uid='.intval($uid).' '.$this->user_where_clause());
1176 if ($dbres) {
1177 $user = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($dbres);
1178 $GLOBALS['TYPO3_DB']->sql_free_result($dbres);
1179 }
1180 return $user;
1181 }
1182
1183 /**
1184 * Fetching raw user record with username=$name
1185 *
1186 * @param string The username to look up.
1187 * @return array user record or FALSE
1188 * @see t3lib_userAuth::getUserByUid()
1189 * @internal
1190 */
1191 function getRawUserByName($name) {
1192 $user = FALSE;
1193 $dbres = $GLOBALS['TYPO3_DB']->exec_SELECTquery('*', $this->user_table, 'username='.$GLOBALS['TYPO3_DB']->fullQuoteStr($name, $this->user_table).' '.$this->user_where_clause());
1194 if ($dbres) {
1195 $user = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($dbres);
1196 $GLOBALS['TYPO3_DB']->sql_free_result($dbres);
1197 }
1198 return $user;
1199 }
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215 /*************************
1216 *
1217 * Create/update user - EXPERIMENTAL
1218 *
1219 *************************/
1220
1221 /**
1222 * Get a user from DB by username
1223 * provided for usage from services
1224 *
1225 * @param array User db table definition: $this->db_user
1226 * @param string user name
1227 * @param string additional WHERE clause: " AND ...
1228 * @return mixed user array or FALSE
1229 */
1230 function fetchUserRecord($dbUser, $username, $extraWhere='' ) {
1231 $user = FALSE;
1232
1233 $usernameClause = $username ? ($dbUser['username_column'].'='.$GLOBALS['TYPO3_DB']->fullQuoteStr($username, $dbUser['table'])) : '';
1234
1235 if ($username || $extraWhere) {
1236
1237 // Look up the user by the username and/or extraWhere:
1238 $dbres = $GLOBALS['TYPO3_DB']->exec_SELECTquery(
1239 '*',
1240 $dbUser['table'],
1241 $usernameClause.
1242 $dbUser['check_pid_clause'].
1243 $dbUser['enable_clause'].
1244 $extraWhere
1245 );
1246
1247 if ($dbres) {
1248 $user = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($dbres);
1249 $GLOBALS['TYPO3_DB']->sql_free_result($dbres);
1250 }
1251 }
1252 return $user;
1253 }
1254 }
1255
1256
1257
1258 if (defined('TYPO3_MODE') && $TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['t3lib/class.t3lib_userauth.php']) {
1259 include_once($TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['t3lib/class.t3lib_userauth.php']);
1260 }
1261 ?>