Fixed bug #7386: Remove hardcoded references to alt_main.php backend interface
[Packages/TYPO3.CMS.git] / t3lib / class.t3lib_userauth.php
1 <?php
2 /***************************************************************
3 * Copyright notice
4 *
5 * (c) 1999-2008 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 * Determine 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 * Determine 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 if (is_array($this->svConfig['setup'])) {
425 t3lib_div::devLog('SV setup: '.t3lib_div::arrayToLogString($this->svConfig['setup']), 't3lib_userAuth', 0);
426 }
427 }
428
429 // fetch user if ...
430 if ($activeLogin
431 || (!$haveSession && $this->svConfig['setup'][$this->loginType.'_fetchUserIfNoSession'])
432 || $this->svConfig['setup'][$this->loginType.'_alwaysFetchUser']) {
433
434 // use 'auth' service to find the user
435 // first found user will be used
436 $serviceChain = '';
437 $subType = 'getUser'.$this->loginType;
438 while (is_object($serviceObj = t3lib_div::makeInstanceService('auth', $subType, $serviceChain))) {
439 $serviceChain.=','.$serviceObj->getServiceKey();
440 $serviceObj->initAuth($subType, $loginData, $authInfo, $this);
441 if ($row=$serviceObj->getUser()) {
442 $tempuserArr[] = $row;
443
444 if ($this->writeDevLog) t3lib_div::devLog('User found: '.t3lib_div::arrayToLogString($row, array($this->userid_column,$this->username_column)), 't3lib_userAuth', 0);
445
446 // user found, just stop to search for more if not configured to go on
447 if(!$this->svConfig['setup'][$this->loginType.'_fetchAllUsers']) {
448 break;
449 }
450 }
451 unset($serviceObj);
452 }
453 unset($serviceObj);
454
455 if ($this->writeDevLog && $this->svConfig['setup'][$this->loginType.'_alwaysFetchUser']) t3lib_div::devLog($this->loginType.'_alwaysFetchUser option is enabled', 't3lib_userAuth');
456 if ($this->writeDevLog && $serviceChain) t3lib_div::devLog($subType.' auth services called: '.$serviceChain, 't3lib_userAuth');
457 if ($this->writeDevLog && !count($tempuserArr)) t3lib_div::devLog('No user found by services', 't3lib_userAuth');
458 if ($this->writeDevLog && count($tempuserArr)) t3lib_div::devLog(count($tempuserArr).' user records found by services', 't3lib_userAuth');
459 }
460
461
462 // If no new user was set we use the already found user session
463 if (!count($tempuserArr) && $haveSession) {
464 $tempuserArr[] = $authInfo['userSession'];
465 $tempuser = $authInfo['userSession'];
466 // User is authenticated because we found a user session
467 $authenticated = TRUE;
468
469 if ($this->writeDevLog) t3lib_div::devLog('User session used: '.t3lib_div::arrayToLogString($authInfo['userSession'], array($this->userid_column,$this->username_column)), 't3lib_userAuth');
470 }
471
472
473 // Re-auth user when 'auth'-service option is set
474 if ($this->svConfig['setup'][$this->loginType.'_alwaysAuthUser']) {
475 $authenticated = FALSE;
476 if ($this->writeDevLog) t3lib_div::devLog('alwaysAuthUser option is enabled', 't3lib_userAuth');
477 }
478
479
480 // Authenticate the user if needed
481 if (count($tempuserArr) && !$authenticated) {
482
483 foreach ($tempuserArr as $tempuser) {
484
485 // use 'auth' service to authenticate the user
486 // if one service returns FALSE then authentication failed
487 // a service might return 100 which means there's no reason to stop but the user can't be authenticated by that service
488
489 if ($this->writeDevLog) t3lib_div::devLog('Auth user: '.t3lib_div::arrayToLogString($tempuser), 't3lib_userAuth');
490
491 $serviceChain='';
492 $subType = 'authUser'.$this->loginType;
493 while (is_object($serviceObj = t3lib_div::makeInstanceService('auth', $subType, $serviceChain))) {
494 $serviceChain.=','.$serviceObj->getServiceKey();
495 $serviceObj->initAuth($subType, $loginData, $authInfo, $this);
496 if (($ret=$serviceObj->authUser($tempuser)) > 0) {
497
498 // if the service returns >=200 then no more checking is needed - useful for IP checking without password
499 if (intval($ret) >= 200) {
500 $authenticated = TRUE;
501 break;
502 } elseif (intval($ret) >= 100) {
503 // Just go on. User is still not authenticated but there's no reason to stop now.
504 } else {
505 $authenticated = TRUE;
506 }
507
508 } else {
509 $authenticated = FALSE;
510 break;
511 }
512 unset($serviceObj);
513 }
514 unset($serviceObj);
515
516 if ($this->writeDevLog && $serviceChain) t3lib_div::devLog($subType.' auth services called: '.$serviceChain, 't3lib_userAuth');
517
518 if ($authenticated) {
519 // leave foreach() because a user is authenticated
520 break;
521 }
522 }
523 }
524
525 // If user is authenticated a valid user is in $tempuser
526 if ($authenticated) {
527 // reset failure flag
528 $this->loginFailure = FALSE;
529
530
531 // Insert session record if needed:
532 if (!($haveSession && (
533 $tempuser['ses_id']==$this->id || // check if the tempuser has the current session id
534 $tempuser['uid']==$authInfo['userSession']['ses_userid'] // check if the tempuser has the uid of the fetched session user
535 ))) {
536 $this->createUserSession($tempuser);
537
538 // The login session is started.
539 $this->loginSessionStarted = TRUE;
540 }
541
542 // User logged in - write that to the log!
543 if ($this->writeStdLog && $activeLogin) {
544 $this->writelog(255,1,0,1,
545 'User %s logged in from %s (%s)',
546 Array($tempuser[$this->username_column], t3lib_div::getIndpEnv('REMOTE_ADDR'), t3lib_div::getIndpEnv('REMOTE_HOST')),
547 '','','',-1,'',$tempuser['uid']
548 );
549 }
550
551 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);
552 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);
553
554 if($GLOBALS['TYPO3_CONF_VARS']['BE']['lockSSL'] == 3 && $this->user_table == 'be_users') {
555 $requestStr = substr(t3lib_div::getIndpEnv('TYPO3_REQUEST_SCRIPT'), strlen(t3lib_div::getIndpEnv('TYPO3_SITE_URL').TYPO3_mainDir));
556 $backendScript = t3lib_BEfunc::getBackendScript();
557 if($requestStr == $backendScript && t3lib_div::getIndpEnv('TYPO3_SSL')) {
558 list(,$url) = explode('://',t3lib_div::getIndpEnv('TYPO3_SITE_URL'),2);
559 header('Location: http://'.$url.TYPO3_mainDir.$backendScript);
560 exit;
561 }
562 }
563
564 } elseif ($activeLogin || count($tempuserArr)) {
565 $this->loginFailure = TRUE;
566
567 if ($this->writeDevLog && !count($tempuserArr) && $activeLogin) t3lib_div::devLog('Login failed: '.t3lib_div::arrayToLogString($loginData), 't3lib_userAuth', 2);
568 if ($this->writeDevLog && count($tempuserArr)) t3lib_div::devLog('Login failed: '.t3lib_div::arrayToLogString($tempuser, array($this->userid_column,$this->username_column)), 't3lib_userAuth', 2);
569 }
570
571
572 // If there were a login failure, check to see if a warning email should be sent:
573 if ($this->loginFailure && $activeLogin) {
574 if ($this->writeDevLog) t3lib_div::devLog('Call checkLogFailures: '.t3lib_div::arrayToLogString(array('warningEmail'=>$this->warningEmail,'warningPeriod'=>$this->warningPeriod,'warningMax'=>$this->warningMax,)), 't3lib_userAuth', -1);
575
576 $this->checkLogFailures($this->warningEmail, $this->warningPeriod, $this->warningMax);
577 }
578 }
579
580
581
582
583
584
585
586
587
588
589
590
591 /*************************
592 *
593 * User Sessions
594 *
595 *************************/
596
597
598 /**
599 * Creates a user session record.
600 *
601 * @param array user data array
602 * @return void
603 */
604 function createUserSession ($tempuser) {
605
606 if ($this->writeDevLog) t3lib_div::devLog('Create session ses_id = '.$this->id, 't3lib_userAuth');
607
608 // delete session entry first
609 $GLOBALS['TYPO3_DB']->exec_DELETEquery(
610 $this->session_table,
611 'ses_id = '.$GLOBALS['TYPO3_DB']->fullQuoteStr($this->id, $this->session_table).'
612 AND ses_name = '.$GLOBALS['TYPO3_DB']->fullQuoteStr($this->name, $this->session_table)
613 );
614
615 // re-create session entry
616 $insertFields = $this->getNewSessionRecord($tempuser);
617 $GLOBALS['TYPO3_DB']->exec_INSERTquery($this->session_table, $insertFields);
618
619 // Updating lastLogin_column carrying information about last login.
620 if ($this->lastLogin_column) {
621 $GLOBALS['TYPO3_DB']->exec_UPDATEquery(
622 $this->user_table,
623 $this->userid_column.'='.$GLOBALS['TYPO3_DB']->fullQuoteStr($tempuser[$this->userid_column], $this->user_table),
624 array($this->lastLogin_column => $GLOBALS['EXEC_TIME'])
625 );
626 }
627 }
628
629 /**
630 * Returns a new session record for the current user for insertion into the DB.
631 * This function is mainly there as a wrapper for inheriting classes to override it.
632 *
633 * @return array user session record
634 */
635 function getNewSessionRecord($tempuser) {
636 return array(
637 'ses_id' => $this->id,
638 'ses_name' => $this->name,
639 'ses_iplock' => $tempuser['disableIPlock'] ? '[DISABLED]' : $this->ipLockClause_remoteIPNumber($this->lockIP),
640 'ses_hashlock' => $this->hashLockClause_getHashInt(),
641 'ses_userid' => $tempuser[$this->userid_column],
642 'ses_tstamp' => $GLOBALS['EXEC_TIME']
643 );
644 }
645
646 /**
647 * Read the user session from db.
648 *
649 * @return array user session data
650 */
651 function fetchUserSession() {
652
653 $user = '';
654
655 if ($this->writeDevLog) t3lib_div::devLog('Fetch session ses_id = '.$this->id, 't3lib_userAuth');
656
657 // 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
658 $dbres = $GLOBALS['TYPO3_DB']->exec_SELECTquery(
659 '*',
660 $this->session_table.','.$this->user_table,
661 $this->session_table.'.ses_id = '.$GLOBALS['TYPO3_DB']->fullQuoteStr($this->id, $this->session_table).'
662 AND '.$this->session_table.'.ses_name = '.$GLOBALS['TYPO3_DB']->fullQuoteStr($this->name, $this->session_table).'
663 AND '.$this->session_table.'.ses_userid = '.$this->user_table.'.'.$this->userid_column.'
664 '.$this->ipLockClause().'
665 '.$this->hashLockClause().'
666 '.$this->user_where_clause()
667 );
668
669
670 if ($user = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($dbres)) {
671 // A user was found
672 if (is_string($this->auth_timeout_field)) {
673 $timeout = intval($user[$this->auth_timeout_field]); // Get timeout-time from usertable
674 } else {
675 $timeout = intval($this->auth_timeout_field); // Get timeout from object
676 }
677 // If timeout > 0 (true) and currenttime has not exceeded the latest sessions-time plus the timeout in seconds then accept user
678 // 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...
679 if ($timeout>0 && ($GLOBALS['EXEC_TIME'] < ($user['ses_tstamp']+$timeout))) {
680 $GLOBALS['TYPO3_DB']->exec_UPDATEquery(
681 $this->session_table,
682 'ses_id='.$GLOBALS['TYPO3_DB']->fullQuoteStr($this->id, $this->session_table).'
683 AND ses_name='.$GLOBALS['TYPO3_DB']->fullQuoteStr($this->name, $this->session_table),
684 array('ses_tstamp' => $GLOBALS['EXEC_TIME'])
685 );
686 $user['ses_tstamp'] = $GLOBALS['EXEC_TIME']; // Make sure that the timestamp is also updated in the array
687 } else {
688 $this->logoff(); // delete any user set...
689 }
690 } else {
691 $this->logoff(); // delete any user set...
692 }
693 return $user;
694 }
695
696 /**
697 * Log out current user!
698 * Removes the current session record, sets the internal ->user array to a blank string; Thereby the current user (if any) is effectively logged out!
699 *
700 * @return void
701 */
702 function logoff() {
703 if ($this->writeDevLog) t3lib_div::devLog('logoff: ses_id = '.$this->id, 't3lib_userAuth');
704
705 // Hook for pre-processing the logoff() method, requested and implemented by andreas.otto@dkd.de:
706 if (is_array($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_userauth.php']['logoff_pre_processing'])) {
707 $_params = array();
708 foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_userauth.php']['logoff_pre_processing'] as $_funcRef) {
709 if ($_funcRef) {
710 t3lib_div::callUserFunction($_funcRef,$_params,$this);
711 }
712 }
713 }
714
715 $GLOBALS['TYPO3_DB']->exec_DELETEquery(
716 $this->session_table,
717 'ses_id = '.$GLOBALS['TYPO3_DB']->fullQuoteStr($this->id, $this->session_table).'
718 AND ses_name = '.$GLOBALS['TYPO3_DB']->fullQuoteStr($this->name, $this->session_table)
719 );
720
721 $this->user = '';
722
723 // Hook for post-processing the logoff() method, requested and implemented by andreas.otto@dkd.de:
724 if (is_array($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_userauth.php']['logoff_post_processing'])) {
725 $_params = array();
726 foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_userauth.php']['logoff_post_processing'] as $_funcRef) {
727 if ($_funcRef) {
728 t3lib_div::callUserFunction($_funcRef,$_params,$this);
729 }
730 }
731 }
732 }
733
734
735
736
737
738
739
740
741
742
743
744
745
746 /*************************
747 *
748 * SQL Functions
749 *
750 *************************/
751
752 /**
753 * This returns the where-clause needed to select the user with respect flags like deleted, hidden, starttime, endtime
754 *
755 * @return string
756 * @access private
757 */
758 function user_where_clause() {
759 return (($this->enablecolumns['rootLevel']) ? 'AND '.$this->user_table.'.pid=0 ' : '').
760 (($this->enablecolumns['disabled']) ? ' AND '.$this->user_table.'.'.$this->enablecolumns['disabled'].'=0' : '').
761 (($this->enablecolumns['deleted']) ? ' AND '.$this->user_table.'.'.$this->enablecolumns['deleted'].'=0' : '').
762 (($this->enablecolumns['starttime']) ? ' AND ('.$this->user_table.'.'.$this->enablecolumns['starttime'].'<='.time().')' : '').
763 (($this->enablecolumns['endtime']) ? ' AND ('.$this->user_table.'.'.$this->enablecolumns['endtime'].'=0 OR '.$this->user_table.'.'.$this->enablecolumns['endtime'].'>'.time().')' : '');
764 }
765
766 /**
767 * This returns the where-clause needed to lock a user to the IP address
768 *
769 * @return string
770 * @access private
771 */
772 function ipLockClause() {
773 if ($this->lockIP) {
774 $wherePart = 'AND (
775 '.$this->session_table.'.ses_iplock='.$GLOBALS['TYPO3_DB']->fullQuoteStr($this->ipLockClause_remoteIPNumber($this->lockIP),$this->session_table).'
776 OR '.$this->session_table.'.ses_iplock=\'[DISABLED]\'
777 )';
778 return $wherePart;
779 }
780 }
781
782 /**
783 * Returns the IP address to lock to.
784 * The IP address may be partial based on $parts.
785 *
786 * @param integer 1-4: Indicates how many parts of the IP address to return. 4 means all, 1 means only first number.
787 * @return string (Partial) IP address for REMOTE_ADDR
788 * @access private
789 */
790 function ipLockClause_remoteIPNumber($parts) {
791 $IP = t3lib_div::getIndpEnv('REMOTE_ADDR');
792
793 if ($parts>=4) {
794 return $IP;
795 } else {
796 $parts = t3lib_div::intInRange($parts,1,3);
797 $IPparts = explode('.',$IP);
798 for($a=4;$a>$parts;$a--) {
799 unset($IPparts[$a-1]);
800 }
801 return implode('.',$IPparts);
802 }
803 }
804
805 /**
806 * This returns the where-clause needed to lock a user to a hash integer
807 *
808 * @return string
809 * @access private
810 */
811 function hashLockClause() {
812 $wherePart = 'AND '.$this->session_table.'.ses_hashlock='.intval($this->hashLockClause_getHashInt());
813 return $wherePart;
814 }
815
816 /**
817 * Creates hash integer to lock user to. Depends on configured keywords
818 *
819 * @return integer Hash integer
820 * @access private
821 */
822 function hashLockClause_getHashInt() {
823 $hashStr = '';
824
825 if (t3lib_div::inList($this->lockHashKeyWords,'useragent')) $hashStr.=':'.t3lib_div::getIndpEnv('HTTP_USER_AGENT');
826
827 return t3lib_div::md5int($hashStr);
828 }
829
830
831
832
833
834
835
836
837
838
839
840 /*************************
841 *
842 * Session and Configuration Handling
843 *
844 *************************/
845
846 /**
847 * This writes $variable to the user-record. This is a way of providing session-data.
848 * You can fetch the data again through $this->uc in this class!
849 * If $variable is not an array, $this->uc is saved!
850 *
851 * @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
852 * @return void
853 */
854 function writeUC($variable='') {
855 if (is_array($this->user) && $this->user[$this->userid_column]) {
856 if (!is_array($variable)) { $variable = $this->uc; }
857
858 if ($this->writeDevLog) t3lib_div::devLog('writeUC: '.$this->userid_column.'='.intval($this->user[$this->userid_column]), 't3lib_userAuth');
859 $GLOBALS['TYPO3_DB']->exec_UPDATEquery($this->user_table, $this->userid_column.'='.intval($this->user[$this->userid_column]), array('uc' => serialize($variable)));
860 }
861 }
862
863 /**
864 * 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
865 *
866 * @param mixed If an array, then set as ->uc, otherwise load from user record
867 * @return void
868 */
869 function unpack_uc($theUC='') {
870 if (!$theUC) $theUC=unserialize($this->user['uc']);
871 if (is_array($theUC)) {
872 $this->uc=$theUC;
873 }
874 }
875
876 /**
877 * Stores data for a module.
878 * 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.
879 *
880 * @param string $module is the name of the module ($MCONF['name'])
881 * @param mixed $data is the data you want to store for that module (array, string, ...)
882 * @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.
883 * @return void
884 */
885 function pushModuleData($module,$data,$noSave=0) {
886 $this->uc['moduleData'][$module] = $data;
887 $this->uc['moduleSessionID'][$module] = $this->id;
888 if (!$noSave) $this->writeUC();
889 }
890
891 /**
892 * Gets module data for a module (from a loaded ->uc array)
893 *
894 * @param string $module is the name of the module ($MCONF['name'])
895 * @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).
896 * @return mixed The module data if available: $this->uc['moduleData'][$module];
897 */
898 function getModuleData($module,$type='') {
899 if ($type!='ses' || $this->uc['moduleSessionID'][$module]==$this->id) {
900 return $this->uc['moduleData'][$module];
901 }
902 }
903
904 /**
905 * Returns the session data stored for $key.
906 * The data will last only for this login session since it is stored in the session table.
907 *
908 * @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.
909 * @return mixed
910 */
911 function getSessionData($key) {
912 $sesDat = unserialize($this->user['ses_data']);
913 return $sesDat[$key];
914 }
915
916 /**
917 * Sets the session data ($data) for $key and writes all session data (from ->user['ses_data']) to the database.
918 * The data will last only for this login session since it is stored in the session table.
919 *
920 * @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.
921 * @param mixed The variable to store in index $key
922 * @return void
923 */
924 function setAndSaveSessionData($key,$data) {
925 $sesDat = unserialize($this->user['ses_data']);
926 $sesDat[$key] = $data;
927 $this->user['ses_data'] = serialize($sesDat);
928
929 if ($this->writeDevLog) t3lib_div::devLog('setAndSaveSessionData: ses_id = '.$this->user['ses_id'], 't3lib_userAuth');
930 $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']));
931 }
932
933
934
935
936
937
938
939
940
941
942
943
944
945 /*************************
946 *
947 * Misc
948 *
949 *************************/
950
951 /**
952 * Returns an info array with Login/Logout data submitted by a form or params
953 *
954 * @return array
955 * @internal
956 */
957 function getLoginFormData() {
958 $loginData=array();
959 if ($this->getMethodEnabled) {
960 $loginData['status'] = t3lib_div::_GP($this->formfield_status);
961 $loginData['uname'] = t3lib_div::_GP($this->formfield_uname);
962 $loginData['uident'] = t3lib_div::_GP($this->formfield_uident);
963 $loginData['chalvalue'] = t3lib_div::_GP($this->formfield_chalvalue);
964 } else {
965 $loginData['status'] = t3lib_div::_POST($this->formfield_status);
966 $loginData['uname'] = t3lib_div::_POST($this->formfield_uname);
967 $loginData['uident'] = t3lib_div::_POST($this->formfield_uident);
968 $loginData['chalvalue'] = t3lib_div::_POST($this->formfield_chalvalue);
969 }
970 $loginData = $this->processLoginData($loginData);
971
972 return $loginData;
973 }
974
975 /**
976 * Processes Login data submitted by a form or params depending on the
977 * security_level
978 *
979 * @param array login data array
980 * @param string Alternative security_level. Used when authentication services wants to override the default.
981 * @return array processed login data array
982 * @internal
983 */
984 function processLoginData($loginData, $security_level='') {
985 global $TYPO3_CONF_VARS;
986
987 $loginSecurityLevel = $security_level ? $security_level : ($TYPO3_CONF_VARS[$this->loginType]['loginSecurityLevel'] ? $TYPO3_CONF_VARS[$this->loginType]['loginSecurityLevel'] : $this->security_level);
988
989 // Processing data according to the state it was submitted in.
990 // ($loginSecurityLevel should reflect the security level used on the data being submitted in the login form)
991 if ($loginSecurityLevel=='normal') {
992 $loginData['uident_text'] = $loginData['uident'];
993 $loginData['uident_challenged'] = (string)md5($loginData['uname'].':'.$loginData['uident'].':'.$loginData['chalvalue']);
994 $loginData['uident_superchallenged'] = (string)md5($loginData['uname'].':'.(md5($loginData['uident'])).':'.$loginData['chalvalue']);
995 } elseif ($loginSecurityLevel=='challenged') {
996 $loginData['uident_text'] = '';
997 $loginData['uident_challenged'] = $loginData['uident'];
998 $loginData['uident_superchallenged'] = '';
999 } elseif ($loginSecurityLevel=='superchallenged') {
1000 $loginData['uident_text'] = '';
1001 $loginData['uident_challenged'] = '';
1002 $loginData['uident_superchallenged'] = $loginData['uident'];
1003 }
1004
1005 // The password "uident" is set based on the internal security setting of TYPO3
1006 // Example:
1007 // $this->security_level for the backend must be "superchallenged" because passwords are stored as md5-hashes in the be_users table
1008 // $this->security_level for the frontend must be "normal" or "challenged" because passwords are stored as clear-text in the fe_users tables
1009 if ($this->security_level=='normal') {
1010 $loginData['uident'] = $loginData['uident_text'];
1011 } elseif ($this->security_level=='challenged') {
1012 $loginData['uident'] = $loginData['uident_challenged'];
1013 } elseif ($this->security_level=='superchallenged') {
1014 $loginData['uident'] = $loginData['uident_superchallenged'];
1015 }
1016
1017 return $loginData;
1018 }
1019
1020 /**
1021 * Returns an info array which provides additional information for auth services
1022 *
1023 * @return array
1024 * @internal
1025 */
1026 function getAuthInfoArray() {
1027 $authInfo = array();
1028 $authInfo['loginType'] = $this->loginType;
1029 $authInfo['refInfo'] = parse_url(t3lib_div::getIndpEnv('HTTP_REFERER'));
1030 $authInfo['HTTP_HOST'] = t3lib_div::getIndpEnv('HTTP_HOST');
1031 $authInfo['REMOTE_ADDR'] = t3lib_div::getIndpEnv('REMOTE_ADDR');
1032 $authInfo['REMOTE_HOST'] = t3lib_div::getIndpEnv('REMOTE_HOST');
1033 $authInfo['security_level'] = $this->security_level;
1034 $authInfo['showHiddenRecords'] = $this->showHiddenRecords;
1035 // can be overidden in localconf by SVCONF:
1036 $authInfo['db_user']['table'] = $this->user_table;
1037 $authInfo['db_user']['userid_column'] = $this->userid_column;
1038 $authInfo['db_user']['username_column'] = $this->username_column;
1039 $authInfo['db_user']['userident_column'] = $this->userident_column;
1040 $authInfo['db_user']['usergroup_column'] = $this->usergroup_column;
1041 $authInfo['db_user']['enable_clause'] = $this->user_where_clause();
1042 $authInfo['db_user']['checkPidList'] = $this->checkPid ? $this->checkPid_value : '';
1043 $authInfo['db_user']['check_pid_clause'] = $this->checkPid ? ' AND pid IN ('.$GLOBALS['TYPO3_DB']->cleanIntList($authInfo['db_user']['checkPidList']).')' : '';
1044 $authInfo['db_groups']['table'] = $this->usergroup_table;
1045 return $authInfo;
1046 }
1047
1048 /**
1049 * Check the login data with the user record data for builtin login methods
1050 *
1051 * @param array user data array
1052 * @param array login data array
1053 * @param string Alternative security_level. Used when authentication services wants to override the default.
1054 * @return boolean true if login data matched
1055 */
1056 function compareUident($user, $loginData, $security_level='') {
1057
1058 $OK = FALSE;
1059 $security_level = $security_level ? $security_level : $this->security_level;
1060
1061 switch ($security_level) {
1062 case 'superchallenged': // If superchallenged the password in the database ($user[$this->userident_column]) must be a md5-hash of the original password.
1063 case 'challenged':
1064
1065 // Check challenge stored in cookie:
1066 if ($this->challengeStoredInCookie) {
1067 session_start();
1068 if ($_SESSION['login_challenge'] !== $loginData['chalvalue']) {
1069 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);
1070 $this->logoff();
1071 return FALSE;
1072 }
1073 }
1074
1075 if ((string)$loginData['uident'] === (string)md5($user[$this->username_column].':'.$user[$this->userident_column].':'.$loginData['chalvalue'])) {
1076 $OK = TRUE;
1077 }
1078 break;
1079 default: // normal
1080 if ((string)$loginData['uident'] === (string)$user[$this->userident_column]) {
1081 $OK = TRUE;
1082 }
1083 break;
1084 }
1085
1086 return $OK;
1087 }
1088
1089 /**
1090 * Garbage collector, removing old expired sessions.
1091 *
1092 * @return void
1093 * @internal
1094 */
1095 function gc() {
1096 $GLOBALS['TYPO3_DB']->exec_DELETEquery(
1097 $this->session_table,
1098 'ses_tstamp < '.intval(time()-($this->gc_time)).'
1099 AND ses_name = '.$GLOBALS['TYPO3_DB']->fullQuoteStr($this->name, $this->session_table)
1100 );
1101 }
1102
1103 /**
1104 * Redirect to somewhere. Obsolete, deprecated etc.
1105 *
1106 * @return void
1107 * @ignore
1108 */
1109 function redirect() {
1110 if (!$this->userid && $this->auth_url) { // if no userid AND an include-document for login is given
1111 include ($this->auth_include);
1112 exit;
1113 }
1114 }
1115
1116 /**
1117 * DUMMY: Writes to log database table (in some extension classes)
1118 *
1119 * @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
1120 * @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 !!)
1121 * @param integer $error: flag. 0 = message, 1 = error (user problem), 2 = System Error (which should not happen), 3 = security notice (admin)
1122 * @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
1123 * @param string $details: Default text that follows the message
1124 * @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...
1125 * @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.)
1126 * @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.)
1127 * @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.)
1128 * @return void
1129 * @see t3lib_userauthgroup::writelog()
1130 */
1131 function writelog($type,$action,$error,$details_nr,$details,$data,$tablename,$recuid,$recpid) {
1132 }
1133
1134 /**
1135 * DUMMY: Check login failures (in some extension classes)
1136 *
1137 * @return void
1138 * @ignore
1139 */
1140 function checkLogFailures() {
1141 }
1142
1143 /**
1144 * Raw initialization of the be_user with uid=$uid
1145 * 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.
1146 * Will check the users for disabled, start/endtime, etc. ($this->user_where_clause())
1147 *
1148 * @param integer The UID of the backend user to set in ->user
1149 * @return void
1150 * @internal
1151 * @see SC_mod_tools_be_user_index::compareUsers(), SC_mod_user_setup_index::simulateUser(), freesite_admin::startCreate()
1152 */
1153 function setBeUserByUid($uid) {
1154 $this->user = $this->getRawUserByUid($uid);
1155 }
1156
1157 /**
1158 * Raw initialization of the be_user with username=$name
1159 *
1160 * @param string The username to look up.
1161 * @return void
1162 * @see t3lib_userAuth::setBeUserByUid()
1163 * @internal
1164 */
1165 function setBeUserByName($name) {
1166 $this->user = $this->getRawUserByName($name);
1167 }
1168
1169 /**
1170 * Fetching raw user record with uid=$uid
1171 *
1172 * @param integer The UID of the backend user to set in ->user
1173 * @return array user record or FALSE
1174 * @internal
1175 */
1176 function getRawUserByUid($uid) {
1177 $user = FALSE;
1178 $dbres = $GLOBALS['TYPO3_DB']->exec_SELECTquery('*', $this->user_table, 'uid='.intval($uid).' '.$this->user_where_clause());
1179 if ($dbres) {
1180 $user = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($dbres);
1181 $GLOBALS['TYPO3_DB']->sql_free_result($dbres);
1182 }
1183 return $user;
1184 }
1185
1186 /**
1187 * Fetching raw user record with username=$name
1188 *
1189 * @param string The username to look up.
1190 * @return array user record or FALSE
1191 * @see t3lib_userAuth::getUserByUid()
1192 * @internal
1193 */
1194 function getRawUserByName($name) {
1195 $user = FALSE;
1196 $dbres = $GLOBALS['TYPO3_DB']->exec_SELECTquery('*', $this->user_table, 'username='.$GLOBALS['TYPO3_DB']->fullQuoteStr($name, $this->user_table).' '.$this->user_where_clause());
1197 if ($dbres) {
1198 $user = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($dbres);
1199 $GLOBALS['TYPO3_DB']->sql_free_result($dbres);
1200 }
1201 return $user;
1202 }
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218 /*************************
1219 *
1220 * Create/update user - EXPERIMENTAL
1221 *
1222 *************************/
1223
1224 /**
1225 * Get a user from DB by username
1226 * provided for usage from services
1227 *
1228 * @param array User db table definition: $this->db_user
1229 * @param string user name
1230 * @param string additional WHERE clause: " AND ...
1231 * @return mixed user array or FALSE
1232 */
1233 function fetchUserRecord($dbUser, $username, $extraWhere='' ) {
1234 $user = FALSE;
1235
1236 $usernameClause = $username ? ($dbUser['username_column'].'='.$GLOBALS['TYPO3_DB']->fullQuoteStr($username, $dbUser['table'])) : '';
1237
1238 if ($username || $extraWhere) {
1239
1240 // Look up the user by the username and/or extraWhere:
1241 $dbres = $GLOBALS['TYPO3_DB']->exec_SELECTquery(
1242 '*',
1243 $dbUser['table'],
1244 $usernameClause.
1245 $dbUser['check_pid_clause'].
1246 $dbUser['enable_clause'].
1247 $extraWhere
1248 );
1249
1250 if ($dbres) {
1251 $user = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($dbres);
1252 $GLOBALS['TYPO3_DB']->sql_free_result($dbres);
1253 }
1254 }
1255 return $user;
1256 }
1257 }
1258
1259
1260
1261 if (defined('TYPO3_MODE') && $TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['t3lib/class.t3lib_userauth.php']) {
1262 include_once($TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['t3lib/class.t3lib_userauth.php']);
1263 }
1264 ?>