*** empty log message ***
[Packages/TYPO3.CMS.git] / t3lib / class.t3lib_userauthgroup.php
1 <?php
2 /***************************************************************
3 * Copyright notice
4 *
5 * (c) 1999-2004 Kasper Skaarhoj (kasper@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 an extension class specifically for authentication/initialization of backend users in TYPO3
29 *
30 * $Id$
31 * Revised for TYPO3 3.6 July/2003 by Kasper Skaarhoj
32 *
33 * @author Kasper Skaarhoj <kasper@typo3.com>
34 */
35 /**
36 * [CLASS/FUNCTION INDEX of SCRIPT]
37 *
38 *
39 *
40 * 112: class t3lib_userAuthGroup extends t3lib_userAuth
41 *
42 * SECTION: Permission checking functions:
43 * 170: function isAdmin()
44 * 182: function isMemberOfGroup($groupId)
45 * 204: function doesUserHaveAccess($row,$perms)
46 * 221: function isInWebMount($id,$readPerms='',$exitOnError=0)
47 * 248: function modAccess($conf,$exitOnError)
48 * 284: function getPagePermsClause($perms)
49 * 310: function calcPerms($row)
50 * 333: function isRTE()
51 * 367: function check ($type,$value)
52 * 384: function isPSet($lCP,$table,$type='')
53 * 401: function mayMakeShortcut()
54 *
55 * SECTION: Miscellaneous functions
56 * 429: function getTSConfig($objectString,$config='')
57 * 455: function getTSConfigVal($objectString)
58 * 467: function getTSConfigProp($objectString)
59 * 479: function inList($in_list,$item)
60 * 489: function returnWebmounts()
61 * 499: function returnFilemounts()
62 *
63 * SECTION: Authentication methods
64 * 529: function fetchGroupData()
65 * 648: function fetchGroups($grList,$idList='')
66 * 717: function setCachedList($cList)
67 * 737: function addFileMount($title, $altTitle, $path, $webspace, $type)
68 * 784: function addTScomment($str)
69 *
70 * SECTION: Logging
71 * 831: function writelog($type,$action,$error,$details_nr,$details,$data,$tablename='',$recuid='',$recpid='',$event_pid=-1,$NEWid='')
72 * 864: function checkLogFailures($email, $secondsBack=3600, $max=3)
73 *
74 * TOTAL FUNCTIONS: 24
75 * (This index is automatically created/updated by the extension "extdeveval")
76 *
77 */
78
79 // Need this for parsing User TSconfig
80 require_once (PATH_t3lib.'class.t3lib_tsparser.php');
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102 /**
103 * Extension to class.t3lib_userauth.php; Authentication of users in TYPO3 Backend
104 *
105 * Actually this class is extended again by t3lib_beuserauth which is the actual backend user class that will be instantiated.
106 * In fact the two classes t3lib_beuserauth and this class could just as well be one, single class since t3lib_userauthgroup is not - to my knowledge - used separately elsewhere. But for historical reasons they are two separate classes.
107 *
108 * @author Kasper Skaarhoj <kasper@typo3.com>
109 * @package TYPO3
110 * @subpackage t3lib
111 */
112 class t3lib_userAuthGroup extends t3lib_userAuth {
113 var $usergroup_column = 'usergroup'; // Should be set to the usergroup-column (id-list) in the user-record
114 var $usergroup_table = 'be_groups'; // The name of the group-table
115
116 // internal
117 var $groupData = Array( // This array holds lists of eg. tables, fields and other values related to the permission-system. See fetchGroupData
118 'filemounts' => Array() // Filemounts are loaded here
119 );
120
121 var $userGroups = Array(); // This array will hold the groups that the user is a member of
122 var $userGroupsUID = Array(); // This array holds the uid's of the groups in the listed order
123 var $groupList =''; // This is $this->userGroupsUID imploded to a comma list... Will correspond to the 'usergroup_cached_list'
124 var $dataLists=array( // Used internally to accumulate data for the user-group. DONT USE THIS EXTERNALLY! Use $this->groupData instead
125 'webmount_list'=>'',
126 'filemount_list'=>'',
127 'modList'=>'',
128 'tables_select'=>'',
129 'tables_modify'=>'',
130 'pagetypes_select'=>'',
131 'non_exclude_fields'=>'',
132 'explicit_allowdeny'=>'',
133 'allowed_languages' => '',
134 'custom_options' => '',
135 );
136 var $includeHierarchy=array(); // For debugging/display of order in which subgroups are included.
137 var $includeGroupArray=array(); // List of group_id's in the order they are processed.
138
139 var $OS=''; // Set to 'WIN', if windows
140 var $TSdataArray=array(); // Used to accumulate the TSconfig data of the user
141 var $userTS_text = ''; // Contains the non-parsed user TSconfig
142 var $userTS = array(); // Contains the parsed user TSconfig
143 var $userTSUpdated=0; // Set internally if the user TSconfig was parsed and needs to be cached.
144 var $userTS_dontGetCached=0; // Set this from outside if you want the user TSconfig to ALWAYS be parsed and not fetched from cache.
145
146 var $RTE_errors = array(); // RTE availability errors collected.
147 var $errorMsg = ''; // Contains last error message
148
149
150
151
152
153
154
155
156
157
158
159
160
161 /************************************
162 *
163 * Permission checking functions:
164 *
165 ************************************/
166
167 /**
168 * Returns true if user is admin
169 * Basically this function evaluates if the ->user[admin] field has bit 0 set. If so, user is admin.
170 *
171 * @return boolean
172 */
173 function isAdmin() {
174 return (($this->user['admin']&1) ==1);
175 }
176
177 /**
178 * Returns true if the current user is a member of group $groupId
179 * $groupId must be set. $this->groupList must contain groups
180 * Will return true also if the user is a member of a group through subgroups.
181 *
182 * @param integer Group ID to look for in $this->groupList
183 * @return boolean
184 */
185 function isMemberOfGroup($groupId) {
186 $groupId = intval($groupId);
187 if ($this->groupList && $groupId) {
188 return $this->inList($this->groupList, $groupId);
189 }
190 }
191
192 /**
193 * Checks if the permissions is granted based on a page-record ($row) and $perms (binary and'ed)
194 *
195 * Bits for permissions, see $perms variable:
196 *
197 * 1 - Show: See/Copy page and the pagecontent.
198 * 16- Edit pagecontent: Change/Add/Delete/Move pagecontent.
199 * 2- Edit page: Change/Move the page, eg. change title, startdate, hidden.
200 * 4- Delete page: Delete the page and pagecontent.
201 * 8- New pages: Create new pages under the page.
202 *
203 * @param array $row is the pagerow for which the permissions is checked
204 * @param integer $perms is the binary representation of the permission we are going to check. Every bit in this number represents a permission that must be set. See function explanation.
205 * @return boolean True or False upon evaluation
206 */
207 function doesUserHaveAccess($row,$perms) {
208 $userPerms = $this->calcPerms($row);
209 return ($userPerms & $perms)==$perms;
210 }
211
212 /**
213 * Checks if the page id, $id, is found within the webmounts set up for the user.
214 * This should ALWAYS be checked for any page id a user works with, whether it's about reading, writing or whatever.
215 * The point is that this will add the security that a user can NEVER touch parts outside his mounted pages in the page tree. This is otherwise possible if the raw page permissions allows for it. So this security check just makes it easier to make safe user configurations.
216 * If the user is admin OR if this feature is disabled (fx. by setting TYPO3_CONF_VARS['BE']['lockBeUserToDBmounts']=0) then it returns "1" right away
217 * Otherwise the function will return the uid of the webmount which was first found in the rootline of the input page $id
218 *
219 * @param integer Page ID to check
220 * @param string Content of "->getPagePermsClause(1)" (read-permissions). If not set, they will be internally calculated (but if you have the correct value right away you can save that database lookup!)
221 * @param boolean If set, then the function will exit with an error message.
222 * @return integer The page UID of a page in the rootline that matched a mount point
223 */
224 function isInWebMount($id,$readPerms='',$exitOnError=0) {
225 if (!$GLOBALS['TYPO3_CONF_VARS']['BE']['lockBeUserToDBmounts'] || $this->isAdmin()) return 1;
226 $id = intval($id);
227 if (!$readPerms) $readPerms = $this->getPagePermsClause(1);
228 if ($id>0) {
229 $wM = $this->returnWebmounts();
230 $rL = t3lib_BEfunc::BEgetRootLine($id,' AND '.$readPerms);
231
232 foreach($rL as $v) {
233 if ($v['uid'] && in_array($v['uid'],$wM)) {
234 return $v['uid'];
235 }
236 }
237 }
238 if ($exitOnError) {
239 t3lib_BEfunc::typo3PrintError ('Access Error','This page is not within your DB-mounts',0);
240 exit;
241 }
242 }
243
244 /**
245 * Checks access to a backend module with the $MCONF passed as first argument
246 *
247 * @param array $MCONF array of a backend module!
248 * @param boolean If set, an array will issue an error message and exit.
249 * @return boolean Will return true if $MCONF['access'] is not set at all, if the BE_USER is admin or if the module is enabled in the be_users/be_groups records of the user (specifically enabled). Will return false if the module name is not even found in $TBE_MODULES
250 */
251 function modAccess($conf,$exitOnError) {
252 if (!t3lib_BEfunc::isModuleSetInTBE_MODULES($conf['name'])) {
253 if ($exitOnError) {
254 t3lib_BEfunc::typo3PrintError ('Fatal Error','This module "'.$conf['name'].'" is not enabled in TBE_MODULES',0);
255 exit;
256 }
257 return false;
258 }
259
260 // Returns true if conf[access] is not set at all or if the user is admin
261 if (!$conf['access'] || $this->isAdmin()) return true;
262
263 // If $conf['access'] is set but not with 'admin' then we return true, if the module is found in the modList
264 if (!strstr($conf['access'],'admin') && $conf['name']) {
265 $acs = $this->check('modules',$conf['name']);
266 }
267 if (!$acs && $exitOnError) {
268 t3lib_BEfunc::typo3PrintError ('Access Error','You don\'t have access to this module.',0);
269 exit;
270 } else return $acs;
271 }
272
273 /**
274 * Returns a WHERE-clause for the pages-table where user permissions according to input argument, $perms, is validated.
275 * $perms is the 'mask' used to select. Fx. if $perms is 1 then you'll get all pages that a user can actually see!
276 * 2^0 = show (1)
277 * 2^1 = edit (2)
278 * 2^2 = delete (4)
279 * 2^3 = new (8)
280 * If the user is 'admin' " 1=1" is returned (no effect)
281 * If the user is not set at all (->user is not an array), then " 1=0" is returned (will cause no selection results at all)
282 * The 95% use of this function is "->getPagePermsClause(1)" which will return WHERE clauses for *selecting* pages in backend listings - in other words will this check read permissions.
283 *
284 * @param integer Permission mask to use, see function description
285 * @return string Part of where clause. Prefix " AND " to this.
286 */
287 function getPagePermsClause($perms) {
288 if (is_array($this->user)) {
289 if ($this->isAdmin()) {
290 return ' 1=1';
291 }
292
293 $perms = intval($perms); // Make sure it's integer.
294 $str= ' ('.
295 '(pages.perms_everybody & '.$perms.' = '.$perms.')'. // Everybody
296 'OR(pages.perms_userid = '.$this->user['uid'].' AND pages.perms_user & '.$perms.' = '.$perms.')'; // User
297 if ($this->groupList){$str.='OR(pages.perms_groupid in ('.$this->groupList.') AND pages.perms_group & '.$perms.' = '.$perms.')';} // Group (if any is set)
298 $str.=')';
299 return $str;
300 } else {
301 return ' 1=0';
302 }
303 }
304
305 /**
306 * Returns a combined binary representation of the current users permissions for the page-record, $row.
307 * The perms for user, group and everybody is OR'ed together (provided that the page-owner is the user and for the groups that the user is a member of the group
308 * If the user is admin, 31 is returned (full permissions for all five flags)
309 *
310 * @param array Input page row with all perms_* fields available.
311 * @return integer Bitwise representation of the users permissions in relation to input page row, $row
312 */
313 function calcPerms($row) {
314 if ($this->isAdmin()) {return 31;} // Return 31 for admin users.
315
316 $out=0;
317 if (isset($row['perms_userid']) && isset($row['perms_user']) && isset($row['perms_groupid']) && isset($row['perms_group']) && isset($row['perms_everybody']) && isset($this->groupList)) {
318 if ($this->user['uid']==$row['perms_userid']) {
319 $out|=$row['perms_user'];
320 }
321 if ($this->isMemberOfGroup($row['perms_groupid'])) {
322 $out|=$row['perms_group'];
323 }
324 $out|=$row['perms_everybody'];
325 }
326 return $out;
327 }
328
329 /**
330 * Returns true if the RTE (Rich Text Editor) can be enabled for the user
331 * Strictly this is not permissions being checked but rather a series of settings like a loaded extension, browser/client type and a configuration option in ->uc[edit_RTE]
332 * The reasons for a FALSE return can be found in $this->RTE_errors
333 *
334 * @return boolean
335 */
336 function isRTE() {
337 global $CLIENT;
338
339 // Start:
340 $this->RTE_errors = array();
341 if (!$this->uc['edit_RTE'])
342 $this->RTE_errors[] = 'RTE is not enabled for user!';
343 if (!$GLOBALS['TYPO3_CONF_VARS']['BE']['RTEenabled'])
344 $this->RTE_errors[] = 'RTE is not enabled in $TYPO3_CONF_VARS["BE"]["RTEenabled"]';
345
346
347 // Acquire RTE object:
348 $RTE = &t3lib_BEfunc::RTEgetObj();
349 if (!is_object($RTE)) {
350 $this->RTE_errors = array_merge($this->RTE_errors, $RTE);
351 }
352
353 if (!count($this->RTE_errors)) {
354 return TRUE;
355 } else {
356 return FALSE;
357 }
358 }
359
360 /**
361 * Returns true if the $value is found in the list in a $this->groupData[] index pointed to by $type (array key).
362 * Can thus be users to check for modules, exclude-fields, select/modify permissions for tables etc.
363 * If user is admin true is also returned
364 * Please see the document Inside TYPO3 for examples.
365 *
366 * @param string The type value; "webmounts", "filemounts", "pagetypes_select", "tables_select", "tables_modify", "non_exclude_fields", "modules"
367 * @param string String to search for in the groupData-list
368 * @return boolean True if permission is granted (that is, the value was found in the groupData list - or the BE_USER is "admin")
369 */
370 function check($type,$value) {
371 if (isset($this->groupData[$type])) {
372 if ($this->isAdmin() || $this->inList($this->groupData[$type],$value)) {
373 return 1;
374 }
375 }
376 }
377
378 /**
379 * Checking the authMode of a select field with authMode set
380 *
381 * @param string Table name
382 * @param string Field name (must be configured in TCA and of type "select" with authMode set!)
383 * @param string Value to evaluation (single value, must not contain any of the chars ":,|")
384 * @param string Auth mode keyword (explicitAllow, explicitDeny, individual)
385 * @return boolean True or false whether access is granted or not.
386 */
387 function checkAuthMode($table,$field,$value,$authMode) {
388 global $TCA;
389
390 // Admin users can do anything:
391 if ($this->isAdmin()) return TRUE;
392
393 // Allow all blank values:
394 if (!strcmp($value,'')) return TRUE;
395
396 // Certain characters are not allowed in the value
397 if (ereg('[:|,]',$value)) {
398 return FALSE;
399 }
400
401 // Initialize:
402 $testValue = $table.':'.$field.':'.$value;
403 $out = TRUE;
404
405 // Checking value:
406 switch((string)$authMode) {
407 case 'explicitAllow':
408 if (!$this->inList($this->groupData['explicit_allowdeny'],$testValue.':ALLOW')) {
409 $out = FALSE;
410 }
411 break;
412 case 'explicitDeny':
413 if ($this->inList($this->groupData['explicit_allowdeny'],$testValue.':DENY')) {
414 $out = FALSE;
415 }
416 break;
417 case 'individual':
418 t3lib_div::loadTCA($table);
419 if (is_array($TCA[$table]) && is_array($TCA[$table]['columns'][$field])) {
420 $items = $TCA[$table]['columns'][$field]['config']['items'];
421 if (is_array($items)) {
422 foreach($items as $iCfg) {
423 if (!strcmp($iCfg[1],$value) && $iCfg[4]) {
424 switch((string)$iCfg[4]) {
425 case 'EXPL_ALLOW':
426 if (!$this->inList($this->groupData['explicit_allowdeny'],$testValue.':ALLOW')) {
427 $out = FALSE;
428 }
429 break;
430 case 'EXPL_DENY':
431 if ($this->inList($this->groupData['explicit_allowdeny'],$testValue.':DENY')) {
432 $out = FALSE;
433 }
434 break;
435 }
436 break;
437 }
438 }
439 }
440 }
441 break;
442 }
443
444 return $out;
445 }
446
447 /**
448 * Checking if a language value (-1, 0 and >0 for sys_language records) is allowed to be edited by the user.
449 *
450 * @param integer Language value to evaluate
451 * @return boolean Returns true if the language value is allowed, otherwise false.
452 */
453 function checkLanguageAccess($langValue) {
454 if (strcmp($this->groupData['allowed_languages'],'')) { // The users language list must be non-blank - otherwise all languages are allowed.
455 $langValue = intval($langValue);
456 if ($langValue != -1 && !$this->check('allowed_languages',$langValue)) { // Language must either be explicitly allowed OR the lang Value be "-1" (all languages)
457 return FALSE;
458 }
459 }
460 return TRUE;
461 }
462
463 /**
464 * Checking if a user has editing access to a record from a $TCA table.
465 * The checks does not take page permissions and other "environmental" things into account. It only deal with record internals; If any values in the record fields disallows it.
466 * For instance languages settings, authMode selector boxes are evaluated (and maybe more in the future).
467 * The function takes an ID (integer) or row (array) as second argument.
468 *
469 * @param string Table name
470 * @param mixed If integer, then this is the ID of the record. If Array this just represents fields in the record.
471 * @return boolean True if OK, otherwise false
472 */
473 function recordEditAccessInternals($table,$idOrRow) {
474 global $TCA;
475
476 if (isset($TCA[$table])) {
477 t3lib_div::loadTCA($table);
478
479 // Always return true for Admin users.
480 if ($this->isAdmin()) return TRUE;
481
482 // Fetching the record if the $idOrRow variable was not an array on input:
483 if (!is_array($idOrRow)) {
484 $idOrRow = t3lib_BEfunc::getRecord($table, $idOrRow);
485 if (!is_array($idOrRow)) {
486 $this->errorMsg = 'ERROR: Record could not be fetched.';
487 return FALSE;
488 }
489 }
490
491 // Checking languages:
492 if ($TCA[$table]['ctrl']['languageField']) {
493 if (isset($idOrRow[$TCA[$table]['ctrl']['languageField']])) { // Language field must be found in input row - otherwise it does not make sense.
494 if (!$this->checkLanguageAccess($idOrRow[$TCA[$table]['ctrl']['languageField']])) {
495 $this->errorMsg = 'ERROR: Language was not allowed.';
496 return FALSE;
497 }
498 }
499 }
500
501 // Checking authMode fields:
502 if (is_array($TCA[$table]['columns'])) {
503 foreach($TCA[$table]['columns'] as $fN => $fV) {
504 if (isset($idOrRow[$fN])) { //
505 if ($fV['config']['type']=='select' && $fV['config']['authMode'] && !strcmp($fV['config']['authMode_enforce'],'strict')) {
506 if (!$this->checkAuthMode($table,$fN,$idOrRow[$fN],$fV['config']['authMode'])) {
507 $this->errorMsg = 'ERROR: authMode "'.$fV['config']['authMode'].'" failed for field "'.$fN.'" with value "'.$idOrRow[$fN].'" evaluated';
508 return FALSE;
509 }
510 }
511 }
512 }
513 }
514
515 // Checking "editlock" feature
516 if ($TCA[$table]['ctrl']['editlock'] && $idOrRow[$TCA[$table]['ctrl']['editlock']]) {
517 $this->errorMsg = 'ERROR: Record was locked for editing. Only admin users can change this state.';
518 return FALSE;
519 }
520
521 // Checking record permissions
522 // THIS is where we can include a check for "perms_" fields for other records than pages...
523
524 // Finally, return true if all is well.
525 return TRUE;
526 }
527 }
528
529 /**
530 * Will check a type of permission against the compiled permission integer, $lCP, and in relation to table, $table
531 *
532 * @param integer $lCP could typically be the "compiled permissions" integer returned by ->calcPerms
533 * @param string $table is the tablename to check: If "pages" table then edit,new,delete and editcontent permissions can be checked. Other tables will be checked for "editcontent" only (and $type will be ignored)
534 * @param string For $table='pages' this can be 'edit' (2), 'new' (8 or 16), 'delete' (4), 'editcontent' (16). For all other tables this is ignored. (16 is used)
535 * @return boolean
536 * @access private
537 */
538 function isPSet($lCP,$table,$type='') {
539 if ($this->isAdmin()) return true;
540 if ($table=='pages') {
541 if ($type=='edit') return $lCP & 2;
542 if ($type=='new') return ($lCP & 8) || ($lCP & 16); // Create new page OR pagecontent
543 if ($type=='delete') return $lCP & 4;
544 if ($type=='editcontent') return $lCP & 16;
545 } else {
546 return $lCP & 16;
547 }
548 }
549
550 /**
551 * Returns true if the BE_USER is allowed to *create* shortcuts in the backend modules
552 *
553 * @return boolean
554 */
555 function mayMakeShortcut() {
556 return $this->getTSConfigVal('options.shortcutFrame') && !$this->getTSConfigVal('options.mayNotCreateEditShortcuts');
557 }
558
559
560
561
562
563
564
565
566
567
568 /*************************************
569 *
570 * Miscellaneous functions
571 *
572 *************************************/
573
574 /**
575 * Returns the value/properties of a TS-object as given by $objectString, eg. 'options.dontMountAdminMounts'
576 * Nice (general!) function for returning a part of a TypoScript array!
577 *
578 * @param string Pointer to an "object" in the TypoScript array, fx. 'options.dontMountAdminMounts'
579 * @param array Optional TSconfig array: If array, then this is used and not $this->userTS. If not array, $this->userTS is used.
580 * @return array An array with two keys, "value" and "properties" where "value" is a string with the value of the objectsting and "properties" is an array with the properties of the objectstring.
581 * @params array An array with the TypoScript where the $objectString is located. If this argument is not an array, then internal ->userTS (User TSconfig for the current BE_USER) will be used instead.
582 */
583 function getTSConfig($objectString,$config='') {
584 if (!is_array($config)) {
585 $config=$this->userTS; // Getting Root-ts if not sent
586 }
587 $TSConf=array();
588 $parts = explode('.',$objectString,2);
589 $key = $parts[0];
590 if (trim($key)) {
591 if (count($parts)>1 && trim($parts[1])) {
592 // Go on, get the next level
593 if (is_array($config[$key.'.'])) $TSConf = $this->getTSConfig($parts[1],$config[$key.'.']);
594 } else {
595 $TSConf['value']=$config[$key];
596 $TSConf['properties']=$config[$key.'.'];
597 }
598 }
599 return $TSConf;
600 }
601
602 /**
603 * Returns the "value" of the $objectString from the BE_USERS "User TSconfig" array
604 *
605 * @param string Object string, eg. "somestring.someproperty.somesubproperty"
606 * @return string The value for that object string (object path)
607 * @see getTSConfig()
608 */
609 function getTSConfigVal($objectString) {
610 $TSConf = $this->getTSConfig($objectString);
611 return $TSConf['value'];
612 }
613
614 /**
615 * Returns the "properties" of the $objectString from the BE_USERS "User TSconfig" array
616 *
617 * @param string Object string, eg. "somestring.someproperty.somesubproperty"
618 * @return array The properties for that object string (object path) - if any
619 * @see getTSConfig()
620 */
621 function getTSConfigProp($objectString) {
622 $TSConf = $this->getTSConfig($objectString);
623 return $TSConf['properties'];
624 }
625
626 /**
627 * Returns true if $item is in $in_list
628 *
629 * @param string Comma list with items, no spaces between items!
630 * @param string The string to find in the list of items
631 * @return string Boolean
632 */
633 function inList($in_list,$item) {
634 return strstr(','.$in_list.',', ','.$item.',');
635 }
636
637 /**
638 * Returns an array with the webmounts.
639 * If no webmounts, and empty array is returned.
640 * NOTICE: Deleted pages WILL NOT be filtered out! So if a mounted page has been deleted it is STILL coming out as a webmount. This is not checked due to performance.
641 *
642 * @return array
643 */
644 function returnWebmounts() {
645 return (string)($this->groupData['webmounts'])!='' ? explode(',',$this->groupData['webmounts']) : Array();
646 }
647
648 /**
649 * Returns an array with the filemounts for the user. Each filemount is represented with an array of a "name", "path" and "type".
650 * If no filemounts an empty array is returned.
651 *
652 * @return array
653 */
654 function returnFilemounts() {
655 return $this->groupData['filemounts'];
656 }
657
658
659
660
661
662
663
664
665
666
667
668
669 /*************************************
670 *
671 * Authentication methods
672 *
673 *************************************/
674
675
676 /**
677 * Initializes a lot of stuff like the access-lists, database-mountpoints and filemountpoints
678 * This method is called by ->backendCheckLogin() (from extending class t3lib_beuserauth) if the backend user login has verified OK.
679 *
680 * @return void
681 * @access private
682 * @see t3lib_TSparser
683 */
684 function fetchGroupData() {
685 if ($this->user['uid']) {
686
687 // Get lists for the be_user record and set them as default/primary values.
688 $this->dataLists['modList'] = $this->user['userMods']; // Enabled Backend Modules
689 $this->dataLists['allowed_languages'] = $this->user['allowed_languages']; // Add Allowed Languages
690 $this->dataLists['webmount_list'] = $this->user['db_mountpoints']; // Database mountpoints
691 $this->dataLists['filemount_list'] = $this->user['file_mountpoints']; // File mountpoints
692
693 // Setting default User TSconfig:
694 $this->TSdataArray[]=$this->addTScomment('From $GLOBALS["TYPO3_CONF_VARS"]["BE"]["defaultUserTSconfig"]:').
695 $GLOBALS['TYPO3_CONF_VARS']['BE']['defaultUserTSconfig'];
696
697 // Default TSconfig for admin-users
698 if ($this->isAdmin()) {
699 $this->TSdataArray[]=$this->addTScomment('"admin" user presets:').'
700 admPanel.enable.all = 1
701 options.shortcutFrame = 1
702 ';
703 if (t3lib_extMgm::isLoaded('tt_news')) {
704 $this->TSdataArray[]='
705 // Setting defaults for tt_news author / email...
706 TCAdefaults.tt_news.author = '.$this->user['realName'].'
707 TCAdefaults.tt_news.author_email = '.$this->user['email'].'
708 ';
709 }
710 if (t3lib_extMgm::isLoaded('sys_note')) {
711 $this->TSdataArray[]='
712 // Setting defaults for sys_note author / email...
713 TCAdefaults.sys_note.author = '.$this->user['realName'].'
714 TCAdefaults.sys_note.email = '.$this->user['email'].'
715 ';
716 }
717 }
718
719 // FILE MOUNTS:
720 // Admin users has the base fileadmin dir mounted
721 if ($this->isAdmin() && $GLOBALS['TYPO3_CONF_VARS']['BE']['fileadminDir']) {
722 $this->addFileMount($GLOBALS['TYPO3_CONF_VARS']['BE']['fileadminDir'], '', PATH_site.$GLOBALS['TYPO3_CONF_VARS']['BE']['fileadminDir'], 0, '');
723 }
724
725 // If userHomePath is set, we attempt to mount it
726 if ($GLOBALS['TYPO3_CONF_VARS']['BE']['userHomePath']) {
727 // First try and mount with [uid]_[username]
728 $didMount=$this->addFileMount($this->user['username'], '',$GLOBALS['TYPO3_CONF_VARS']['BE']['userHomePath'].$this->user['uid'].'_'.$this->user['username'].$GLOBALS['TYPO3_CONF_VARS']['BE']['userUploadDir'], 0, 'user');
729 if (!$didMount) {
730 // If that failed, try and mount with only [uid]
731 $this->addFileMount($this->user['username'], '', $GLOBALS['TYPO3_CONF_VARS']['BE']['userHomePath'].$this->user['uid'].$GLOBALS['TYPO3_CONF_VARS']['BE']['userUploadDir'], 0, 'user');
732 }
733 }
734
735 // BE_GROUPS:
736 // Get the groups...
737 # $grList = t3lib_BEfunc::getSQLselectableList($this->user[$this->usergroup_column],$this->usergroup_table,$this->usergroup_table);
738 $grList = $GLOBALS['TYPO3_DB']->cleanIntList($this->user[$this->usergroup_column]); // 240203: Since the group-field never contains any references to groups with a prepended table name we think it's safe to just intExplode and re-implode - which should be much faster than the other function call.
739 if ($grList) {
740 // Fetch groups will add a lot of information to the internal arrays: modules, accesslists, TSconfig etc. Refer to fetchGroups() function.
741 $this->fetchGroups($grList);
742 }
743
744 // Add the TSconfig for this specific user:
745 $this->TSdataArray[] = $this->addTScomment('USER TSconfig field').$this->user['TSconfig'];
746 // Check include lines.
747 $this->TSdataArray = t3lib_TSparser::checkIncludeLines_array($this->TSdataArray);
748
749 // Parsing the user TSconfig (or getting from cache)
750 $this->userTS_text = implode(chr(10).'[GLOBAL]'.chr(10),$this->TSdataArray); // Imploding with "[global]" will make sure that non-ended confinements with braces are ignored.
751 $hash = md5('userTS:'.$this->userTS_text);
752 $cachedContent = t3lib_BEfunc::getHash($hash,0);
753 if (isset($cachedContent) && !$this->userTS_dontGetCached) {
754 $this->userTS = unserialize($cachedContent);
755 } else {
756 $parseObj = t3lib_div::makeInstance('t3lib_TSparser');
757 $parseObj->parse($this->userTS_text);
758 $this->userTS = $parseObj->setup;
759 t3lib_BEfunc::storeHash($hash,serialize($this->userTS),'BE_USER_TSconfig');
760 // Update UC:
761 $this->userTSUpdated=1;
762 }
763
764 // Processing webmounts
765 if ($this->isAdmin() && !$this->getTSConfigVal('options.dontMountAdminMounts')) { // Admin's always have the root mounted
766 $this->dataLists['webmount_list']='0,'.$this->dataLists['webmount_list'];
767 }
768
769 // Processing filemounts
770 $this->dataLists['filemount_list'] = t3lib_div::uniqueList($this->dataLists['filemount_list']);
771 if ($this->dataLists['filemount_list']) {
772 $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery('*', 'sys_filemounts', 'NOT deleted AND NOT hidden AND pid=0 AND uid IN ('.$this->dataLists['filemount_list'].')');
773 while ($row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res)) {
774 $this->addFileMount($row['title'], $row['path'], $row['path'], $row['base']?1:0, '');
775 }
776 }
777
778 // The lists are cleaned for duplicates
779 $this->groupData['webmounts'] = t3lib_div::uniqueList($this->dataLists['webmount_list']);
780 $this->groupData['pagetypes_select'] = t3lib_div::uniqueList($this->dataLists['pagetypes_select']);
781 $this->groupData['tables_select'] = t3lib_div::uniqueList($this->dataLists['tables_modify'].','.$this->dataLists['tables_select']);
782 $this->groupData['tables_modify'] = t3lib_div::uniqueList($this->dataLists['tables_modify']);
783 $this->groupData['non_exclude_fields'] = t3lib_div::uniqueList($this->dataLists['non_exclude_fields']);
784 $this->groupData['explicit_allowdeny'] = t3lib_div::uniqueList($this->dataLists['explicit_allowdeny']);
785 $this->groupData['allowed_languages'] = t3lib_div::uniqueList($this->dataLists['allowed_languages']);
786 $this->groupData['custom_options'] = t3lib_div::uniqueList($this->dataLists['custom_options']);
787 $this->groupData['modules'] = t3lib_div::uniqueList($this->dataLists['modList']);
788
789 // populating the $this->userGroupsUID -array with the groups in the order in which they were LAST included.!!
790 $this->userGroupsUID = array_reverse(array_unique(array_reverse($this->includeGroupArray)));
791
792 // Finally this is the list of group_uid's in the order they are parsed (including subgroups!) and without duplicates (duplicates are presented with their last entrance in the list, which thus reflects the order of the TypoScript in TSconfig)
793 $this->groupList = implode(',',$this->userGroupsUID);
794 $this->setCachedList($this->groupList);
795 }
796 }
797
798 /**
799 * Fetches the group records, subgroups and fills internal arrays.
800 * Function is called recursively to fetch subgroups
801 *
802 * @param string Commalist of be_groups uid numbers
803 * @param string List of already processed be_groups-uids so the function will not fall into a eternal recursion.
804 * @return void
805 * @access private
806 */
807 function fetchGroups($grList,$idList='') {
808
809 // Fetching records of the groups in $grList (which are not blocked by lockedToDomain either):
810 $lockToDomain_SQL = ' AND (lockToDomain="" OR lockToDomain="'.t3lib_div::getIndpEnv('HTTP_HOST').'")';
811 $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery('*', $this->usergroup_table, 'NOT deleted AND NOT hidden AND pid=0 AND uid IN ('.$grList.')'.$lockToDomain_SQL);
812
813 // The userGroups array is filled
814 while ($row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res)) {
815 $this->userGroups[$row['uid']] = $row;
816 }
817
818 // Traversing records in the correct order
819 $include_staticArr = t3lib_div::intExplode(',',$grList);
820 reset($include_staticArr);
821 while(list(,$uid)=each($include_staticArr)) { // traversing list
822
823 // Get row:
824 $row=$this->userGroups[$uid];
825 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
826
827 // Include sub groups
828 if (trim($row['subgroup'])) {
829 $theList = implode(',',t3lib_div::intExplode(',',$row['subgroup'])); // Make integer list
830 $this->fetchGroups($theList, $idList.','.$uid); // Call recursively, pass along list of already processed groups so they are not recursed again.
831 }
832 // Add the group uid, current list, TSconfig to the internal arrays.
833 $this->includeGroupArray[]=$uid;
834 $this->includeHierarchy[]=$idList;
835 $this->TSdataArray[] = $this->addTScomment('Group "'.$row['title'].'" ['.$row['uid'].'] TSconfig field:').$row['TSconfig'];
836
837 // Mount group database-mounts
838 if (($this->user['options']&1) == 1) { $this->dataLists['webmount_list'].= ','.$row['db_mountpoints']; }
839
840 // Mount group file-mounts
841 if (($this->user['options']&2) == 2) { $this->dataLists['filemount_list'].= ','.$row['file_mountpoints']; }
842
843 // Mount group home-dirs
844 if (($this->user['options']&2) == 2) {
845 // If groupHomePath is set, we attempt to mount it
846 if ($GLOBALS['TYPO3_CONF_VARS']['BE']['groupHomePath']) {
847 $this->addFileMount($row['title'], '', $GLOBALS['TYPO3_CONF_VARS']['BE']['groupHomePath'].$row['uid'], 0, 'group');
848 }
849 }
850
851 // The lists are made: groupMods, tables_select, tables_modify, pagetypes_select, non_exclude_fields, explicit_allowdeny, allowed_languages, custom_options
852 if ($row['inc_access_lists']==1) {
853 $this->dataLists['modList'].= ','.$row['groupMods'];
854 $this->dataLists['tables_select'].= ','.$row['tables_select'];
855 $this->dataLists['tables_modify'].= ','.$row['tables_modify'];
856 $this->dataLists['pagetypes_select'].= ','.$row['pagetypes_select'];
857 $this->dataLists['non_exclude_fields'].= ','.$row['non_exclude_fields'];
858 $this->dataLists['explicit_allowdeny'].= ','.$row['explicit_allowdeny'];
859 $this->dataLists['allowed_languages'].= ','.$row['allowed_languages'];
860 $this->dataLists['custom_options'].= ','.$row['custom_options'];
861 }
862 // If this function is processing the users OWN group-list (not subgroups) AND if the ->firstMainGroup is not set, then the ->firstMainGroup will be set.
863 if (!strcmp($idList,'') && !$this->firstMainGroup) {
864 $this->firstMainGroup=$uid;
865 }
866 }
867 }
868
869 }
870
871 /**
872 * Updates the field be_users.usergroup_cached_list if the groupList of the user has changed/is different from the current list.
873 * The field "usergroup_cached_list" contains the list of groups which the user is a member of. After authentication (where these functions are called...) one can depend on this list being a representation of the exact groups/subgroups which the BE_USER has membership with.
874 *
875 * @param string The newly compiled group-list which must be compared with the current list in the user record and possibly stored if a difference is detected.
876 * @return void
877 * @access private
878 */
879 function setCachedList($cList) {
880 if ((string)$cList != (string)$this->user['usergroup_cached_list']) {
881 $GLOBALS['TYPO3_DB']->exec_UPDATEquery('be_users', 'uid='.intval($this->user['uid']), array('usergroup_cached_list' => $cList));
882 }
883 }
884
885 /**
886 * Adds a filemount to the users array of filemounts, $this->groupData['filemounts'][hash_key] = Array ('name'=>$name, 'path'=>$path, 'type'=>$type);
887 * Is a part of the authentication proces of the user.
888 * A final requirement for a path being mounted is that a) it MUST return true on is_dir(), b) must contain either PATH_site+'fileadminDir' OR 'lockRootPath' - if lockRootPath is set - as first part of string!
889 * Paths in the mounted information will always be absolute and have a trailing slash.
890 *
891 * @param string $title will be the (root)name of the filemount in the folder tree
892 * @param string $altTitle will be the (root)name of the filemount IF $title is not true (blank or zero)
893 * @param string $path is the path which should be mounted. Will accept backslash in paths on windows servers (will substituted with forward slash). The path should be 1) relative to TYPO3_CONF_VARS[BE][fileadminDir] if $webspace is set, otherwise absolute.
894 * @param boolean If $webspace is set, the $path is relative to 'fileadminDir' in TYPO3_CONF_VARS, otherwise $path is absolute. 'fileadminDir' must be set to allow mounting of relative paths.
895 * @param string Type of filemount; Can be blank (regular) or "user" / "group" (for user and group filemounts presumably). Probably sets the icon first and foremost.
896 * @return boolean Returns "1" if the requested filemount was mounted, otherwise no return value.
897 * @access private
898 */
899 function addFileMount($title, $altTitle, $path, $webspace, $type) {
900 // Return false if fileadminDir is not set and we try to mount a relative path
901 if ($webspace && !$GLOBALS['TYPO3_CONF_VARS']['BE']['fileadminDir']) return false;
902
903 // Trimming and pre-processing
904 $path=trim($path);
905 if ($this->OS=='WIN') { // with WINDOWS convert backslash to slash!!
906 $path=str_replace('\\','/',$path);
907 }
908 // If the path is true and validates as a valid path string:
909 if ($path && t3lib_div::validPathStr($path)) {
910 // these lines remove all slashes and dots before and after the path
911 $path=ereg_replace('^[\/\. ]*','',$path);
912 $path=trim(ereg_replace('[\/\. ]*$','',$path));
913
914
915 if ($path) { // there must be some chars in the path
916 $fdir=PATH_site.$GLOBALS['TYPO3_CONF_VARS']['BE']['fileadminDir']; // fileadmin dir, absolute
917 if ($webspace) {
918 $path=$fdir.$path; // PATH_site + fileadmin dir is prepended
919 } else {
920 if ($this->OS!='WIN') { // with WINDOWS no prepending!!
921 $path='/'.$path; // root-level is the start...
922 }
923 }
924 $path.='/';
925
926 // We now have a path with slash after and slash before (if unix)
927 if (@is_dir($path) &&
928 (($GLOBALS['TYPO3_CONF_VARS']['BE']['lockRootPath'] && t3lib_div::isFirstPartOfStr($path,$GLOBALS['TYPO3_CONF_VARS']['BE']['lockRootPath'])) || t3lib_div::isFirstPartOfStr($path,$fdir))) {
929 // Alternative title?
930 $name = $title ? $title : $altTitle;
931 // Adds the filemount. The same filemount with same name, type and path cannot be set up twice because of the hash string used as key.
932 $this->groupData['filemounts'][md5($name.'|'.$path.'|'.$type)] = Array('name'=>$name, 'path'=>$path, 'type'=>$type);
933 // Return true - went well, success!
934 return 1;
935 }
936 }
937 }
938 }
939
940 /**
941 * Creates a TypoScript comment with the string text inside.
942 *
943 * @param string The text to wrap in comment prefixes and delimiters.
944 * @return string TypoScript comment with the string text inside.
945 */
946 function addTScomment($str) {
947 $delimiter = '# ***********************************************';
948
949 $out = $delimiter.chr(10);
950 $lines = t3lib_div::trimExplode(chr(10),$str);
951 foreach($lines as $v) {
952 $out.= '# '.$v.chr(10);
953 }
954 $out.= $delimiter.chr(10);
955 return $out;
956 }
957
958
959
960
961
962
963
964
965
966
967
968
969 /************************************
970 *
971 * Logging
972 *
973 ************************************/
974
975
976 /**
977 * Writes an entry in the logfile
978 * ... Still missing documentation for syntax etc...
979 *
980 * @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
981 * @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 !!)
982 * @param integer $error: flag. 0 = message, 1 = error (user problem), 2 = System Error (which should not happen), 3 = security notice (admin)
983 * @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
984 * @param string $details: Default text that follows the message
985 * @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...
986 * @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.)
987 * @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.)
988 * @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.)
989 * @param integer $event_pid: The page_uid (pid) where the event occurred. Used to select log-content for specific pages.
990 * @param string $NEWid: NEWid string
991 * @return void
992 */
993 function writelog($type,$action,$error,$details_nr,$details,$data,$tablename='',$recuid='',$recpid='',$event_pid=-1,$NEWid='') {
994
995 $fields_values = Array (
996 'userid' => intval($this->user['uid']),
997 'type' => intval($type),
998 'action' => intval($action),
999 'error' => intval($error),
1000 'details_nr' => intval($details_nr),
1001 'details' => $details,
1002 'log_data' => serialize($data),
1003 'tablename' => $tablename,
1004 'recuid' => intval($recuid),
1005 'recpid' => intval($recpid),
1006 'IP' => t3lib_div::getIndpEnv('REMOTE_ADDR'),
1007 'tstamp' => $GLOBALS['EXEC_TIME'],
1008 'event_pid' => intval($event_pid),
1009 'NEWid' => $NEWid
1010 );
1011
1012 $GLOBALS['TYPO3_DB']->exec_INSERTquery('sys_log', $fields_values);
1013 return $GLOBALS['TYPO3_DB']->sql_insert_id();
1014 }
1015
1016 /**
1017 * Sends a warning to $email if there has been a certain amount of failed logins during a period.
1018 * If a login fails, this function is called. It will look up the sys_log to see if there has been more than $max failed logins the last $secondsBack seconds (default 3600). If so, an email with a warning is sent to $email.
1019 *
1020 * @param string Email address
1021 * @param integer Number of sections back in time to check. This is a kind of limit for how many failures an hour for instance.
1022 * @param integer Max allowed failures before a warning mail is sent
1023 * @return void
1024 * @access private
1025 */
1026 function checkLogFailures($email, $secondsBack=3600, $max=3) {
1027 if ($email) {
1028
1029 // get last flag set in the log for sending
1030 $theTimeBack = time()-$secondsBack;
1031 $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery(
1032 'tstamp',
1033 'sys_log',
1034 'type=255 AND action=4 AND tstamp>'.intval($theTimeBack),
1035 '',
1036 'tstamp DESC',
1037 '1'
1038 );
1039 if ($testRow = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res)) {
1040 $theTimeBack = $testRow['tstamp'];
1041 }
1042
1043 // Check for more than $max number of error failures with the last period.
1044 $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery(
1045 '*',
1046 'sys_log',
1047 'type=255 AND action=3 AND error!=0 AND tstamp>'.intval($theTimeBack),
1048 '',
1049 'tstamp'
1050 );
1051 if ($GLOBALS['TYPO3_DB']->sql_num_rows($res) > $max) {
1052 // OK, so there were more than the max allowed number of login failures - so we will send an email then.
1053 $subject = 'TYPO3 Login Failure Warning (at '.$GLOBALS['TYPO3_CONF_VARS']['SYS']['sitename'].')';
1054 $email_body = '
1055 There has been numerous attempts ('.$GLOBALS['TYPO3_DB']->sql_num_rows($res).') to login at the TYPO3
1056 site "'.$GLOBALS['TYPO3_CONF_VARS']['SYS']['sitename'].'" ('.t3lib_div::getIndpEnv('HTTP_HOST').').
1057
1058 This is a dump of the failures:
1059
1060 ';
1061 while($testRows = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res)) {
1062 $theData = unserialize($testRows['log_data']);
1063 $email_body.=date($GLOBALS['TYPO3_CONF_VARS']['SYS']['ddmmyy'].' H:i',$testRows['tstamp']).': '.@sprintf($testRows['details'],''.$theData[0],''.$theData[1],''.$theData[2]);
1064 $email_body.=chr(10);
1065 }
1066 mail( $email,
1067 $subject,
1068 $email_body,
1069 'From: TYPO3 Login WARNING<>'
1070 );
1071 $this->writelog(255,4,0,3,'Failure warning (%s failures within %s seconds) sent by email to %s',Array($GLOBALS['TYPO3_DB']->sql_num_rows($res),$secondsBack,$email)); // Logout written to log
1072 }
1073 }
1074 }
1075 }
1076
1077
1078
1079 if (defined('TYPO3_MODE') && $TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['t3lib/class.t3lib_userauthgroup.php']) {
1080 include_once($TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['t3lib/class.t3lib_userauthgroup.php']);
1081 }
1082 ?>