2 /***************************************************************
5 * (c) 1999-2006 Kasper Skaarhoj (kasperYYYY@typo3.com)
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 * Contains an extension class specifically for authentication/initialization of backend users in TYPO3
31 * Revised for TYPO3 3.6 July/2003 by Kasper Skaarhoj
33 * @author Kasper Skaarhoj <kasperYYYY@typo3.com>
36 * [CLASS/FUNCTION INDEX of SCRIPT]
40 * 135: class t3lib_userAuthGroup extends t3lib_userAuth
42 * SECTION: Permission checking functions:
43 * 199: function isAdmin()
44 * 211: function isMemberOfGroup($groupId)
45 * 233: function doesUserHaveAccess($row,$perms)
46 * 250: function isInWebMount($id,$readPerms='',$exitOnError=0)
47 * 277: function modAccess($conf,$exitOnError)
48 * 328: function getPagePermsClause($perms)
49 * 367: function calcPerms($row)
50 * 405: function isRTE()
51 * 439: function check($type,$value)
52 * 456: function checkAuthMode($table,$field,$value,$authMode)
53 * 522: function checkLanguageAccess($langValue)
54 * 544: function recordEditAccessInternals($table,$idOrRow,$newRecord=FALSE)
55 * 619: function isPSet($lCP,$table,$type='')
56 * 636: function mayMakeShortcut()
57 * 650: function workspaceCannotEditRecord($table,$recData)
58 * 689: function workspaceCannotEditOfflineVersion($table,$recData)
59 * 712: function workspaceAllowLiveRecordsInPID($pid, $table)
60 * 733: function workspaceCreateNewRecord($pid, $table)
61 * 752: function workspaceAllowAutoCreation($table,$id,$recpid)
62 * 772: function workspaceCheckStageForCurrent($stage)
63 * 795: function workspacePublishAccess($wsid)
64 * 823: function workspaceSwapAccess()
65 * 835: function workspaceVersioningTypeAccess($type)
66 * 866: function workspaceVersioningTypeGetClosest($type)
68 * SECTION: Miscellaneous functions
69 * 909: function getTSConfig($objectString,$config='')
70 * 935: function getTSConfigVal($objectString)
71 * 947: function getTSConfigProp($objectString)
72 * 959: function inList($in_list,$item)
73 * 970: function returnWebmounts()
74 * 980: function returnFilemounts()
75 * 997: function jsConfirmation($bitmask)
77 * SECTION: Authentication methods
78 * 1035: function fetchGroupData()
79 * 1168: function fetchGroups($grList,$idList='')
80 * 1266: function setCachedList($cList)
81 * 1286: function addFileMount($title, $altTitle, $path, $webspace, $type)
82 * 1333: function addTScomment($str)
85 * 1369: function workspaceInit()
86 * 1412: function checkWorkspace($wsRec,$fields='uid,title,adminusers,members,reviewers,publish_access,stagechg_notification')
87 * 1487: function checkWorkspaceCurrent()
88 * 1500: function setWorkspace($workspaceId)
89 * 1528: function setWorkspacePreview($previewState)
90 * 1538: function getDefaultWorkspace()
93 * 1589: function writelog($type,$action,$error,$details_nr,$details,$data,$tablename='',$recuid='',$recpid='',$event_pid=-1,$NEWid='',$userId=0)
94 * 1621: function simplelog($message, $extKey='', $error=0)
95 * 1642: function checkLogFailures($email, $secondsBack=3600, $max=3)
98 * (This index is automatically created/updated by the extension "extdeveval")
102 // Need this for parsing User TSconfig
103 require_once (PATH_t3lib
.'class.t3lib_tsparser.php');
126 * Extension to class.t3lib_userauth.php; Authentication of users in TYPO3 Backend
128 * Actually this class is extended again by t3lib_beuserauth which is the actual backend user class that will be instantiated.
129 * 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.
131 * @author Kasper Skaarhoj <kasperYYYY@typo3.com>
135 class t3lib_userAuthGroup
extends t3lib_userAuth
{
136 var $usergroup_column = 'usergroup'; // Should be set to the usergroup-column (id-list) in the user-record
137 var $usergroup_table = 'be_groups'; // The name of the group-table
140 var $groupData = Array( // This array holds lists of eg. tables, fields and other values related to the permission-system. See fetchGroupData
141 'filemounts' => Array() // Filemounts are loaded here
143 var $workspace = -99; // User workspace. -99 is ERROR (none available), -1 is offline, 0 is online, >0 is custom workspaces.
144 var $workspaceRec = array(); // Custom workspace record if any
146 var $userGroups = Array(); // This array will hold the groups that the user is a member of
147 var $userGroupsUID = Array(); // This array holds the uid's of the groups in the listed order
148 var $groupList =''; // This is $this->userGroupsUID imploded to a comma list... Will correspond to the 'usergroup_cached_list'
149 var $dataLists=array( // Used internally to accumulate data for the user-group. DONT USE THIS EXTERNALLY! Use $this->groupData instead
151 'filemount_list'=>'',
155 'pagetypes_select'=>'',
156 'non_exclude_fields'=>'',
157 'explicit_allowdeny'=>'',
158 'allowed_languages' => '',
159 'workspace_perms' => '',
160 'custom_options' => '',
162 var $includeHierarchy=array(); // For debugging/display of order in which subgroups are included.
163 var $includeGroupArray=array(); // List of group_id's in the order they are processed.
165 var $OS=''; // Set to 'WIN', if windows
166 var $TSdataArray=array(); // Used to accumulate the TSconfig data of the user
167 var $userTS_text = ''; // Contains the non-parsed user TSconfig
168 var $userTS = array(); // Contains the parsed user TSconfig
169 var $userTSUpdated=0; // Set internally if the user TSconfig was parsed and needs to be cached.
170 var $userTS_dontGetCached=0; // Set this from outside if you want the user TSconfig to ALWAYS be parsed and not fetched from cache.
172 var $RTE_errors = array(); // RTE availability errors collected.
173 var $errorMsg = ''; // Contains last error message
175 var $checkWorkspaceCurrent_cache=NULL; // Cache for checkWorkspaceCurrent()
187 /************************************
189 * Permission checking functions:
191 ************************************/
194 * Returns true if user is admin
195 * Basically this function evaluates if the ->user[admin] field has bit 0 set. If so, user is admin.
200 return (($this->user
['admin']&1) ==1);
204 * Returns true if the current user is a member of group $groupId
205 * $groupId must be set. $this->groupList must contain groups
206 * Will return true also if the user is a member of a group through subgroups.
208 * @param integer Group ID to look for in $this->groupList
211 function isMemberOfGroup($groupId) {
212 $groupId = intval($groupId);
213 if ($this->groupList
&& $groupId) {
214 return $this->inList($this->groupList
, $groupId);
219 * Checks if the permissions is granted based on a page-record ($row) and $perms (binary and'ed)
221 * Bits for permissions, see $perms variable:
223 * 1 - Show: See/Copy page and the pagecontent.
224 * 16- Edit pagecontent: Change/Add/Delete/Move pagecontent.
225 * 2- Edit page: Change/Move the page, eg. change title, startdate, hidden.
226 * 4- Delete page: Delete the page and pagecontent.
227 * 8- New pages: Create new pages under the page.
229 * @param array $row is the pagerow for which the permissions is checked
230 * @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.
231 * @return boolean True or False upon evaluation
233 function doesUserHaveAccess($row,$perms) {
234 $userPerms = $this->calcPerms($row);
235 return ($userPerms & $perms)==$perms;
239 * Checks if the page id, $id, is found within the webmounts set up for the user.
240 * This should ALWAYS be checked for any page id a user works with, whether it's about reading, writing or whatever.
241 * 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.
242 * 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
243 * Otherwise the function will return the uid of the webmount which was first found in the rootline of the input page $id
245 * @param integer Page ID to check
246 * @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!)
247 * @param boolean If set, then the function will exit with an error message.
248 * @return integer The page UID of a page in the rootline that matched a mount point
250 function isInWebMount($id,$readPerms='',$exitOnError=0) {
251 if (!$GLOBALS['TYPO3_CONF_VARS']['BE']['lockBeUserToDBmounts'] ||
$this->isAdmin()) return 1;
254 // Check if input id is an offline version page in which case we will map id to the online version:
255 $checkRec = t3lib_beFUnc
::getRecord('pages',$id,'pid,t3ver_oid');
256 if ($checkRec['pid']==-1) {
257 $id = intval($checkRec['t3ver_oid']);
260 if (!$readPerms) $readPerms = $this->getPagePermsClause(1);
262 $wM = $this->returnWebmounts();
263 $rL = t3lib_BEfunc
::BEgetRootLine($id,' AND '.$readPerms);
266 if ($v['uid'] && in_array($v['uid'],$wM)) {
272 t3lib_BEfunc
::typo3PrintError ('Access Error','This page is not within your DB-mounts',0);
278 * Checks access to a backend module with the $MCONF passed as first argument
280 * @param array $MCONF array of a backend module!
281 * @param boolean If set, an array will issue an error message and exit.
282 * @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
284 function modAccess($conf,$exitOnError) {
285 if (!t3lib_BEfunc
::isModuleSetInTBE_MODULES($conf['name'])) {
287 t3lib_BEfunc
::typo3PrintError ('Fatal Error','This module "'.$conf['name'].'" is not enabled in TBE_MODULES',0);
294 if ($conf['workspaces']) {
295 if (($this->workspace
===0 && t3lib_div
::inList($conf['workspaces'],'online')) ||
296 ($this->workspace
===-1 && t3lib_div
::inList($conf['workspaces'],'offline')) ||
297 ($this->workspace
>0 && t3lib_div
::inList($conf['workspaces'],'custom'))) {
301 t3lib_BEfunc
::typo3PrintError ('Workspace Error','This module "'.$conf['name'].'" is not available under the current workspace',0);
308 // Returns true if conf[access] is not set at all or if the user is admin
309 if (!$conf['access'] ||
$this->isAdmin()) return TRUE;
311 // If $conf['access'] is set but not with 'admin' then we return true, if the module is found in the modList
312 if (!strstr($conf['access'],'admin') && $conf['name']) {
313 $acs = $this->check('modules',$conf['name']);
315 if (!$acs && $exitOnError) {
316 t3lib_BEfunc
::typo3PrintError ('Access Error','You don\'t have access to this module.',0);
322 * Returns a WHERE-clause for the pages-table where user permissions according to input argument, $perms, is validated.
323 * $perms is the "mask" used to select. Fx. if $perms is 1 then you'll get all pages that a user can actually see!
328 * If the user is 'admin' " 1=1" is returned (no effect)
329 * 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)
330 * The 95% use of this function is "->getPagePermsClause(1)" which will return WHERE clauses for *selecting* pages in backend listings - in other words this will check read permissions.
332 * @param integer Permission mask to use, see function description
333 * @return string Part of where clause. Prefix " AND " to this.
335 function getPagePermsClause($perms) {
336 global $TYPO3_CONF_VARS;
337 if (is_array($this->user
)) {
338 if ($this->isAdmin()) {
342 $perms = intval($perms); // Make sure it's integer.
344 '(pages.perms_everybody & '.$perms.' = '.$perms.')'. // Everybody
345 'OR(pages.perms_userid = '.$this->user
['uid'].' AND pages.perms_user & '.$perms.' = '.$perms.')'; // User
346 if ($this->groupList
) {
347 $str.= 'OR(pages.perms_groupid in ('.$this->groupList
.') AND pages.perms_group & '.$perms.' = '.$perms.')'; // Group (if any is set)
352 // getPagePermsClause-HOOK
354 if (is_array($TYPO3_CONF_VARS['SC_OPTIONS']['t3lib/class.t3lib_userauthgroup.php']['getPagePermsClause'])) {
356 foreach($TYPO3_CONF_VARS['SC_OPTIONS']['t3lib/class.t3lib_userauthgroup.php']['getPagePermsClause'] as $_funcRef) {
357 $_params = array('currentClause' => $str, 'perms' => $perms);
358 $str = t3lib_div
::callUserFunction($_funcRef, $_params, $this);
369 * Returns a combined binary representation of the current users permissions for the page-record, $row.
370 * 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
371 * If the user is admin, 31 is returned (full permissions for all five flags)
373 * @param array Input page row with all perms_* fields available.
374 * @return integer Bitwise representation of the users permissions in relation to input page row, $row
376 function calcPerms($row) {
377 global $TYPO3_CONF_VARS;
378 if ($this->isAdmin()) {return 31;} // Return 31 for admin users.
381 if (isset($row['perms_userid']) && isset($row['perms_user']) && isset($row['perms_groupid']) && isset($row['perms_group']) && isset($row['perms_everybody']) && isset($this->groupList
)) {
382 if ($this->user
['uid']==$row['perms_userid']) {
383 $out|
=$row['perms_user'];
385 if ($this->isMemberOfGroup($row['perms_groupid'])) {
386 $out|
=$row['perms_group'];
388 $out|
=$row['perms_everybody'];
394 if (is_array($TYPO3_CONF_VARS['SC_OPTIONS']['t3lib/class.t3lib_userauthgroup.php']['calcPerms'])) {
395 foreach($TYPO3_CONF_VARS['SC_OPTIONS']['t3lib/class.t3lib_userauthgroup.php']['calcPerms'] as $_funcRef) {
398 'outputPermissions' => $out
400 $out = t3lib_div
::callUserFunction($_funcRef, $_params, $this);
408 * Returns true if the RTE (Rich Text Editor) can be enabled for the user
409 * 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]
410 * The reasons for a FALSE return can be found in $this->RTE_errors
418 $this->RTE_errors
= array();
419 if (!$this->uc
['edit_RTE'])
420 $this->RTE_errors
[] = 'RTE is not enabled for user!';
421 if (!$GLOBALS['TYPO3_CONF_VARS']['BE']['RTEenabled'])
422 $this->RTE_errors
[] = 'RTE is not enabled in $TYPO3_CONF_VARS["BE"]["RTEenabled"]';
425 // Acquire RTE object:
426 $RTE = &t3lib_BEfunc
::RTEgetObj();
427 if (!is_object($RTE)) {
428 $this->RTE_errors
= array_merge($this->RTE_errors
, $RTE);
431 if (!count($this->RTE_errors
)) {
439 * Returns true if the $value is found in the list in a $this->groupData[] index pointed to by $type (array key).
440 * Can thus be users to check for modules, exclude-fields, select/modify permissions for tables etc.
441 * If user is admin true is also returned
442 * Please see the document Inside TYPO3 for examples.
444 * @param string The type value; "webmounts", "filemounts", "pagetypes_select", "tables_select", "tables_modify", "non_exclude_fields", "modules"
445 * @param string String to search for in the groupData-list
446 * @return boolean True if permission is granted (that is, the value was found in the groupData list - or the BE_USER is "admin")
448 function check($type,$value) {
449 if (isset($this->groupData
[$type])) {
450 if ($this->isAdmin() ||
$this->inList($this->groupData
[$type],$value)) {
457 * Checking the authMode of a select field with authMode set
459 * @param string Table name
460 * @param string Field name (must be configured in TCA and of type "select" with authMode set!)
461 * @param string Value to evaluation (single value, must not contain any of the chars ":,|")
462 * @param string Auth mode keyword (explicitAllow, explicitDeny, individual)
463 * @return boolean True or false whether access is granted or not.
465 function checkAuthMode($table,$field,$value,$authMode) {
468 // Admin users can do anything:
469 if ($this->isAdmin()) return TRUE;
471 // Allow all blank values:
472 if (!strcmp($value,'')) return TRUE;
474 // Certain characters are not allowed in the value
475 if (ereg('[:|,]',$value)) {
480 $testValue = $table.':'.$field.':'.$value;
484 switch((string)$authMode) {
485 case 'explicitAllow':
486 if (!$this->inList($this->groupData
['explicit_allowdeny'],$testValue.':ALLOW')) {
491 if ($this->inList($this->groupData
['explicit_allowdeny'],$testValue.':DENY')) {
496 t3lib_div
::loadTCA($table);
497 if (is_array($TCA[$table]) && is_array($TCA[$table]['columns'][$field])) {
498 $items = $TCA[$table]['columns'][$field]['config']['items'];
499 if (is_array($items)) {
500 foreach($items as $iCfg) {
501 if (!strcmp($iCfg[1],$value) && $iCfg[4]) {
502 switch((string)$iCfg[4]) {
504 if (!$this->inList($this->groupData
['explicit_allowdeny'],$testValue.':ALLOW')) {
509 if ($this->inList($this->groupData
['explicit_allowdeny'],$testValue.':DENY')) {
526 * Checking if a language value (-1, 0 and >0 for sys_language records) is allowed to be edited by the user.
528 * @param integer Language value to evaluate
529 * @return boolean Returns true if the language value is allowed, otherwise false.
531 function checkLanguageAccess($langValue) {
532 if (strcmp(trim($this->groupData
['allowed_languages']),'')) { // The users language list must be non-blank - otherwise all languages are allowed.
533 $langValue = intval($langValue);
534 if ($langValue != -1 && !$this->check('allowed_languages',$langValue)) { // Language must either be explicitly allowed OR the lang Value be "-1" (all languages)
542 * Checking if a user has editing access to a record from a $TCA table.
543 * 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.
544 * For instance languages settings, authMode selector boxes are evaluated (and maybe more in the future).
545 * It will check for workspace dependent access.
546 * The function takes an ID (integer) or row (array) as second argument.
548 * @param string Table name
549 * @param mixed If integer, then this is the ID of the record. If Array this just represents fields in the record.
550 * @param boolean Set, if testing a new (non-existing) record array. Will disable certain checks that doesn't make much sense in that context.
551 * @return boolean True if OK, otherwise false
553 function recordEditAccessInternals($table,$idOrRow,$newRecord=FALSE) {
556 if (isset($TCA[$table])) {
557 t3lib_div
::loadTCA($table);
559 // Always return true for Admin users.
560 if ($this->isAdmin()) return TRUE;
562 // Fetching the record if the $idOrRow variable was not an array on input:
563 if (!is_array($idOrRow)) {
564 $idOrRow = t3lib_BEfunc
::getRecord($table, $idOrRow);
565 if (!is_array($idOrRow)) {
566 $this->errorMsg
= 'ERROR: Record could not be fetched.';
571 // Checking languages:
572 if ($TCA[$table]['ctrl']['languageField']) {
573 if (isset($idOrRow[$TCA[$table]['ctrl']['languageField']])) { // Language field must be found in input row - otherwise it does not make sense.
574 if (!$this->checkLanguageAccess($idOrRow[$TCA[$table]['ctrl']['languageField']])) {
575 $this->errorMsg
= 'ERROR: Language was not allowed.';
579 $this->errorMsg
= 'ERROR: The "languageField" field named "'.$TCA[$table]['ctrl']['languageField'].'" was not found in testing record!';
584 // Checking authMode fields:
585 if (is_array($TCA[$table]['columns'])) {
586 foreach($TCA[$table]['columns'] as $fN => $fV) {
587 if (isset($idOrRow[$fN])) { //
588 if ($fV['config']['type']=='select' && $fV['config']['authMode'] && !strcmp($fV['config']['authMode_enforce'],'strict')) {
589 if (!$this->checkAuthMode($table,$fN,$idOrRow[$fN],$fV['config']['authMode'])) {
590 $this->errorMsg
= 'ERROR: authMode "'.$fV['config']['authMode'].'" failed for field "'.$fN.'" with value "'.$idOrRow[$fN].'" evaluated';
598 // Checking "editlock" feature (doesn't apply to new records)
599 if (!$newRecord && $TCA[$table]['ctrl']['editlock']) {
600 if (isset($idOrRow[$TCA[$table]['ctrl']['editlock']])) {
601 if ($idOrRow[$TCA[$table]['ctrl']['editlock']]) {
602 $this->errorMsg
= 'ERROR: Record was locked for editing. Only admin users can change this state.';
606 $this->errorMsg
= 'ERROR: The "editLock" field named "'.$TCA[$table]['ctrl']['editlock'].'" was not found in testing record!';
611 // Checking record permissions
612 // THIS is where we can include a check for "perms_" fields for other records than pages...
615 if (is_array($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_userauthgroup.php']['recordEditAccessInternals'])) {
616 foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_userauthgroup.php']['recordEditAccessInternals'] as $funcRef) {
619 'idOrRow' => $idOrRow,
620 'newRecord' => $newRecord
622 if (!t3lib_div
::callUserFunction($funcRef, $params, $this)) {
628 // Finally, return true if all is well.
634 * Will check a type of permission against the compiled permission integer, $lCP, and in relation to table, $table
636 * @param integer $lCP could typically be the "compiled permissions" integer returned by ->calcPerms
637 * @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)
638 * @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)
642 function isPSet($lCP,$table,$type='') {
643 if ($this->isAdmin()) return true;
644 if ($table=='pages') {
645 if ($type=='edit') return $lCP & 2;
646 if ($type=='new') return ($lCP & 8) ||
($lCP & 16); // Create new page OR pagecontent
647 if ($type=='delete') return $lCP & 4;
648 if ($type=='editcontent') return $lCP & 16;
655 * Returns true if the BE_USER is allowed to *create* shortcuts in the backend modules
659 function mayMakeShortcut() {
660 return $this->getTSConfigVal('options.shortcutFrame') && !$this->getTSConfigVal('options.mayNotCreateEditShortcuts');
664 * Checking if editing of an existing record is allowed in current workspace if that is offline.
665 * Rules for editing in offline mode:
666 * - record supports versioning and is an offline version from workspace and has the corrent stage
667 * - or record (any) is in a branch where there is a page which is a version from the workspace and where the stage is not preventing records
669 * @param string Table of record
670 * @param array Integer (record uid) or array where fields are at least: pid, t3ver_wsid, t3ver_stage (if versioningWS is set)
671 * @return string String error code, telling the failure state. FALSE=All ok
673 function workspaceCannotEditRecord($table,$recData) {
675 if ($this->workspace
!==0) { // Only test offline spaces:
677 if (!is_array($recData)) {
678 $recData = t3lib_BEfunc
::getRecord($table,$recData,'pid'.($GLOBALS['TCA'][$table]['ctrl']['versioningWS']?
',t3ver_wsid,t3ver_stage':''));
681 if (is_array($recData)) {
682 if ((int)$recData['pid']===-1) { // We are testing a "version" (identified by a pid of -1): it can be edited provided that workspace matches and versioning is enabled for the table.
683 if (!$GLOBALS['TCA'][$table]['ctrl']['versioningWS']) { // No versioning, basic error, inconsistency even! Such records should not have a pid of -1!
684 return 'Versioning disabled for table';
685 } elseif ((int)$recData['t3ver_wsid']!==$this->workspace
) { // So does workspace match?
686 return 'Workspace ID of record didn\'t match current workspace';
687 } else { // So what about the stage of the version, does that allow editing for this user?
688 return $this->workspaceCheckStageForCurrent($recData['t3ver_stage']) ?
FALSE : 'Record stage "'.$recData['t3ver_stage'].'" and users access level did not allow for editing';
690 } else { // We are testing a "live" record:
691 if ($res = $this->workspaceAllowLiveRecordsInPID($recData['pid'], $table)) { // For "Live" records, check that PID for table allows editing
692 // Live records are OK in this branch, but what about the stage of branch point, if any:
693 return $res>0 ?
FALSE : 'Stage for versioning root point and users access level did not allow for editing'; // OK
694 } else { // If not offline and not in versionized branch, output error:
695 return 'Online record was not in versionized branch!';
698 } else return 'No record';
700 return FALSE; // OK because workspace is 0
705 * Evaluates if a user is allowed to edit the offline version
707 * @param string Table of record
708 * @param array Integer (record uid) or array where fields are at least: pid, t3ver_wsid, t3ver_stage (if versioningWS is set)
709 * @return string String error code, telling the failure state. FALSE=All ok
710 * @see workspaceCannotEditRecord()
712 function workspaceCannotEditOfflineVersion($table,$recData) {
713 if ($GLOBALS['TCA'][$table]['ctrl']['versioningWS']) {
715 if (!is_array($recData)) {
716 $recData = t3lib_BEfunc
::getRecord($table,$recData,'uid,pid,t3ver_wsid,t3ver_stage');
718 if (is_array($recData)) {
719 if ((int)$recData['pid']===-1) {
720 return $this->workspaceCannotEditRecord($table,$recData);
721 } else return 'Not an offline version';
722 } else return 'No record';
723 } else return 'Table does not support versioning.';
727 * Check if "live" records from $table may be created or edited in this PID.
728 * If the answer is FALSE it means the only valid way to create or edit records in the PID is by versioning
729 * If the answer is 1 or 2 it means it is OK to create a record, if -1 it means that it is OK in terms of versioning because the element was within a versionized branch but NOT ok in terms of the state the root point had!
731 * @param integer PID value to check for.
732 * @param string Table name
733 * @return mixed Returns FALSE if a live record cannot be created and must be versionized in order to do so. 2 means a) Workspace is "Live" or workspace allows "live edit" of records from non-versionized tables (and the $table is not versionizable). 1 and -1 means the pid is inside a versionized branch where -1 means that the branch-point did NOT allow a new record according to its state.
735 function workspaceAllowLiveRecordsInPID($pid, $table) {
737 // Always for Live workspace AND if live-edit is enabled and tables are completely without versioning it is ok as well.
738 if ($this->workspace
===0 ||
($this->workspaceRec
['live_edit'] && !$GLOBALS['TCA'][$table]['ctrl']['versioningWS'])) {
739 return 2; // OK to create for this table.
740 } elseif (t3lib_BEfunc
::isPidInVersionizedBranch($pid, $table)) { // Check if records from $table can be created with this PID: Either if inside "branch" versioning type or a "versioning_followPages" table on a "page" versioning type.
741 // Now, check what the stage of that "page" or "branch" version type is:
742 $stage = t3lib_BEfunc
::isPidInVersionizedBranch($pid, $table, TRUE);
743 return $this->workspaceCheckStageForCurrent($stage) ?
1 : -1;
745 return FALSE; // If the answer is FALSE it means the only valid way to create or edit records in the PID is by versioning
750 * Evaluates if a record from $table can be created in $pid
752 * @param integer Page id. This value must be the _ORIG_uid if available: So when you have pages versionized as "page" or "element" you must supply the id of the page version in the workspace!
753 * @param string Table name
754 * @return boolean TRUE if OK.
756 function workspaceCreateNewRecord($pid, $table) {
757 if ($res = $this->workspaceAllowLiveRecordsInPID($pid,$table)) { // If LIVE records cannot be created in the current PID due to workspace restrictions, prepare creation of placeholder-record
759 return FALSE; // Stage for versioning root point and users access level did not allow for editing
761 } elseif (!$GLOBALS['TCA'][$table]['ctrl']['versioningWS']) { // So, if no live records were allowed, we have to create a new version of this record:
768 * Evaluates if auto creation of a version of a record is allowed.
770 * @param string Table of the record
771 * @param integer UID of record
772 * @param integer PID of record
773 * @return boolean TRUE if ok.
775 function workspaceAllowAutoCreation($table,$id,$recpid) {
776 // Auto-creation of version: In offline workspace, test if versioning is enabled and look for workspace version of input record. If there is no versionized record found we will create one and save to that.
777 if ($this->workspace
!==0 // Only in draft workspaces
778 && !$this->workspaceRec
['disable_autocreate'] // Auto-creation must not be disabled.
779 && $GLOBALS['TCA'][$table]['ctrl']['versioningWS'] // Table must be versionizable
780 && $recpid >= 0 // The PID of the record must NOT be -1 or less (would indicate that it already was a version!)
781 && !t3lib_BEfunc
::getWorkspaceVersionOfRecord($this->workspace
, $table, $id, 'uid') // There must be no existing version of this record in workspace.
782 && !t3lib_BEfunc
::isPidInVersionizedBranch($recpid, $table)) { // PID must NOT be in a versionized branch either
788 * Checks if an element stage allows access for the user in the current workspace
789 * In workspaces 0 (Live) and -1 (Default draft) access is always granted for any stage.
790 * Admins are always allowed.
791 * An option for custom workspaces allows members to also edit when the stage is "Review"
793 * @param integer Stage id from an element: -1,0 = editing, 1 = reviewer, >1 = owner
794 * @return boolean TRUE if user is allowed access
796 function workspaceCheckStageForCurrent($stage) {
797 if ($this->isAdmin()) return TRUE;
799 if ($this->workspace
>0) {
800 $stat = $this->checkWorkspaceCurrent();
801 $memberStageLimit = $this->workspaceRec
['review_stage_edit'] ?
1 : 0;
802 if (($stage<=$memberStageLimit && $stat['_ACCESS']==='member') ||
803 ($stage<=1 && $stat['_ACCESS']==='reviewer') ||
804 ($stat['_ACCESS']==='owner')) {
805 return TRUE; // OK for these criteria
807 } else return TRUE; // Always OK for live and draft workspaces.
811 * Returns TRUE if the user has access to publish content from the workspace ID given.
812 * Admin-users are always granted access to do this
813 * If the workspace ID is 0 (live) all users have access also
814 * If -1 (draft workspace) TRUE is returned if the user has access to the Live workspace
815 * For custom workspaces it depends on whether the user is owner OR like with draft workspace if the user has access to Live workspace.
817 * @param integer Workspace UID; -1,0,1+
818 * @return boolean Returns TRUE if the user has access to publish content from the workspace ID given.
820 function workspacePublishAccess($wsid) {
821 if ($this->isAdmin()) return TRUE;
823 // If no access to workspace, of course you cannot publish!
826 $wsAccess = $this->checkWorkspace($wsid);
828 switch($wsAccess['uid']) {
829 case 0: // Live workspace
830 $retVal = TRUE; // If access to Live workspace, no problem.
832 case -1: // Default draft workspace
833 $retVal = $this->checkWorkspace(0) ?
TRUE : FALSE; // If access to Live workspace, no problem.
835 default: // Custom workspace
836 $retVal = $wsAccess['_ACCESS'] === 'owner' ||
($this->checkWorkspace(0) && !($wsAccess['publish_access']&2)); // Either be an adminuser OR have access to online workspace which is OK as well as long as publishing access is not limited by workspace option.
844 * Workspace swap-mode access?
846 * @return boolean Returns TRUE if records can be swapped in the current workspace, otherwise false
848 function workspaceSwapAccess() {
849 if ($this->workspace
>0 && (int)$this->workspaceRec
['swap_modes']===2) {
855 * Workspace Versioning type access?
857 * @param integer Versioning type to evaluation: -1, 0, >1
858 * @return boolean TRUE if OK
860 function workspaceVersioningTypeAccess($type) {
863 $type = t3lib_div
::intInRange($type,-1);
865 // Check if only element versioning is allowed:
866 if ($GLOBALS['TYPO3_CONF_VARS']['BE']['elementVersioningOnly'] && $type!=-1) {
870 if ($this->workspace
>0 && !$this->isAdmin()) {
871 $stat = $this->checkWorkspaceCurrent();
872 if ($stat['_ACCESS']!=='owner') {
876 $retVal = $this->workspaceRec
['vtypes']&1 ?
FALSE : TRUE;
879 $retVal = $this->workspaceRec
['vtypes']&2 ?
FALSE : TRUE;
882 $retVal = $this->workspaceRec
['vtypes']&4 ?
FALSE : TRUE;
885 } else $retVal = TRUE;
886 } else $retVal = TRUE;
892 * Finding "closest" versioning type, used for creation of new records.
894 * @param integer Versioning type to evaluation: -1, 0, >1
895 * @return integer Returning versioning type
897 function workspaceVersioningTypeGetClosest($type) {
898 $type = t3lib_div
::intInRange($type,-1);
900 if ($this->workspace
>0) {
906 $type = $this->workspaceVersioningTypeAccess($type) ?
$type : -1;
909 $type = $this->workspaceVersioningTypeAccess($type) ?
$type : ($this->workspaceVersioningTypeAccess(0) ?
0 : -1);
925 /*************************************
927 * Miscellaneous functions
929 *************************************/
932 * Returns the value/properties of a TS-object as given by $objectString, eg. 'options.dontMountAdminMounts'
933 * Nice (general!) function for returning a part of a TypoScript array!
935 * @param string Pointer to an "object" in the TypoScript array, fx. 'options.dontMountAdminMounts'
936 * @param array Optional TSconfig array: If array, then this is used and not $this->userTS. If not array, $this->userTS is used.
937 * @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.
938 * @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.
940 function getTSConfig($objectString,$config='') {
941 if (!is_array($config)) {
942 $config=$this->userTS
; // Getting Root-ts if not sent
945 $parts = explode('.',$objectString,2);
948 if (count($parts)>1 && trim($parts[1])) {
949 // Go on, get the next level
950 if (is_array($config[$key.'.'])) $TSConf = $this->getTSConfig($parts[1],$config[$key.'.']);
952 $TSConf['value']=$config[$key];
953 $TSConf['properties']=$config[$key.'.'];
960 * Returns the "value" of the $objectString from the BE_USERS "User TSconfig" array
962 * @param string Object string, eg. "somestring.someproperty.somesubproperty"
963 * @return string The value for that object string (object path)
966 function getTSConfigVal($objectString) {
967 $TSConf = $this->getTSConfig($objectString);
968 return $TSConf['value'];
972 * Returns the "properties" of the $objectString from the BE_USERS "User TSconfig" array
974 * @param string Object string, eg. "somestring.someproperty.somesubproperty"
975 * @return array The properties for that object string (object path) - if any
978 function getTSConfigProp($objectString) {
979 $TSConf = $this->getTSConfig($objectString);
980 return $TSConf['properties'];
984 * Returns true if $item is in $in_list
986 * @param string Comma list with items, no spaces between items!
987 * @param string The string to find in the list of items
988 * @return string Boolean
990 function inList($in_list,$item) {
991 return strstr(','.$in_list.',', ','.$item.',');
995 * Returns an array with the webmounts.
996 * If no webmounts, and empty array is returned.
997 * 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.
1001 function returnWebmounts() {
1002 return (string)($this->groupData
['webmounts'])!='' ?
explode(',',$this->groupData
['webmounts']) : Array();
1006 * Returns an array with the filemounts for the user. Each filemount is represented with an array of a "name", "path" and "type".
1007 * If no filemounts an empty array is returned.
1011 function returnFilemounts() {
1012 return $this->groupData
['filemounts'];
1016 * Returns true or false, depending if an alert popup (a javascript confirmation) should be shown
1017 * call like $GLOBALS['BE_USER']->jsConfirmation($BITMASK)
1020 * 2 - copy/move/paste
1022 * 8 - frontend editing
1023 * 128 - other (not used yet)
1025 * @param integer Bitmask
1026 * @return boolean true if the confirmation should be shown
1028 function jsConfirmation($bitmask) {
1029 $alertPopup = $GLOBALS['BE_USER']->getTSConfig('options.alertPopups');
1030 if (empty($alertPopup['value'])) {
1031 $alertPopup = 255; // default: show all warnings
1033 $alertPopup = (int)$alertPopup['value'];
1035 if(($alertPopup&$bitmask) == $bitmask) { // show confirmation
1037 } else { // don't show confirmation
1050 /*************************************
1052 * Authentication methods
1054 *************************************/
1058 * Initializes a lot of stuff like the access-lists, database-mountpoints and filemountpoints
1059 * This method is called by ->backendCheckLogin() (from extending class t3lib_beuserauth) if the backend user login has verified OK.
1060 * Generally this is required initialization of a backend user.
1064 * @see t3lib_TSparser
1066 function fetchGroupData() {
1067 if ($this->user
['uid']) {
1069 // Get lists for the be_user record and set them as default/primary values.
1070 $this->dataLists
['modList'] = $this->user
['userMods']; // Enabled Backend Modules
1071 $this->dataLists
['allowed_languages'] = $this->user
['allowed_languages']; // Add Allowed Languages
1072 $this->dataLists
['workspace_perms'] = $this->user
['workspace_perms']; // Set user value for workspace permissions.
1073 $this->dataLists
['webmount_list'] = $this->user
['db_mountpoints']; // Database mountpoints
1074 $this->dataLists
['filemount_list'] = $this->user
['file_mountpoints']; // File mountpoints
1076 // Setting default User TSconfig:
1077 $this->TSdataArray
[]=$this->addTScomment('From $GLOBALS["TYPO3_CONF_VARS"]["BE"]["defaultUserTSconfig"]:').
1078 $GLOBALS['TYPO3_CONF_VARS']['BE']['defaultUserTSconfig'];
1080 // Default TSconfig for admin-users
1081 if ($this->isAdmin()) {
1082 $this->TSdataArray
[]=$this->addTScomment('"admin" user presets:').'
1083 admPanel.enable.all = 1
1084 options.shortcutFrame = 1
1086 if (t3lib_extMgm
::isLoaded('sys_note')) {
1087 $this->TSdataArray
[]='
1088 // Setting defaults for sys_note author / email...
1089 TCAdefaults.sys_note.author = '.$this->user
['realName'].'
1090 TCAdefaults.sys_note.email = '.$this->user
['email'].'
1096 // Admin users has the base fileadmin dir mounted
1097 if ($this->isAdmin() && $GLOBALS['TYPO3_CONF_VARS']['BE']['fileadminDir']) {
1098 $this->addFileMount($GLOBALS['TYPO3_CONF_VARS']['BE']['fileadminDir'], '', PATH_site
.$GLOBALS['TYPO3_CONF_VARS']['BE']['fileadminDir'], 0, '');
1101 // If userHomePath is set, we attempt to mount it
1102 if ($GLOBALS['TYPO3_CONF_VARS']['BE']['userHomePath']) {
1103 // First try and mount with [uid]_[username]
1104 $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');
1106 // If that failed, try and mount with only [uid]
1107 $this->addFileMount($this->user
['username'], '', $GLOBALS['TYPO3_CONF_VARS']['BE']['userHomePath'].$this->user
['uid'].$GLOBALS['TYPO3_CONF_VARS']['BE']['userUploadDir'], 0, 'user');
1112 // Get the groups...
1113 # $grList = t3lib_BEfunc::getSQLselectableList($this->user[$this->usergroup_column],$this->usergroup_table,$this->usergroup_table);
1114 $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.
1116 // Fetch groups will add a lot of information to the internal arrays: modules, accesslists, TSconfig etc. Refer to fetchGroups() function.
1117 $this->fetchGroups($grList);
1120 // Add the TSconfig for this specific user:
1121 $this->TSdataArray
[] = $this->addTScomment('USER TSconfig field').$this->user
['TSconfig'];
1122 // Check include lines.
1123 $this->TSdataArray
= t3lib_TSparser
::checkIncludeLines_array($this->TSdataArray
);
1125 // Parsing the user TSconfig (or getting from cache)
1126 $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.
1127 $hash = md5('userTS:'.$this->userTS_text
);
1128 $cachedContent = t3lib_BEfunc
::getHash($hash,0);
1129 if (isset($cachedContent) && !$this->userTS_dontGetCached
) {
1130 $this->userTS
= unserialize($cachedContent);
1132 $parseObj = t3lib_div
::makeInstance('t3lib_TSparser');
1133 $parseObj->parse($this->userTS_text
);
1134 $this->userTS
= $parseObj->setup
;
1135 t3lib_BEfunc
::storeHash($hash,serialize($this->userTS
),'BE_USER_TSconfig');
1137 $this->userTSUpdated
=1;
1140 // Processing webmounts
1141 if ($this->isAdmin() && !$this->getTSConfigVal('options.dontMountAdminMounts')) { // Admin's always have the root mounted
1142 $this->dataLists
['webmount_list']='0,'.$this->dataLists
['webmount_list'];
1145 // Processing filemounts
1146 $this->dataLists
['filemount_list'] = t3lib_div
::uniqueList($this->dataLists
['filemount_list']);
1147 if ($this->dataLists
['filemount_list']) {
1148 $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery('*', 'sys_filemounts', 'deleted=0 AND hidden=0 AND pid=0 AND uid IN ('.$this->dataLists
['filemount_list'].')');
1149 while ($row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res)) {
1150 $this->addFileMount($row['title'], $row['path'], $row['path'], $row['base']?
1:0, '');
1154 // The lists are cleaned for duplicates
1155 $this->groupData
['webmounts'] = t3lib_div
::uniqueList($this->dataLists
['webmount_list']);
1156 $this->groupData
['pagetypes_select'] = t3lib_div
::uniqueList($this->dataLists
['pagetypes_select']);
1157 $this->groupData
['tables_select'] = t3lib_div
::uniqueList($this->dataLists
['tables_modify'].','.$this->dataLists
['tables_select']);
1158 $this->groupData
['tables_modify'] = t3lib_div
::uniqueList($this->dataLists
['tables_modify']);
1159 $this->groupData
['non_exclude_fields'] = t3lib_div
::uniqueList($this->dataLists
['non_exclude_fields']);
1160 $this->groupData
['explicit_allowdeny'] = t3lib_div
::uniqueList($this->dataLists
['explicit_allowdeny']);
1161 $this->groupData
['allowed_languages'] = t3lib_div
::uniqueList($this->dataLists
['allowed_languages']);
1162 $this->groupData
['custom_options'] = t3lib_div
::uniqueList($this->dataLists
['custom_options']);
1163 $this->groupData
['modules'] = t3lib_div
::uniqueList($this->dataLists
['modList']);
1164 $this->groupData
['workspace_perms'] = $this->dataLists
['workspace_perms'];
1166 // populating the $this->userGroupsUID -array with the groups in the order in which they were LAST included.!!
1167 $this->userGroupsUID
= array_reverse(array_unique(array_reverse($this->includeGroupArray
)));
1169 // 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)
1170 $this->groupList
= implode(',',$this->userGroupsUID
);
1171 $this->setCachedList($this->groupList
);
1173 // Checking read access to webmounts:
1174 if (trim($this->groupData
['webmounts'])!=='') {
1175 $webmounts = explode(',',$this->groupData
['webmounts']); // Explode mounts
1176 $MProws = $GLOBALS['TYPO3_DB']->exec_SELECTgetRows('uid', 'pages', 'deleted=0 AND uid IN ('.$this->groupData
['webmounts'].') AND '.$this->getPagePermsClause(1),'','','','uid'); // Selecting all webmounts with permission clause for reading
1177 foreach($webmounts as $idx => $mountPointUid) {
1178 if ($mountPointUid>0 && !isset($MProws[$mountPointUid])) { // If the mount ID is NOT found among selected pages, unset it:
1179 unset($webmounts[$idx]);
1182 $this->groupData
['webmounts'] = implode(',',$webmounts); // Implode mounts in the end.
1185 // Setting up workspace situation (after webmounts are processed!):
1186 $this->workspaceInit();
1191 * Fetches the group records, subgroups and fills internal arrays.
1192 * Function is called recursively to fetch subgroups
1194 * @param string Commalist of be_groups uid numbers
1195 * @param string List of already processed be_groups-uids so the function will not fall into a eternal recursion.
1199 function fetchGroups($grList,$idList='') {
1200 global $TYPO3_CONF_VARS;
1202 // Fetching records of the groups in $grList (which are not blocked by lockedToDomain either):
1203 $lockToDomain_SQL = ' AND (lockToDomain=\'\' OR lockToDomain IS NULL OR lockToDomain=\''.t3lib_div
::getIndpEnv('HTTP_HOST').'\')';
1204 $whereSQL = 'deleted=0 AND hidden=0 AND pid=0 AND uid IN ('.$grList.')'.$lockToDomain_SQL;
1206 // Hook for manipulation of the WHERE sql sentence which controls which BE-groups are included
1207 if (is_array ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_userauthgroup.php']['fetchGroupQuery'])) {
1208 foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_userauthgroup.php']['fetchGroupQuery'] as $classRef) {
1209 $hookObj = &t3lib_div
::getUserObj($classRef);
1210 if(method_exists($hookObj,'fetchGroupQuery_processQuery')){
1211 $whereSQL = $hookObj->fetchGroupQuery_processQuery($this, $grList, $idList, $whereSQL);
1216 $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery('*', $this->usergroup_table
, $whereSQL);
1218 // The userGroups array is filled
1219 while ($row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res)) {
1220 $this->userGroups
[$row['uid']] = $row;
1223 // Traversing records in the correct order
1224 $include_staticArr = t3lib_div
::intExplode(',',$grList);
1225 reset($include_staticArr);
1226 while(list(,$uid)=each($include_staticArr)) { // traversing list
1229 $row=$this->userGroups
[$uid];
1230 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
1232 // Include sub groups
1233 if (trim($row['subgroup'])) {
1234 $theList = implode(',',t3lib_div
::intExplode(',',$row['subgroup'])); // Make integer list
1235 $this->fetchGroups($theList, $idList.','.$uid); // Call recursively, pass along list of already processed groups so they are not recursed again.
1237 // Add the group uid, current list, TSconfig to the internal arrays.
1238 $this->includeGroupArray
[]=$uid;
1239 $this->includeHierarchy
[]=$idList;
1240 $this->TSdataArray
[] = $this->addTScomment('Group "'.$row['title'].'" ['.$row['uid'].'] TSconfig field:').$row['TSconfig'];
1242 // Mount group database-mounts
1243 if (($this->user
['options']&1) == 1) { $this->dataLists
['webmount_list'].= ','.$row['db_mountpoints']; }
1245 // Mount group file-mounts
1246 if (($this->user
['options']&2) == 2) { $this->dataLists
['filemount_list'].= ','.$row['file_mountpoints']; }
1248 // Mount group home-dirs
1249 if (($this->user
['options']&2) == 2) {
1250 // If groupHomePath is set, we attempt to mount it
1251 if ($GLOBALS['TYPO3_CONF_VARS']['BE']['groupHomePath']) {
1252 $this->addFileMount($row['title'], '', $GLOBALS['TYPO3_CONF_VARS']['BE']['groupHomePath'].$row['uid'], 0, 'group');
1256 // The lists are made: groupMods, tables_select, tables_modify, pagetypes_select, non_exclude_fields, explicit_allowdeny, allowed_languages, custom_options
1257 if ($row['inc_access_lists']==1) {
1258 $this->dataLists
['modList'].= ','.$row['groupMods'];
1259 $this->dataLists
['tables_select'].= ','.$row['tables_select'];
1260 $this->dataLists
['tables_modify'].= ','.$row['tables_modify'];
1261 $this->dataLists
['pagetypes_select'].= ','.$row['pagetypes_select'];
1262 $this->dataLists
['non_exclude_fields'].= ','.$row['non_exclude_fields'];
1263 $this->dataLists
['explicit_allowdeny'].= ','.$row['explicit_allowdeny'];
1264 $this->dataLists
['allowed_languages'].= ','.$row['allowed_languages'];
1265 $this->dataLists
['custom_options'].= ','.$row['custom_options'];
1268 // Setting workspace permissions:
1269 $this->dataLists
['workspace_perms'] |
= $row['workspace_perms'];
1271 // 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.
1272 if (!strcmp($idList,'') && !$this->firstMainGroup
) {
1273 $this->firstMainGroup
=$uid;
1279 // HOOK: fetchGroups_postProcessing
1281 if (is_array($TYPO3_CONF_VARS['SC_OPTIONS']['t3lib/class.t3lib_userauthgroup.php']['fetchGroups_postProcessing'])) {
1282 foreach($TYPO3_CONF_VARS['SC_OPTIONS']['t3lib/class.t3lib_userauthgroup.php']['fetchGroups_postProcessing'] as $_funcRef) {
1284 t3lib_div
::callUserFunction($_funcRef, $_params, $this);
1290 * Updates the field be_users.usergroup_cached_list if the groupList of the user has changed/is different from the current list.
1291 * 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.
1293 * @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.
1297 function setCachedList($cList) {
1298 if ((string)$cList != (string)$this->user
['usergroup_cached_list']) {
1299 $GLOBALS['TYPO3_DB']->exec_UPDATEquery('be_users', 'uid='.intval($this->user
['uid']), array('usergroup_cached_list' => $cList));
1304 * Adds a filemount to the users array of filemounts, $this->groupData['filemounts'][hash_key] = Array ('name'=>$name, 'path'=>$path, 'type'=>$type);
1305 * Is a part of the authentication proces of the user.
1306 * 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!
1307 * Paths in the mounted information will always be absolute and have a trailing slash.
1309 * @param string $title will be the (root)name of the filemount in the folder tree
1310 * @param string $altTitle will be the (root)name of the filemount IF $title is not true (blank or zero)
1311 * @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.
1312 * @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.
1313 * @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.
1314 * @return boolean Returns "1" if the requested filemount was mounted, otherwise no return value.
1317 function addFileMount($title, $altTitle, $path, $webspace, $type) {
1318 // Return false if fileadminDir is not set and we try to mount a relative path
1319 if ($webspace && !$GLOBALS['TYPO3_CONF_VARS']['BE']['fileadminDir']) return false;
1321 // Trimming and pre-processing
1323 if ($this->OS
=='WIN') { // with WINDOWS convert backslash to slash!!
1324 $path=str_replace('\\','/',$path);
1326 // If the path is true and validates as a valid path string:
1327 if ($path && t3lib_div
::validPathStr($path)) {
1328 // normalize path: remove leading '/' and './', and trailing '/' and '/.'
1330 $path=preg_replace('#^\.?/|/\.?$#','',$path);
1332 if ($path) { // there must be some chars in the path
1333 $fdir=PATH_site
.$GLOBALS['TYPO3_CONF_VARS']['BE']['fileadminDir']; // fileadmin dir, absolute
1335 $path=$fdir.$path; // PATH_site + fileadmin dir is prepended
1337 if ($this->OS
!='WIN') { // with WINDOWS no prepending!!
1338 $path='/'.$path; // root-level is the start...
1343 // We now have a path with slash after and slash before (if unix)
1344 if (@is_dir
($path) &&
1345 (($GLOBALS['TYPO3_CONF_VARS']['BE']['lockRootPath'] && t3lib_div
::isFirstPartOfStr($path,$GLOBALS['TYPO3_CONF_VARS']['BE']['lockRootPath'])) || t3lib_div
::isFirstPartOfStr($path,$fdir))) {
1346 // Alternative title?
1347 $name = $title ?
$title : $altTitle;
1348 // 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.
1349 $this->groupData
['filemounts'][md5($name.'|'.$path.'|'.$type)] = Array('name'=>$name, 'path'=>$path, 'type'=>$type);
1350 // Return true - went well, success!
1358 * Creates a TypoScript comment with the string text inside.
1360 * @param string The text to wrap in comment prefixes and delimiters.
1361 * @return string TypoScript comment with the string text inside.
1363 function addTScomment($str) {
1364 $delimiter = '# ***********************************************';
1366 $out = $delimiter.chr(10);
1367 $lines = t3lib_div
::trimExplode(chr(10),$str);
1368 foreach($lines as $v) {
1369 $out.= '# '.$v.chr(10);
1371 $out.= $delimiter.chr(10);
1386 /************************************
1390 ************************************/
1393 * Initializing workspace.
1394 * Called from within this function, see fetchGroupData()
1397 * @see fetchGroupData()
1399 function workspaceInit() {
1401 // Initializing workspace by evaluating and setting the workspace, possibly updating it in the user record!
1402 $this->setWorkspace($this->user
['workspace_id']);
1404 // Setting up the db mount points of the (custom) workspace, if any:
1405 if ($this->workspace
>0 && trim($this->workspaceRec
['db_mountpoints'])!=='') {
1408 $newMounts = array();
1409 $readPerms = '1=1'; // Notice: We cannot call $this->getPagePermsClause(1); as usual because the group-list is not available at this point. But bypassing is fine because all we want here is check if the workspace mounts are inside the current webmounts rootline. The actual permission checking on page level is done elsewhere as usual anyway before the page tree is rendered.
1411 // Traverse mount points of the
1412 $mountPoints = t3lib_div
::intExplode(',',$this->workspaceRec
['db_mountpoints']);
1413 foreach($mountPoints as $mpId) {
1414 if ($this->isInWebMount($mpId,$readPerms)) {
1415 $newMounts[] = $mpId;
1419 // Re-insert webmounts:
1420 $this->groupData
['webmounts'] = implode(',',array_unique($newMounts));
1423 // Setting up the file mount points of the (custom) workspace, if any:
1424 if ($this->workspace
!==0) $this->groupData
['filemounts'] = array();
1425 if ($this->workspace
>0 && trim($this->workspaceRec
['file_mountpoints'])!=='') {
1427 // Processing filemounts
1428 $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery('*', 'sys_filemounts', 'deleted=0 AND hidden=0 AND pid=0 AND uid IN ('.$GLOBALS['TYPO3_DB']->cleanIntList($this->workspaceRec
['file_mountpoints']).')');
1429 while ($row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res)) {
1430 $this->addFileMount($row['title'], $row['path'], $row['path'], $row['base']?
1:0, '');
1436 * Checking if a workspace is allowed for backend user
1438 * @param mixed If integer, workspace record is looked up, if array it is seen as a Workspace record with at least uid, title, members and adminusers columns. Can be faked for workspaces uid 0 and -1 (online and offline)
1439 * @param string List of fields to select. Default fields are: uid,title,adminusers,members,reviewers,publish_access,stagechg_notification
1440 * @return array TRUE if access. Output will also show how access was granted. Admin users will have a true output regardless of input.
1442 function checkWorkspace($wsRec,$fields='uid,title,adminusers,members,reviewers,publish_access,stagechg_notification') {
1445 // If not array, look up workspace record:
1446 if (!is_array($wsRec)) {
1447 switch((string)$wsRec) {
1450 $wsRec = array('uid' => $wsRec);
1453 list($wsRec) = $GLOBALS['TYPO3_DB']->exec_SELECTgetRows(
1456 'pid=0 AND uid='.intval($wsRec).
1457 t3lib_BEfunc
::deleteClause('sys_workspace'),
1465 // If wsRec is set to an array, evaluate it:
1466 if (is_array($wsRec)) {
1467 if ($this->isAdmin()) {
1468 return array_merge($wsRec,array('_ACCESS' => 'admin'));
1471 switch((string)$wsRec['uid']) {
1473 $retVal = ($this->groupData
['workspace_perms']&1) ?
array_merge($wsRec,array('_ACCESS' => 'online')) : FALSE;
1476 $retVal = ($this->groupData
['workspace_perms']&2) ?
array_merge($wsRec,array('_ACCESS' => 'offline')) : FALSE;
1479 // Checking if the guy is admin:
1480 if (t3lib_div
::inList($wsRec['adminusers'],$this->user
['uid'])) {
1481 return array_merge($wsRec, array('_ACCESS' => 'owner'));
1483 // Checking if he is reviewer user:
1484 if (t3lib_div
::inList($wsRec['reviewers'],'be_users_'.$this->user
['uid'])) {
1485 return array_merge($wsRec, array('_ACCESS' => 'reviewer'));
1487 // Checking if he is reviewer through a user group of his:
1488 foreach($this->userGroupsUID
as $groupUid) {
1489 if (t3lib_div
::inList($wsRec['reviewers'],'be_groups_'.$groupUid)) {
1490 return array_merge($wsRec, array('_ACCESS' => 'reviewer'));
1493 // Checking if he is member as user:
1494 if (t3lib_div
::inList($wsRec['members'],'be_users_'.$this->user
['uid'])) {
1495 return array_merge($wsRec, array('_ACCESS' => 'member'));
1497 // Checking if he is member through a user group of his:
1498 foreach($this->userGroupsUID
as $groupUid) {
1499 if (t3lib_div
::inList($wsRec['members'],'be_groups_'.$groupUid)) {
1500 return array_merge($wsRec, array('_ACCESS' => 'member'));
1512 * Uses checkWorkspace() to check if current workspace is available for user. This function caches the result and so can be called many times with no performance loss.
1514 * @return array See checkWorkspace()
1515 * @see checkWorkspace()
1517 function checkWorkspaceCurrent() {
1518 if (!isset($this->checkWorkspaceCurrent_cache
)) {
1519 $this->checkWorkspaceCurrent_cache
= $this->checkWorkspace($this->workspace
);
1521 return $this->checkWorkspaceCurrent_cache
;
1525 * Setting workspace ID
1527 * @param integer ID of workspace to set for backend user. If not valid the default workspace for BE user is found and set.
1530 function setWorkspace($workspaceId) {
1532 // Check workspace validity and if not found, revert to default workspace.
1533 if ($this->workspaceRec
= $this->checkWorkspace($workspaceId,'*')) {
1534 // Set workspace ID internally
1535 $this->workspace
= (int)$workspaceId;
1537 $this->workspace
= (int)$this->getDefaultWorkspace();
1538 $this->workspaceRec
= $this->checkWorkspace($this->workspace
,'*');
1541 // Unset access cache:
1542 unset($this->checkWorkspaceCurrent_cache
);
1544 // If ID is different from the stored one, change it:
1545 if (strcmp($this->workspace
, $this->user
['workspace_id'])) {
1546 $this->user
['workspace_id'] = $this->workspace
;
1547 $GLOBALS['TYPO3_DB']->exec_UPDATEquery('be_users','uid='.intval($this->user
['uid']),array('workspace_id' => $this->user
['workspace_id']));
1548 $this->simplelog('User changed workspace to "'.$this->workspace
.'"');
1553 * Setting workspace preview state for user:
1555 * @param boolean State of user preview.
1558 function setWorkspacePreview($previewState) {
1559 $this->user
['workspace_preview'] = $previewState;
1560 $GLOBALS['TYPO3_DB']->exec_UPDATEquery('be_users','uid='.intval($this->user
['uid']),array('workspace_preview' => $this->user
['workspace_preview']));
1564 * Return default workspace ID for user
1566 * @return integer Default workspace id. If no workspace is available it will be "-99"
1568 function getDefaultWorkspace() {
1570 if ($this->checkWorkspace(0)) { // Check online
1572 } elseif ($this->checkWorkspace(-1)) { // Check offline
1574 } else { // Traverse custom workspaces:
1575 $workspaces = $GLOBALS['TYPO3_DB']->exec_SELECTgetRows('uid,title,adminusers,members,reviewers','sys_workspace','pid=0'.t3lib_BEfunc
::deleteClause('sys_workspace'),'','title');
1576 foreach($workspaces as $rec) {
1577 if ($this->checkWorkspace($rec)) {
1595 /************************************
1599 ************************************/
1602 * Writes an entry in the logfile/table
1603 * Documentation in "TYPO3 Core API"
1605 * @param integer Denotes which module that has submitted the entry. See "TYPO3 Core API". Use "4" for extensions.
1606 * @param integer Denotes which specific operation that wrote the entry. Use "0" when no sub-categorizing applies
1607 * @param integer Flag. 0 = message, 1 = error (user problem), 2 = System Error (which should not happen), 3 = security notice (admin)
1608 * @param integer The message number. Specific for each $type and $action. This will make it possible to translate errormessages to other languages
1609 * @param string Default text that follows the message (in english!). Possibly translated by identification through type/action/details_nr
1610 * @param array 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 with the details-text
1611 * @param string Table name. Special field used by tce_main.php.
1612 * @param integer Record UID. Special field used by tce_main.php.
1613 * @param integer Record PID. Special field used by tce_main.php. OBSOLETE
1614 * @param integer The page_uid (pid) where the event occurred. Used to select log-content for specific pages.
1615 * @param string Special field used by tce_main.php. NEWid string of newly created records.
1616 * @param integer Alternative Backend User ID (used for logging login actions where this is not yet known).
1617 * @return integer Log entry ID.
1619 function writelog($type,$action,$error,$details_nr,$details,$data,$tablename='',$recuid='',$recpid='',$event_pid=-1,$NEWid='',$userId=0) {
1621 $fields_values = Array (
1622 'userid' => $userId ?
$userId : intval($this->user
['uid']),
1623 'type' => intval($type),
1624 'action' => intval($action),
1625 'error' => intval($error),
1626 'details_nr' => intval($details_nr),
1627 'details' => $details,
1628 'log_data' => serialize($data),
1629 'tablename' => $tablename,
1630 'recuid' => intval($recuid),
1631 # 'recpid' => intval($recpid),
1632 'IP' => t3lib_div
::getIndpEnv('REMOTE_ADDR'),
1633 'tstamp' => $GLOBALS['EXEC_TIME'],
1634 'event_pid' => intval($event_pid),
1636 'workspace' => $this->workspace
1639 $GLOBALS['TYPO3_DB']->exec_INSERTquery('sys_log', $fields_values);
1640 return $GLOBALS['TYPO3_DB']->sql_insert_id();
1644 * Simple logging function
1646 * @param string Log message
1647 * @param string Option extension key / module name
1648 * @param integer Error level. 0 = message, 1 = error (user problem), 2 = System Error (which should not happen), 3 = security notice (admin)
1649 * @return integer Log entry UID
1651 function simplelog($message, $extKey='', $error=0) {
1652 return $this->writelog(
1657 ($extKey?
'['.$extKey.'] ':'').$message,
1663 * Sends a warning to $email if there has been a certain amount of failed logins during a period.
1664 * 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.
1666 * @param string Email address
1667 * @param integer Number of sections back in time to check. This is a kind of limit for how many failures an hour for instance.
1668 * @param integer Max allowed failures before a warning mail is sent
1672 function checkLogFailures($email, $secondsBack=3600, $max=3) {
1676 // get last flag set in the log for sending
1677 $theTimeBack = time()-$secondsBack;
1678 $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery(
1681 'type=255 AND action=4 AND tstamp>'.intval($theTimeBack),
1686 if ($testRow = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res)) {
1687 $theTimeBack = $testRow['tstamp'];
1690 // Check for more than $max number of error failures with the last period.
1691 $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery(
1694 'type=255 AND action=3 AND error!=0 AND tstamp>'.intval($theTimeBack),
1698 if ($GLOBALS['TYPO3_DB']->sql_num_rows($res) > $max) {
1699 // OK, so there were more than the max allowed number of login failures - so we will send an email then.
1700 $subject = 'TYPO3 Login Failure Warning (at '.$GLOBALS['TYPO3_CONF_VARS']['SYS']['sitename'].')';
1702 There has been numerous attempts ('.$GLOBALS['TYPO3_DB']->sql_num_rows($res).') to login at the TYPO3
1703 site "'.$GLOBALS['TYPO3_CONF_VARS']['SYS']['sitename'].'" ('.t3lib_div
::getIndpEnv('HTTP_HOST').').
1705 This is a dump of the failures:
1708 while($testRows = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res)) {
1709 $theData = unserialize($testRows['log_data']);
1710 $email_body.= date($GLOBALS['TYPO3_CONF_VARS']['SYS']['ddmmyy'].' '.$GLOBALS['TYPO3_CONF_VARS']['SYS']['hhmm'],$testRows['tstamp']).': '.@sprintf
($testRows['details'],''.$theData[0],''.$theData[1],''.$theData[2]);
1711 $email_body.= chr(10);
1716 'From: TYPO3 Login WARNING<>'
1718 $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
1726 if (defined('TYPO3_MODE') && $TYPO3_CONF_VARS[TYPO3_MODE
]['XCLASS']['t3lib/class.t3lib_userauthgroup.php']) {
1727 include_once($TYPO3_CONF_VARS[TYPO3_MODE
]['XCLASS']['t3lib/class.t3lib_userauthgroup.php']);