2 /***************************************************************
5 * (c) 2004-2011 René Fritz <r.fritz@colorcube.de>
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.
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.
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.
25 * This copyright notice MUST APPEAR in all copies of the script!
26 ***************************************************************/
28 * Service base class for 'User authentication'.
30 * @author René Fritz <r.fritz@colorcube.de>
33 require_once(PATH_t3lib
. 'class.t3lib_svbase.php');
37 * Authentication services class
39 * @author René Fritz <r.fritz@colorcube.de>
43 class tx_sv_authbase
extends t3lib_svbase
{
45 var $pObj; // Parent object
47 var $mode; // Subtype of the service which is used to call the service.
49 var $login = array(); // Submitted login form data
50 var $authInfo = array(); // Various data
52 var $db_user = array(); // User db table definition
53 var $db_groups = array(); // Usergroups db table definition
55 var $writeAttemptLog = FALSE; // If the writelog() functions is called if a login-attempt has be tried without success
56 var $writeDevLog = FALSE; // If the t3lib_div::devLog() function should be used
60 * Initialize authentication service
62 * @param string Subtype of the service which is used to call the service.
63 * @param array Submitted login form data
64 * @param array Information array. Holds submitted form data etc.
65 * @param object Parent object
68 function initAuth($mode, $loginData, $authInfo, $pObj) {
72 $this->mode
= $mode; // sub type
73 $this->login
= $loginData;
74 $this->authInfo
= $authInfo;
76 $this->db_user
= $this->getServiceOption('db_user', $authInfo['db_user'], FALSE);
77 $this->db_groups
= $this->getServiceOption('db_groups', $authInfo['db_groups'], FALSE);
79 $this->writeAttemptLog
= $this->pObj
->writeAttemptLog
;
80 $this->writeDevLog
= $this->pObj
->writeDevLog
;
84 * Check the login data with the user record data for builtin login methods
86 * @param array user data array
87 * @param array login data array
88 * @param string security_level
89 * @return boolean TRUE if login data matched
91 function compareUident(array $user, array $loginData, $security_level = '') {
92 return $this->pObj
->compareUident($user, $loginData, $security_level);
96 * Writes to log database table in pObj
98 * @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
99 * @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 !!)
100 * @param integer $error: flag. 0 = message, 1 = error (user problem), 2 = System Error (which should not happen), 3 = security notice (admin)
101 * @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
102 * @param string $details: Default text that follows the message
103 * @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...
104 * @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.)
105 * @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.)
106 * @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.)
108 * @see t3lib_userauthgroup::writelog()
110 function writelog($type,$action,$error,$details_nr,$details,$data,$tablename='',$recuid='',$recpid='') {
111 if($this->writeAttemptLog
) {
112 $this->pObj
->writelog($type,$action,$error,$details_nr,$details,$data,$tablename,$recuid,$recpid);
125 /*************************
127 * create/update user - EXPERIMENTAL
129 *************************/
132 * Get a user from DB by username
134 * @param string user name
135 * @param string additional WHERE clause: " AND ...
136 * @param array User db table definition: $this->db_user
137 * @return mixed user array or FALSE
139 function fetchUserRecord($username, $extraWhere='', $dbUserSetup='') {
141 $dbUser = is_array($dbUserSetup) ?
$dbUserSetup : $this->db_user
;
142 $user = $this->pObj
->fetchUserRecord($dbUser, $username, $extraWhere);