Cleanup: Updated copyright comments
[Packages/TYPO3.CMS.git] / typo3 / sysext / sv / class.tx_sv_auth.php
1 <?php
2 /***************************************************************
3 * Copyright notice
4 *
5 * (c) 2004-2011 René Fritz <r.fritz@colorcube.de>
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 * Service 'User authentication' for the 'sv' extension.
29 *
30 * @author René Fritz <r.fritz@colorcube.de>
31 */
32 /**
33 * [CLASS/FUNCTION INDEX of SCRIPT]
34 *
35 *
36 *
37 * 56: class tx_sv_auth extends tx_sv_authbase
38 * 64: function getUser()
39 * 89: function authUser($user)
40 * 129: function getGroups($user, $knownGroups)
41 *
42 * TOTAL FUNCTIONS: 3
43 * (This index is automatically created/updated by the extension "extdeveval")
44 *
45 */
46
47
48
49 /**
50 * Authentication services class
51 *
52 * @author René Fritz <r.fritz@colorcube.de>
53 * @package TYPO3
54 * @subpackage tx_sv
55 */
56 class tx_sv_auth extends tx_sv_authbase {
57
58
59 /**
60 * Find a user (eg. look up the user record in database when a login is sent)
61 *
62 * @return mixed user array or false
63 */
64 function getUser() {
65 $user = false;
66
67 if ($this->login['status']=='login' && $this->login['uident']) {
68
69 $user = $this->fetchUserRecord($this->login['uname']);
70
71 if(!is_array($user)) {
72 // Failed login attempt (no username found)
73 $this->writelog(255,3,3,2,
74 "Login-attempt from %s (%s), username '%s' not found!!",
75 Array($this->authInfo['REMOTE_ADDR'], $this->authInfo['REMOTE_HOST'], $this->login['uname'])); // Logout written to log
76 t3lib_div::sysLog(
77 sprintf( "Login-attempt from %s (%s), username '%s' not found!", $this->authInfo['REMOTE_ADDR'], $this->authInfo['REMOTE_HOST'], $this->login['uname'] ),
78 'Core',
79 0
80 );
81 } else {
82 if ($this->writeDevLog) t3lib_div::devLog('User found: '.t3lib_div::arrayToLogString($user, array($this->db_user['userid_column'],$this->db_user['username_column'])), 'tx_sv_auth');
83 }
84 }
85 return $user;
86 }
87
88 /**
89 * Authenticate a user (Check various conditions for the user that might invalidate its authentication, eg. password match, domain, IP, etc.)
90 *
91 * @param array Data of user.
92 * @return boolean
93 */
94 function authUser($user) {
95 $OK = 100;
96
97 if ($this->login['uident'] && $this->login['uname']) {
98
99 // Checking password match for user:
100 $OK = $this->compareUident($user, $this->login);
101
102 if(!$OK) {
103 // Failed login attempt (wrong password) - write that to the log!
104 if ($this->writeAttemptLog) {
105 $this->writelog(255,3,3,1,
106 "Login-attempt from %s (%s), username '%s', password not accepted!",
107 Array($this->authInfo['REMOTE_ADDR'], $this->authInfo['REMOTE_HOST'], $this->login['uname']));
108 t3lib_div::sysLog(
109 sprintf( "Login-attempt from %s (%s), username '%s', password not accepted!", $this->authInfo['REMOTE_ADDR'], $this->authInfo['REMOTE_HOST'], $this->login['uname'] ),
110 'Core',
111 0
112 );
113 }
114 if ($this->writeDevLog) t3lib_div::devLog('Password not accepted: '.$this->login['uident'], 'tx_sv_auth', 2);
115 }
116
117 // Checking the domain (lockToDomain)
118 if ($OK && $user['lockToDomain'] && $user['lockToDomain']!=$this->authInfo['HTTP_HOST']) {
119 // Lock domain didn't match, so error:
120 if ($this->writeAttemptLog) {
121 $this->writelog(255,3,3,1,
122 "Login-attempt from %s (%s), username '%s', locked domain '%s' did not match '%s'!",
123 Array($this->authInfo['REMOTE_ADDR'], $this->authInfo['REMOTE_HOST'], $user[$this->db_user['username_column']], $user['lockToDomain'], $this->authInfo['HTTP_HOST']));
124 t3lib_div::sysLog(
125 sprintf( "Login-attempt from %s (%s), username '%s', locked domain '%s' did not match '%s'!", $this->authInfo['REMOTE_ADDR'], $this->authInfo['REMOTE_HOST'], $user[$this->db_user['username_column']], $user['lockToDomain'], $this->authInfo['HTTP_HOST'] ),
126 'Core',
127 0
128 );
129 }
130 $OK = false;
131 }
132 }
133
134 return $OK;
135 }
136
137 /**
138 * Find usergroup records, currently only for frontend
139 *
140 * @param array Data of user.
141 * @param array Group data array of already known groups. This is handy if you want select other related groups. Keys in this array are unique IDs of those groups.
142 * @return mixed Groups array, keys = uid which must be unique
143 */
144 function getGroups($user, $knownGroups) {
145 global $TYPO3_CONF_VARS;
146
147 $groupDataArr = array();
148
149 if($this->mode=='getGroupsFE') {
150
151 $groups = array();
152 if (is_array($user) && $user[$this->db_user['usergroup_column']]) {
153 $groupList = $user[$this->db_user['usergroup_column']];
154 $groups = array();
155 $this->getSubGroups($groupList,'',$groups);
156 }
157
158 // ADD group-numbers if the IPmask matches.
159 if (is_array($TYPO3_CONF_VARS['FE']['IPmaskMountGroups'])) {
160 foreach($TYPO3_CONF_VARS['FE']['IPmaskMountGroups'] as $IPel) {
161 if ($this->authInfo['REMOTE_ADDR'] && $IPel[0] && t3lib_div::cmpIP($this->authInfo['REMOTE_ADDR'],$IPel[0])) {$groups[]=intval($IPel[1]);}
162 }
163 }
164
165 $groups = array_unique($groups);
166
167 if (count($groups)) {
168 $list = implode(',',$groups);
169
170 if ($this->writeDevLog) t3lib_div::devLog('Get usergroups with id: '.$list, 'tx_sv_auth');
171
172 $lockToDomain_SQL = ' AND (lockToDomain=\'\' OR lockToDomain IS NULL OR lockToDomain=\''.$this->authInfo['HTTP_HOST'].'\')';
173 if (!$this->authInfo['showHiddenRecords']) $hiddenP = 'AND hidden=0 ';
174 $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery('*', $this->db_groups['table'], 'deleted=0 '.$hiddenP.' AND uid IN ('.$list.')'.$lockToDomain_SQL);
175 while ($row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res)) {
176 $groupDataArr[$row['uid']] = $row;
177 }
178 if ($res) $GLOBALS['TYPO3_DB']->sql_free_result($res);
179
180 } else {
181 if ($this->writeDevLog) t3lib_div::devLog('No usergroups found.', 'tx_sv_auth', 2);
182 }
183 } elseif ($this->mode=='getGroupsBE') {
184
185 # Get the BE groups here
186 # still needs to be implemented in t3lib_userauthgroup
187 }
188
189 return $groupDataArr;
190 }
191
192 /**
193 * Fetches subgroups of groups. Function is called recursively for each subgroup.
194 * Function was previously copied from t3lib_userAuthGroup->fetchGroups and has been slightly modified.
195 *
196 * @param string Commalist of fe_groups uid numbers
197 * @param string List of already processed fe_groups-uids so the function will not fall into a eternal recursion.
198 * @return array
199 * @access private
200 */
201 function getSubGroups($grList, $idList='', &$groups) {
202
203 // Fetching records of the groups in $grList (which are not blocked by lockedToDomain either):
204 $lockToDomain_SQL = ' AND (lockToDomain=\'\' OR lockToDomain IS NULL OR lockToDomain=\''.$this->authInfo['HTTP_HOST'].'\')';
205 if (!$this->authInfo['showHiddenRecords']) $hiddenP = 'AND hidden=0 ';
206 $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery('uid,subgroup', 'fe_groups', 'deleted=0 '.$hiddenP.' AND uid IN ('.$grList.')'.$lockToDomain_SQL);
207
208 $groupRows = array(); // Internal group record storage
209
210 // The groups array is filled
211 while ($row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res)) {
212 if(!in_array($row['uid'], $groups)) { $groups[] = $row['uid']; }
213 $groupRows[$row['uid']] = $row;
214 }
215
216 // Traversing records in the correct order
217 $include_staticArr = t3lib_div::intExplode(',', $grList);
218 foreach($include_staticArr as $uid) { // traversing list
219
220 // Get row:
221 $row=$groupRows[$uid];
222 if (is_array($row) && !t3lib_div::inList($idList,$uid)) { // Must be an array and $uid should not be in the idList, because then it is somewhere previously in the grouplist
223
224 // Include sub groups
225 if (trim($row['subgroup'])) {
226 $theList = implode(',',t3lib_div::intExplode(',',$row['subgroup'])); // Make integer list
227 $this->getSubGroups($theList, $idList.','.$uid, $groups); // Call recursively, pass along list of already processed groups so they are not recursed again.
228 }
229 }
230 }
231 }
232 }
233
234
235
236 if (defined('TYPO3_MODE') && isset($GLOBALS['TYPO3_CONF_VARS'][TYPO3_MODE]['XCLASS']['ext/sv/class.tx_sv_auth.php'])) {
237 include_once($GLOBALS['TYPO3_CONF_VARS'][TYPO3_MODE]['XCLASS']['ext/sv/class.tx_sv_auth.php']);
238 }
239 ?>