t3lib/class.t3lib_userauthgroup.php

   1 <?php
   2 /***************************************************************
   3 *  Copyright notice
   4 *
   5 *  (c) 1999-2009 Kasper Skaarhoj (kasperYYYY@typo3.com)
   6 *  All rights reserved
   7 *
   8 *  This script is part of the TYPO3 project. The TYPO3 project is
   9 *  free software; you can redistribute it and/or modify
  10 *  it under the terms of the GNU General Public License as published by
  11 *  the Free Software Foundation; either version 2 of the License, or
  12 *  (at your option) any later version.
  13 *
  14 *  The GNU General Public License can be found at
  15 *  http://www.gnu.org/copyleft/gpl.html.
  16 *  A copy is found in the textfile GPL.txt and important notices to the license
  17 *  from the author is found in LICENSE.txt distributed with these scripts.
  18 *
  19 *
  20 *  This script is distributed in the hope that it will be useful,
  21 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  22 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  23 *  GNU General Public License for more details.
  24 *
  25 *  This copyright notice MUST APPEAR in all copies of the script!
  26 ***************************************************************/
  27 /**
  28  * Contains 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 <kasperYYYY@typo3.com>
  34  */
  35 /**
  36  * [CLASS/FUNCTION INDEX of SCRIPT]
  37  *
  38  *
  39  *
  40  *  135: class t3lib_userAuthGroup extends t3lib_userAuth
  41  *
  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)
  67  *
  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)
  76  *
  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)
  83  *
  84  *              SECTION: Workspaces
  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()
  91  *
  92  *              SECTION: Logging
  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)
  96  *
  97  * TOTAL FUNCTIONS: 45
  98  * (This index is automatically created/updated by the extension "extdeveval")
  99  *
 100  */
 101
 102
 103
 104
 105
 106
 107
 108
 109
 110
 111
 112
 113
 114
 115
 116
 117
 118
 119
 120
 121
 122
 123 /**
 124  * Extension to class.t3lib_userauth.php; Authentication of users in TYPO3 Backend
 125  *
 126  * Actually this class is extended again by t3lib_beuserauth which is the actual backend user class that will be instantiated.
 127  * 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.
 128  *
 129  * @author      Kasper Skaarhoj <kasperYYYY@typo3.com>
 130  * @package TYPO3
 131  * @subpackage t3lib
 132  */
 133 class t3lib_userAuthGroup extends t3lib_userAuth {
 134         var $usergroup_column = 'usergroup';            // Should be set to the usergroup-column (id-list) in the user-record
 135         var $usergroup_table = 'be_groups';                     // The name of the group-table
 136
 137                 // internal
 138         var $groupData = Array(                         // This array holds lists of eg. tables, fields and other values related to the permission-system. See fetchGroupData
 139                 'filemounts' => Array()                 // Filemounts are loaded here
 140         );
 141         var $workspace = -99;                           // User workspace. -99 is ERROR (none available), -1 is offline, 0 is online, >0 is custom workspaces.
 142         var $workspaceRec = array();            // Custom workspace record if any
 143
 144         var $userGroups = Array();                      // This array will hold the groups that the user is a member of
 145         var $userGroupsUID = Array();           // This array holds the uid's of the groups in the listed order
 146         var $groupList ='';                                     // This is $this->userGroupsUID imploded to a comma list... Will correspond to the 'usergroup_cached_list'
 147         var $dataLists=array(                           // Used internally to accumulate data for the user-group. DONT USE THIS EXTERNALLY! Use $this->groupData instead
 148                 'webmount_list'=>'',
 149                 'filemount_list'=>'',
 150                 'fileoper_perms' => 0,
 151                 'modList'=>'',
 152                 'tables_select'=>'',
 153                 'tables_modify'=>'',
 154                 'pagetypes_select'=>'',
 155                 'non_exclude_fields'=>'',
 156                 'explicit_allowdeny'=>'',
 157                 'allowed_languages' => '',
 158                 'workspace_perms' => '',
 159                 'custom_options' => '',
 160         );
 161         var $includeHierarchy=array();          // For debugging/display of order in which subgroups are included.
 162         var $includeGroupArray=array();         // List of group_id's in the order they are processed.
 163
 164         var $OS='';                                                     // Set to 'WIN', if windows
 165         var $TSdataArray=array();                       // Used to accumulate the TSconfig data of the user
 166         var $userTS_text = '';                          // Contains the non-parsed user TSconfig
 167         var $userTS = array();                          // Contains the parsed user TSconfig
 168         var $userTSUpdated=0;                           // Set internally if the user TSconfig was parsed and needs to be cached.
 169         var $userTS_dontGetCached=0;            // Set this from outside if you want the user TSconfig to ALWAYS be parsed and not fetched from cache.
 170
 171         var $RTE_errors = array();                      // RTE availability errors collected.
 172         var $errorMsg = '';                                     // Contains last error message
 173
 174         var $checkWorkspaceCurrent_cache=NULL;  // Cache for checkWorkspaceCurrent()
 175
 176
 177
 178
 179
 180
 181
 182
 183
 184
 185
 186         /************************************
 187          *
 188          * Permission checking functions:
 189          *
 190          ************************************/
 191
 192         /**
 193          * Returns true if user is admin
 194          * Basically this function evaluates if the ->user[admin] field has bit 0 set. If so, user is admin.
 195          *
 196          * @return      boolean
 197          */
 198         function isAdmin()      {
 199                 return (($this->user['admin']&1) ==1);
 200         }
 201
 202         /**
 203          * Returns true if the current user is a member of group $groupId
 204          * $groupId must be set. $this->groupList must contain groups
 205          * Will return true also if the user is a member of a group through subgroups.
 206          *
 207          * @param       integer         Group ID to look for in $this->groupList
 208          * @return      boolean
 209          */
 210         function isMemberOfGroup($groupId)      {
 211                 $groupId = intval($groupId);
 212                 if ($this->groupList && $groupId)       {
 213                         return $this->inList($this->groupList, $groupId);
 214                 }
 215         }
 216
 217         /**
 218          * Checks if the permissions is granted based on a page-record ($row) and $perms (binary and'ed)
 219          *
 220          * Bits for permissions, see $perms variable:
 221          *
 222          *              1 - Show:       See/Copy page and the pagecontent.
 223          *              16- Edit pagecontent: Change/Add/Delete/Move pagecontent.
 224          *              2- Edit page: Change/Move the page, eg. change title, startdate, hidden.
 225          *              4- Delete page: Delete the page and pagecontent.
 226          *              8- New pages: Create new pages under the page.
 227          *
 228          * @param       array           $row is the pagerow for which the permissions is checked
 229          * @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.
 230          * @return      boolean         True or False upon evaluation
 231          */
 232         function doesUserHaveAccess($row,$perms)        {
 233                 $userPerms = $this->calcPerms($row);
 234                 return ($userPerms & $perms)==$perms;
 235         }
 236
 237         /**
 238          * Checks if the page id, $id, is found within the webmounts set up for the user.
 239          * This should ALWAYS be checked for any page id a user works with, whether it's about reading, writing or whatever.
 240          * 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.
 241          * 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
 242          * Otherwise the function will return the uid of the webmount which was first found in the rootline of the input page $id
 243          *
 244          * @param       integer         Page ID to check
 245          * @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!)
 246          * @param       boolean         If set, then the function will exit with an error message.
 247          * @return      integer         The page UID of a page in the rootline that matched a mount point
 248          */
 249         function isInWebMount($id,$readPerms='',$exitOnError=0) {
 250                 if (!$GLOBALS['TYPO3_CONF_VARS']['BE']['lockBeUserToDBmounts'] || $this->isAdmin())     return 1;
 251                 $id = intval($id);
 252
 253                         // Check if input id is an offline version page in which case we will map id to the online version:
 254                 $checkRec = t3lib_beFUnc::getRecord('pages',$id,'pid,t3ver_oid');
 255                 if ($checkRec['pid']==-1)       {
 256                         $id = intval($checkRec['t3ver_oid']);
 257                 }
 258
 259                 if (!$readPerms)        $readPerms = $this->getPagePermsClause(1);
 260                 if ($id>0)      {
 261                         $wM = $this->returnWebmounts();
 262                         $rL = t3lib_BEfunc::BEgetRootLine($id,' AND '.$readPerms);
 263
 264                         foreach($rL as $v)      {
 265                                 if ($v['uid'] && in_array($v['uid'],$wM))       {
 266                                         return $v['uid'];
 267                                 }
 268                         }
 269                 }
 270                 if ($exitOnError)       {
 271                         t3lib_BEfunc::typo3PrintError ('Access Error','This page is not within your DB-mounts',0);
 272                         exit;
 273                 }
 274         }
 275
 276         /**
 277          * Checks access to a backend module with the $MCONF passed as first argument
 278          *
 279          * @param       array           $MCONF array of a backend module!
 280          * @param       boolean         If set, an array will issue an error message and exit.
 281          * @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
 282          */
 283         function modAccess($conf,$exitOnError)  {
 284                 if (!t3lib_BEfunc::isModuleSetInTBE_MODULES($conf['name']))     {
 285                         if ($exitOnError)       {
 286                                 t3lib_BEfunc::typo3PrintError ('Fatal Error','This module "'.$conf['name'].'" is not enabled in TBE_MODULES',0);
 287                                 exit;
 288                         }
 289                         return FALSE;
 290                 }
 291
 292                         // Workspaces check:
 293                 if ($conf['workspaces'])        {
 294                         if (($this->workspace===0 && t3lib_div::inList($conf['workspaces'],'online')) ||
 295                                 ($this->workspace===-1 && t3lib_div::inList($conf['workspaces'],'offline')) ||
 296                                 ($this->workspace>0 && t3lib_div::inList($conf['workspaces'],'custom')))        {
 297                                         // ok, go on...
 298                         } else {
 299                                 if ($exitOnError)       {
 300                                         t3lib_BEfunc::typo3PrintError ('Workspace Error','This module "'.$conf['name'].'" is not available under the current workspace',0);
 301                                         exit;
 302                                 }
 303                                 return FALSE;
 304                         }
 305                 }
 306
 307                         // Returns true if conf[access] is not set at all or if the user is admin
 308                 if (!$conf['access']  ||  $this->isAdmin()) return TRUE;
 309
 310                         // If $conf['access'] is set but not with 'admin' then we return true, if the module is found in the modList
 311                 if (!strstr($conf['access'],'admin') && $conf['name'])  {
 312                         $acs = $this->check('modules',$conf['name']);
 313                 }
 314                 if (!$acs && $exitOnError)      {
 315                         t3lib_BEfunc::typo3PrintError ('Access Error','You don\'t have access to this module.',0);
 316                         exit;
 317                 } else return $acs;
 318         }
 319
 320         /**
 321          * Returns a WHERE-clause for the pages-table where user permissions according to input argument, $perms, is validated.
 322          * $perms is the "mask" used to select. Fx. if $perms is 1 then you'll get all pages that a user can actually see!
 323          *              2^0 = show (1)
 324          *              2^1 = edit (2)
 325          *              2^2 = delete (4)
 326          *              2^3 = new (8)
 327          * If the user is 'admin' " 1=1" is returned (no effect)
 328          * 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)
 329          * 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.
 330          *
 331          * @param       integer         Permission mask to use, see function description
 332          * @return      string          Part of where clause. Prefix " AND " to this.
 333          */
 334         function getPagePermsClause($perms)     {
 335                 global $TYPO3_CONF_VARS;
 336                 if (is_array($this->user))      {
 337                         if ($this->isAdmin())   {
 338                                 return ' 1=1';
 339                         }
 340
 341                         $perms = intval($perms);        // Make sure it's integer.
 342                         $str= ' ('.
 343                                 '(pages.perms_everybody & '.$perms.' = '.$perms.')'.    // Everybody
 344                                 ' OR (pages.perms_userid = '.$this->user['uid'].' AND pages.perms_user & '.$perms.' = '.$perms.')';     // User
 345                         if ($this->groupList)   {
 346                                 $str.= ' OR (pages.perms_groupid in ('.$this->groupList.') AND pages.perms_group & '.$perms.' = '.$perms.')';   // Group (if any is set)
 347                         }
 348                         $str.=')';
 349
 350                         // ****************
 351                         // getPagePermsClause-HOOK
 352                         // ****************
 353                         if (is_array($TYPO3_CONF_VARS['SC_OPTIONS']['t3lib/class.t3lib_userauthgroup.php']['getPagePermsClause'])) {
 354
 355                                 foreach($TYPO3_CONF_VARS['SC_OPTIONS']['t3lib/class.t3lib_userauthgroup.php']['getPagePermsClause'] as $_funcRef) {
 356                                         $_params = array('currentClause' => $str, 'perms' => $perms);
 357                                         $str = t3lib_div::callUserFunction($_funcRef, $_params, $this);
 358                                 }
 359                         }
 360
 361                         return $str;
 362                 } else {
 363                         return ' 1=0';
 364                 }
 365         }
 366
 367         /**
 368          * Returns a combined binary representation of the current users permissions for the page-record, $row.
 369          * 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
 370          * If the user is admin, 31 is returned (full permissions for all five flags)
 371          *
 372          * @param       array           Input page row with all perms_* fields available.
 373          * @return      integer         Bitwise representation of the users permissions in relation to input page row, $row
 374          */
 375         function calcPerms($row)        {
 376                 global $TYPO3_CONF_VARS;
 377                 if ($this->isAdmin()) {return 31;}              // Return 31 for admin users.
 378
 379                 $out=0;
 380                 if (isset($row['perms_userid']) && isset($row['perms_user']) && isset($row['perms_groupid']) && isset($row['perms_group']) && isset($row['perms_everybody']) && isset($this->groupList))        {
 381                         if ($this->user['uid']==$row['perms_userid'])   {
 382                                 $out|=$row['perms_user'];
 383                         }
 384                         if ($this->isMemberOfGroup($row['perms_groupid']))      {
 385                                 $out|=$row['perms_group'];
 386                         }
 387                         $out|=$row['perms_everybody'];
 388                 }
 389
 390                 // ****************
 391                 // CALCPERMS hook
 392                 // ****************
 393                 if (is_array($TYPO3_CONF_VARS['SC_OPTIONS']['t3lib/class.t3lib_userauthgroup.php']['calcPerms'])) {
 394                         foreach($TYPO3_CONF_VARS['SC_OPTIONS']['t3lib/class.t3lib_userauthgroup.php']['calcPerms'] as $_funcRef) {
 395                                 $_params = array(
 396                                         'row' => $row,
 397                                         'outputPermissions' => $out
 398                                 );
 399                                 $out = t3lib_div::callUserFunction($_funcRef, $_params, $this);
 400                         }
 401                 }
 402
 403                 return $out;
 404         }
 405
 406         /**
 407          * Returns true if the RTE (Rich Text Editor) can be enabled for the user
 408          * 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]
 409          * The reasons for a FALSE return can be found in $this->RTE_errors
 410          *
 411          * @return      boolean
 412          */
 413         function isRTE()        {
 414                 global $CLIENT;
 415
 416                         // Start:
 417                 $this->RTE_errors = array();
 418                 if (!$this->uc['edit_RTE'])
 419                         $this->RTE_errors[] = 'RTE is not enabled for user!';
 420                 if (!$GLOBALS['TYPO3_CONF_VARS']['BE']['RTEenabled'])
 421                         $this->RTE_errors[] = 'RTE is not enabled in $TYPO3_CONF_VARS["BE"]["RTEenabled"]';
 422
 423
 424                         // Acquire RTE object:
 425                 $RTE = t3lib_BEfunc::RTEgetObj();
 426                 if (!is_object($RTE))   {
 427                         $this->RTE_errors = array_merge($this->RTE_errors, $RTE);
 428                 }
 429
 430                 if (!count($this->RTE_errors))  {
 431                         return TRUE;
 432                 } else {
 433                         return FALSE;
 434                 }
 435         }
 436
 437         /**
 438          * Returns true if the $value is found in the list in a $this->groupData[] index pointed to by $type (array key).
 439          * Can thus be users to check for modules, exclude-fields, select/modify permissions for tables etc.
 440          * If user is admin true is also returned
 441          * Please see the document Inside TYPO3 for examples.
 442          *
 443          * @param       string          The type value; "webmounts", "filemounts", "pagetypes_select", "tables_select", "tables_modify", "non_exclude_fields", "modules"
 444          * @param       string          String to search for in the groupData-list
 445          * @return      boolean         True if permission is granted (that is, the value was found in the groupData list - or the BE_USER is "admin")
 446          */
 447         function check($type,$value)    {
 448                 if (isset($this->groupData[$type]))     {
 449                         if ($this->isAdmin() || $this->inList($this->groupData[$type],$value)) {
 450                                 return 1;
 451                         }
 452                 }
 453         }
 454
 455         /**
 456          * Checking the authMode of a select field with authMode set
 457          *
 458          * @param       string          Table name
 459          * @param       string          Field name (must be configured in TCA and of type "select" with authMode set!)
 460          * @param       string          Value to evaluation (single value, must not contain any of the chars ":,|")
 461          * @param       string          Auth mode keyword (explicitAllow, explicitDeny, individual)
 462          * @return      boolean         True or false whether access is granted or not.
 463          */
 464         function checkAuthMode($table,$field,$value,$authMode)  {
 465                 global $TCA;
 466
 467                         // Admin users can do anything:
 468                 if ($this->isAdmin())   return TRUE;
 469
 470                         // Allow all blank values:
 471                 if (!strcmp($value,'')) return TRUE;
 472
 473                         // Certain characters are not allowed in the value
 474                 if (preg_match('/[:|,]/',$value))       {
 475                         return FALSE;
 476                 }
 477
 478                         // Initialize:
 479                 $testValue = $table.':'.$field.':'.$value;
 480                 $out = TRUE;
 481
 482                         // Checking value:
 483                 switch((string)$authMode)       {
 484                         case 'explicitAllow':
 485                                 if (!$this->inList($this->groupData['explicit_allowdeny'],$testValue.':ALLOW')) {
 486                                         $out = FALSE;
 487                                 }
 488                         break;
 489                         case 'explicitDeny':
 490                                 if ($this->inList($this->groupData['explicit_allowdeny'],$testValue.':DENY'))   {
 491                                         $out = FALSE;
 492                                 }
 493                         break;
 494                         case 'individual':
 495                                 t3lib_div::loadTCA($table);
 496                                 if (is_array($TCA[$table]) && is_array($TCA[$table]['columns'][$field]))        {
 497                                         $items = $TCA[$table]['columns'][$field]['config']['items'];
 498                                         if (is_array($items))   {
 499                                                 foreach($items as $iCfg)        {
 500                                                         if (!strcmp($iCfg[1],$value) && $iCfg[4])       {
 501                                                                 switch((string)$iCfg[4])        {
 502                                                                         case 'EXPL_ALLOW':
 503                                                                                 if (!$this->inList($this->groupData['explicit_allowdeny'],$testValue.':ALLOW')) {
 504                                                                                         $out = FALSE;
 505                                                                                 }
 506                                                                         break;
 507                                                                         case 'EXPL_DENY':
 508                                                                                 if ($this->inList($this->groupData['explicit_allowdeny'],$testValue.':DENY'))   {
 509                                                                                         $out = FALSE;
 510                                                                                 }
 511                                                                         break;
 512                                                                 }
 513                                                                 break;
 514                                                         }
 515                                                 }
 516                                         }
 517                                 }
 518                         break;
 519                 }
 520
 521                 return $out;
 522         }
 523
 524         /**
 525          * Checking if a language value (-1, 0 and >0 for sys_language records) is allowed to be edited by the user.
 526          *
 527          * @param       integer         Language value to evaluate
 528          * @return      boolean         Returns true if the language value is allowed, otherwise false.
 529          */
 530         function checkLanguageAccess($langValue)        {
 531                 if (strcmp(trim($this->groupData['allowed_languages']),''))     {       // The users language list must be non-blank - otherwise all languages are allowed.
 532                         $langValue = intval($langValue);
 533                         if ($langValue != -1 && !$this->check('allowed_languages',$langValue))  {       // Language must either be explicitly allowed OR the lang Value be "-1" (all languages)
 534                                 return FALSE;
 535                         }
 536                 }
 537                 return TRUE;
 538         }
 539
 540         /**
 541          * Check if user has access to all existing localizations for a certain record
 542          *
 543          * @param string        the table
 544          * @param array         the current record
 545          * @return boolean
 546          */
 547         function checkFullLanguagesAccess($table, $record) {
 548                 $recordLocalizationAccess = $this->checkLanguageAccess(0);
 549                 if ($recordLocalizationAccess && t3lib_BEfunc::isTableLocalizable($table)) {
 550
 551                         $pointerField = $GLOBALS['TCA'][$table]['ctrl']['transOrigPointerField'];
 552
 553                         $recordLocalizations = t3lib_BEfunc::getRecordsByField(
 554                                 $table,
 555                                 $pointerField,
 556                                 $record[$pointerField] > 0 ? $record[$pointerField] : $record['uid'],
 557                                 '',
 558                                 '',
 559                                 '',
 560                                 '1'
 561                         );
 562
 563                         if (is_array($recordLocalizations)) {
 564                                 foreach($recordLocalizations as $localization) {
 565                                         $recordLocalizationAccess = $recordLocalizationAccess && $this->checkLanguageAccess($localization[$GLOBALS['TCA'][$table]['ctrl']['languageField']]);
 566                                         if (!$recordLocalizationAccess) {
 567                                                 break;
 568                                         }
 569                                 }
 570                         }
 571
 572                 }
 573                 return $recordLocalizationAccess;
 574         }
 575
 576         /**
 577          * Checking if a user has editing access to a record from a $TCA table.
 578          * 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.
 579          * For instance languages settings, authMode selector boxes are evaluated (and maybe more in the future).
 580          * It will check for workspace dependent access.
 581          * The function takes an ID (integer) or row (array) as second argument.
 582          *
 583          * @param       string          Table name
 584          * @param       mixed           If integer, then this is the ID of the record. If Array this just represents fields in the record.
 585          * @param       boolean         Set, if testing a new (non-existing) record array. Will disable certain checks that doesn't make much sense in that context.
 586          * @param       boolean         Set, if testing a deleted record array.
 587          * @param       boolean         Set, whenever access to all translations of the record is required
 588          * @return      boolean         True if OK, otherwise false
 589          */
 590         function recordEditAccessInternals($table, $idOrRow, $newRecord = FALSE, $deletedRecord = FALSE, $checkFullLanguageAccess = FALSE) {
 591                 global $TCA;
 592
 593                 if (isset($TCA[$table]))        {
 594                         t3lib_div::loadTCA($table);
 595
 596                                 // Always return true for Admin users.
 597                         if ($this->isAdmin())   return TRUE;
 598
 599                                 // Fetching the record if the $idOrRow variable was not an array on input:
 600                         if (!is_array($idOrRow))        {
 601                                 if ($deletedRecord) {
 602                                         $idOrRow = t3lib_BEfunc::getRecord($table, $idOrRow, '*', '', FALSE);
 603                                 } else {
 604                                         $idOrRow = t3lib_BEfunc::getRecord($table, $idOrRow);
 605                                 }
 606                                 if (!is_array($idOrRow))        {
 607                                         $this->errorMsg = 'ERROR: Record could not be fetched.';
 608                                         return FALSE;
 609                                 }
 610                         }
 611
 612                                 // Checking languages:
 613                         if ($TCA[$table]['ctrl']['languageField'])      {
 614                                 if (isset($idOrRow[$TCA[$table]['ctrl']['languageField']]))     {       // Language field must be found in input row - otherwise it does not make sense.
 615                                         if (!$this->checkLanguageAccess($idOrRow[$TCA[$table]['ctrl']['languageField']]))       {
 616                                                 $this->errorMsg = 'ERROR: Language was not allowed.';
 617                                                 return FALSE;
 618                                         } elseif ($checkFullLanguageAccess && $idOrRow[$TCA[$table]['ctrl']['languageField']]==0 && !$this->checkFullLanguagesAccess($table, $idOrRow)) {
 619                                                 $this->errorMsg = 'ERROR: Related/affected language was not allowed.';
 620                                                 return FALSE;
 621                                         }
 622                                 } else {
 623                                         $this->errorMsg = 'ERROR: The "languageField" field named "'.$TCA[$table]['ctrl']['languageField'].'" was not found in testing record!';
 624                                         return FALSE;
 625                                 }
 626                         }
 627
 628                                 // Checking authMode fields:
 629                         if (is_array($TCA[$table]['columns']))  {
 630                                 foreach($TCA[$table]['columns'] as $fN => $fV)  {
 631                                         if (isset($idOrRow[$fN]))       {       //
 632                                                 if ($fV['config']['type']=='select' && $fV['config']['authMode'] && !strcmp($fV['config']['authMode_enforce'],'strict')) {
 633                                                         if (!$this->checkAuthMode($table,$fN,$idOrRow[$fN],$fV['config']['authMode']))  {
 634                                                                 $this->errorMsg = 'ERROR: authMode "'.$fV['config']['authMode'].'" failed for field "'.$fN.'" with value "'.$idOrRow[$fN].'" evaluated';
 635                                                                 return FALSE;
 636                                                         }
 637                                                 }
 638                                         }
 639                                 }
 640                         }
 641
 642                                 // Checking "editlock" feature (doesn't apply to new records)
 643                         if (!$newRecord && $TCA[$table]['ctrl']['editlock'])    {
 644                                 if (isset($idOrRow[$TCA[$table]['ctrl']['editlock']]))  {
 645                                         if ($idOrRow[$TCA[$table]['ctrl']['editlock']]) {
 646                                                 $this->errorMsg = 'ERROR: Record was locked for editing. Only admin users can change this state.';
 647                                                 return FALSE;
 648                                         }
 649                                 } else {
 650                                         $this->errorMsg = 'ERROR: The "editLock" field named "'.$TCA[$table]['ctrl']['editlock'].'" was not found in testing record!';
 651                                         return FALSE;
 652                                 }
 653                         }
 654
 655                                 // Checking record permissions
 656                         // THIS is where we can include a check for "perms_" fields for other records than pages...
 657
 658                                 // Process any hooks
 659                         if (is_array($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_userauthgroup.php']['recordEditAccessInternals']))    {
 660                                 foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_userauthgroup.php']['recordEditAccessInternals'] as $funcRef)     {
 661                                         $params = array(
 662                                                 'table' => $table,
 663                                                 'idOrRow' => $idOrRow,
 664                                                 'newRecord' => $newRecord
 665                                         );
 666                                         if (!t3lib_div::callUserFunction($funcRef, $params, $this)) {
 667                                                 return FALSE;
 668                                         }
 669                                 }
 670                         }
 671
 672                                 // Finally, return true if all is well.
 673                         return TRUE;
 674                 }
 675         }
 676
 677         /**
 678          * Will check a type of permission against the compiled permission integer, $lCP, and in relation to table, $table
 679          *
 680          * @param       integer         $lCP could typically be the "compiled permissions" integer returned by ->calcPerms
 681          * @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)
 682          * @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)
 683          * @return      boolean
 684          * @access private
 685          */
 686         function isPSet($lCP,$table,$type='')   {
 687                 if ($this->isAdmin())   return true;
 688                 if ($table=='pages')    {
 689                         if ($type=='edit')      return $lCP & 2;
 690                         if ($type=='new')       return ($lCP & 8) || ($lCP & 16);       // Create new page OR pagecontent
 691                         if ($type=='delete')    return $lCP & 4;
 692                         if ($type=='editcontent')       return $lCP & 16;
 693                 } else {
 694                         return $lCP & 16;
 695                 }
 696         }
 697
 698         /**
 699          * Returns true if the BE_USER is allowed to *create* shortcuts in the backend modules
 700          *
 701          * @return      boolean
 702          */
 703         function mayMakeShortcut()      {
 704                         // If the old BE is used (maybe with some parameters),
 705                         // check for options.enableShortcuts and options.shortcutFrame being set.
 706                 if (substr($this->getTSConfigVal('auth.BE.redirectToURL'), 0, 12) == 'alt_main.php') {
 707                         return $this->getTSConfigVal('options.enableShortcuts') &&
 708                                 $this->getTSConfigVal('options.shortcutFrame') &&
 709                                 !$this->getTSConfigVal('options.mayNotCreateEditShortcuts');
 710                 }
 711                         // If the new BE is used, don't check options.shortcutFrame,
 712                         // because this is not used there anymore.
 713                 else {
 714                         return $this->getTSConfigVal('options.enableShortcuts') &&
 715                                 !$this->getTSConfigVal('options.mayNotCreateEditShortcuts');
 716                 }
 717         }
 718
 719         /**
 720          * Checking if editing of an existing record is allowed in current workspace if that is offline.
 721          * Rules for editing in offline mode:
 722          *              - record supports versioning and is an offline version from workspace and has the corrent stage
 723          *              - 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
 724          *
 725          * @param       string          Table of record
 726          * @param       array           Integer (record uid) or array where fields are at least: pid, t3ver_wsid, t3ver_stage (if versioningWS is set)
 727          * @return      string          String error code, telling the failure state. FALSE=All ok
 728          */
 729         function workspaceCannotEditRecord($table,$recData)     {
 730
 731                 if ($this->workspace!==0)       {       // Only test offline spaces:
 732
 733                         if (!is_array($recData))        {
 734                                 $recData = t3lib_BEfunc::getRecord($table,$recData,'pid'.($GLOBALS['TCA'][$table]['ctrl']['versioningWS']?',t3ver_wsid,t3ver_stage':''));
 735                         }
 736
 737                         if (is_array($recData)) {
 738                                 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.
 739                                         if (!$GLOBALS['TCA'][$table]['ctrl']['versioningWS'])   {       // No versioning, basic error, inconsistency even! Such records should not have a pid of -1!
 740                                                 return 'Versioning disabled for table';
 741                                         } elseif ((int)$recData['t3ver_wsid']!==$this->workspace)       {       // So does workspace match?
 742                                                 return 'Workspace ID of record didn\'t match current workspace';
 743                                         } else {        // So what about the stage of the version, does that allow editing for this user?
 744                                                 return $this->workspaceCheckStageForCurrent($recData['t3ver_stage']) ? FALSE : 'Record stage "'.$recData['t3ver_stage'].'" and users access level did not allow for editing';
 745                                         }
 746                                 } else {        // We are testing a "live" record:
 747                                         if ($res = $this->workspaceAllowLiveRecordsInPID($recData['pid'], $table)) {    // For "Live" records, check that PID for table allows editing
 748                                                         // Live records are OK in this branch, but what about the stage of branch point, if any:
 749                                                 return $res>0 ? FALSE : 'Stage for versioning root point and users access level did not allow for editing';     // OK
 750                                         } else {        // If not offline and not in versionized branch, output error:
 751                                                 return 'Online record was not in versionized branch!';
 752                                         }
 753                                 }
 754                         } else return 'No record';
 755                 } else {
 756                         return FALSE;   // OK because workspace is 0
 757                 }
 758         }
 759
 760         /**
 761          * Evaluates if a user is allowed to edit the offline version
 762          *
 763          * @param       string          Table of record
 764          * @param       array           Integer (record uid) or array where fields are at least: pid, t3ver_wsid, t3ver_stage (if versioningWS is set)
 765          * @return      string          String error code, telling the failure state. FALSE=All ok
 766          * @see workspaceCannotEditRecord()
 767          */
 768         function workspaceCannotEditOfflineVersion($table,$recData)     {
 769                 if ($GLOBALS['TCA'][$table]['ctrl']['versioningWS'])    {
 770
 771                         if (!is_array($recData))        {
 772                                 $recData = t3lib_BEfunc::getRecord($table,$recData,'uid,pid,t3ver_wsid,t3ver_stage');
 773                         }
 774                         if (is_array($recData)) {
 775                                 if ((int)$recData['pid']===-1)  {
 776                                         return $this->workspaceCannotEditRecord($table,$recData);
 777                                 } else return 'Not an offline version';
 778                         } else return 'No record';
 779                 } else return 'Table does not support versioning.';
 780         }
 781
 782         /**
 783          * Check if "live" records from $table may be created or edited in this PID.
 784          * If the answer is FALSE it means the only valid way to create or edit records in the PID is by versioning
 785          * 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!
 786          *
 787          * @param       integer         PID value to check for.
 788          * @param       string          Table name
 789          * @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.
 790          */
 791         function workspaceAllowLiveRecordsInPID($pid, $table)   {
 792
 793                         // Always for Live workspace AND if live-edit is enabled and tables are completely without versioning it is ok as well.
 794                 if ($this->workspace===0 || ($this->workspaceRec['live_edit'] && !$GLOBALS['TCA'][$table]['ctrl']['versioningWS']) || $GLOBALS['TCA'][$table]['ctrl']['versioningWS_alwaysAllowLiveEdit'])      {
 795                         return 2;       // OK to create for this table.
 796                 } 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.
 797                                 // Now, check what the stage of that "page" or "branch" version type is:
 798                         $stage = t3lib_BEfunc::isPidInVersionizedBranch($pid, $table, TRUE);
 799                         return $this->workspaceCheckStageForCurrent($stage) ? 1 : -1;
 800                 } else {
 801                         return FALSE;   // If the answer is FALSE it means the only valid way to create or edit records in the PID is by versioning
 802                 }
 803         }
 804
 805         /**
 806          * Evaluates if a record from $table can be created in $pid
 807          *
 808          * @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!
 809          * @param       string          Table name
 810          * @return      boolean         TRUE if OK.
 811          */
 812         function workspaceCreateNewRecord($pid, $table) {
 813                 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
 814                         if ($res<0)     {
 815                                 return FALSE;   // Stage for versioning root point and users access level did not allow for editing
 816                         }
 817                 } elseif (!$GLOBALS['TCA'][$table]['ctrl']['versioningWS'])     {       // So, if no live records were allowed, we have to create a new version of this record:
 818                         return FALSE;
 819                 }
 820                 return TRUE;
 821         }
 822
 823         /**
 824          * Evaluates if auto creation of a version of a record is allowed.
 825          *
 826          * @param       string          Table of the record
 827          * @param       integer         UID of record
 828          * @param       integer         PID of record
 829          * @return      boolean         TRUE if ok.
 830          */
 831         function workspaceAllowAutoCreation($table,$id,$recpid) {
 832                         // 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.
 833                 if ($this->workspace!==0        // Only in draft workspaces
 834                         && !$this->workspaceRec['disable_autocreate']   // Auto-creation must not be disabled.
 835                         && $GLOBALS['TCA'][$table]['ctrl']['versioningWS']      // Table must be versionizable
 836                         && $recpid >= 0 // The PID of the record must NOT be -1 or less (would indicate that it already was a version!)
 837                         && !t3lib_BEfunc::getWorkspaceVersionOfRecord($this->workspace, $table, $id, 'uid')     // There must be no existing version of this record in workspace.
 838                         && !t3lib_BEfunc::isPidInVersionizedBranch($recpid, $table))    {       // PID must NOT be in a versionized branch either
 839                                 return TRUE;
 840                 }
 841         }
 842
 843         /**
 844          * Checks if an element stage allows access for the user in the current workspace
 845          * In workspaces 0 (Live) and -1 (Default draft) access is always granted for any stage.
 846          * Admins are always allowed.
 847          * An option for custom workspaces allows members to also edit when the stage is "Review"
 848          *
 849          * @param       integer         Stage id from an element: -1,0 = editing, 1 = reviewer, >1 = owner
 850          * @return      boolean         TRUE if user is allowed access
 851          */
 852         function workspaceCheckStageForCurrent($stage)  {
 853                 if ($this->isAdmin())   return TRUE;
 854
 855                 if ($this->workspace>0) {
 856                         $stat = $this->checkWorkspaceCurrent();
 857                         $memberStageLimit = $this->workspaceRec['review_stage_edit'] ? 1 : 0;
 858                         if (($stage<=$memberStageLimit && $stat['_ACCESS']==='member') ||
 859                                 ($stage<=1 && $stat['_ACCESS']==='reviewer') ||
 860                                 ($stat['_ACCESS']==='owner')) {
 861                                         return TRUE;    // OK for these criteria
 862                         }
 863                 } else return TRUE;     // Always OK for live and draft workspaces.
 864         }
 865
 866         /**
 867          * Returns TRUE if the user has access to publish content from the workspace ID given.
 868          * Admin-users are always granted access to do this
 869          * If the workspace ID is 0 (live) all users have access also
 870          * If -1 (draft workspace) TRUE is returned if the user has access to the Live workspace
 871          * For custom workspaces it depends on whether the user is owner OR like with draft workspace if the user has access to Live workspace.
 872          *
 873          * @param       integer         Workspace UID; -1,0,1+
 874          * @return      boolean         Returns TRUE if the user has access to publish content from the workspace ID given.
 875          */
 876         function workspacePublishAccess($wsid)  {
 877                 if ($this->isAdmin())   return TRUE;
 878
 879                         // If no access to workspace, of course you cannot publish!
 880                 $retVal = FALSE;
 881
 882                 $wsAccess = $this->checkWorkspace($wsid);
 883                 if ($wsAccess)  {
 884                         switch($wsAccess['uid'])        {
 885                                 case 0:         // Live workspace
 886                                         $retVal =  TRUE;        // If access to Live workspace, no problem.
 887                                 break;
 888                                 case -1:        // Default draft workspace
 889                                         $retVal =  $this->checkWorkspace(0) ? TRUE : FALSE;     // If access to Live workspace, no problem.
 890                                 break;
 891                                 default:        // Custom workspace
 892                                         $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.
 893                                 break;
 894                         }
 895                 }
 896                 return $retVal;
 897         }
 898
 899         /**
 900          * Workspace swap-mode access?
 901          *
 902          * @return      boolean         Returns TRUE if records can be swapped in the current workspace, otherwise false
 903          */
 904         function workspaceSwapAccess()  {
 905                 if ($this->workspace>0 && (int)$this->workspaceRec['swap_modes']===2)   {
 906                         return FALSE;
 907                 } else return TRUE;
 908         }
 909
 910         /**
 911          * Workspace Versioning type access?
 912          *
 913          * @param       integer         Versioning type to evaluation: -1, 0, >1
 914          * @return      boolean         TRUE if OK
 915          */
 916         function workspaceVersioningTypeAccess($type)   {
 917                 $retVal = FALSE;
 918
 919                 $type = t3lib_div::intInRange($type,-1);
 920
 921                         // Check if only element versioning is allowed:
 922                 if ($GLOBALS['TYPO3_CONF_VARS']['BE']['elementVersioningOnly'] && $type!=-1)    {
 923                         return FALSE;
 924                 }
 925
 926                 if ($this->workspace>0 && !$this->isAdmin())    {
 927                         $stat = $this->checkWorkspaceCurrent();
 928                         if ($stat['_ACCESS']!=='owner') {
 929
 930                                 switch((int)$type)      {
 931                                         case -1:
 932                                                 $retVal = $this->workspaceRec['vtypes']&1 ? FALSE : TRUE;
 933                                         break;
 934                                         case 0:
 935                                                 $retVal = $this->workspaceRec['vtypes']&2 ? FALSE : TRUE;
 936                                         break;
 937                                         default:
 938                                                 $retVal = $this->workspaceRec['vtypes']&4 ? FALSE : TRUE;
 939                                         break;
 940                                 }
 941                         } else $retVal = TRUE;
 942                 } else $retVal = TRUE;
 943
 944                 return $retVal;
 945         }
 946
 947         /**
 948          * Finding "closest" versioning type, used for creation of new records.
 949          *
 950          * @param       integer         Versioning type to evaluation: -1, 0, >1
 951          * @return      integer         Returning versioning type
 952          */
 953         function workspaceVersioningTypeGetClosest($type)       {
 954                 $type = t3lib_div::intInRange($type,-1);
 955
 956                 if ($this->workspace>0) {
 957                         switch((int)$type)      {
 958                                 case -1:
 959                                         $type = -1;
 960                                 break;
 961                                 case 0:
 962                                         $type = $this->workspaceVersioningTypeAccess($type) ? $type : -1;
 963                                 break;
 964                                 default:
 965                                         $type = $this->workspaceVersioningTypeAccess($type) ? $type : ($this->workspaceVersioningTypeAccess(0) ? 0 : -1);
 966                                 break;
 967                         }
 968                 }
 969                 return $type;
 970         }
 971
 972
 973
 974
 975
 976
 977
 978
 979
 980
 981         /*************************************
 982          *
 983          * Miscellaneous functions
 984          *
 985          *************************************/
 986
 987         /**
 988          * Returns the value/properties of a TS-object as given by $objectString, eg. 'options.dontMountAdminMounts'
 989          * Nice (general!) function for returning a part of a TypoScript array!
 990          *
 991          * @param       string          Pointer to an "object" in the TypoScript array, fx. 'options.dontMountAdminMounts'
 992          * @param       array           Optional TSconfig array: If array, then this is used and not $this->userTS. If not array, $this->userTS is used.
 993          * @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.
 994          * @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.
 995          */
 996         function getTSConfig($objectString,$config='')  {
 997                 if (!is_array($config)) {
 998                         $config=$this->userTS;  // Getting Root-ts if not sent
 999                 }
1000                 $TSConf=array();
1001                 $parts = explode('.',$objectString,2);
1002                 $key = $parts[0];
1003                 if (trim($key)) {
1004                         if (count($parts)>1 && trim($parts[1])) {
1005                                 // Go on, get the next level
1006                                 if (is_array($config[$key.'.']))        $TSConf = $this->getTSConfig($parts[1],$config[$key.'.']);
1007                         } else {
1008                                 $TSConf['value']=$config[$key];
1009                                 $TSConf['properties']=$config[$key.'.'];
1010                         }
1011                 }
1012                 return $TSConf;
1013         }
1014
1015         /**
1016          * Returns the "value" of the $objectString from the BE_USERS "User TSconfig" array
1017          *
1018          * @param       string          Object string, eg. "somestring.someproperty.somesubproperty"
1019          * @return      string          The value for that object string (object path)
1020          * @see getTSConfig()
1021          */
1022         function getTSConfigVal($objectString)  {
1023                 $TSConf = $this->getTSConfig($objectString);
1024                 return $TSConf['value'];
1025         }
1026
1027         /**
1028          * Returns the "properties" of the $objectString from the BE_USERS "User TSconfig" array
1029          *
1030          * @param       string          Object string, eg. "somestring.someproperty.somesubproperty"
1031          * @return      array           The properties for that object string (object path) - if any
1032          * @see getTSConfig()
1033          */
1034         function getTSConfigProp($objectString) {
1035                 $TSConf = $this->getTSConfig($objectString);
1036                 return $TSConf['properties'];
1037         }
1038
1039         /**
1040          * Returns true if $item is in $in_list
1041          *
1042          * @param       string          Comma list with items, no spaces between items!
1043          * @param       string          The string to find in the list of items
1044          * @return      string          Boolean
1045          */
1046         function inList($in_list,$item) {
1047                 return strstr(','.$in_list.',', ','.$item.',');
1048         }
1049
1050         /**
1051          * Returns an array with the webmounts.
1052          * If no webmounts, and empty array is returned.
1053          * 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.
1054          *
1055          * @return      array
1056          */
1057         function returnWebmounts()      {
1058                 return (string)($this->groupData['webmounts'])!='' ? explode(',',$this->groupData['webmounts']) : Array();
1059         }
1060
1061         /**
1062          * Returns an array with the filemounts for the user. Each filemount is represented with an array of a "name", "path" and "type".
1063          * If no filemounts an empty array is returned.
1064          *
1065          * @return      array
1066          */
1067         function returnFilemounts()     {
1068                 return $this->groupData['filemounts'];
1069         }
1070
1071         /**
1072          * Returns an integer bitmask that represents the permissions for file operations.
1073          * Permissions of the user and groups the user is a member of were combined by a logical OR.
1074          *
1075          * Meaning of each bit:
1076          *      1 - Files: Upload,Copy,Move,Delete,Rename
1077          *      2 - Files: Unzip
1078          *      4 - Directory: Move,Delete,Rename,New
1079          *      8 - Directory: Copy
1080          *      16 - Directory: Delete recursively (rm -Rf)
1081          *
1082          * @return      integer         File operation permission bitmask
1083          */
1084         public function getFileoperationPermissions() {
1085                 if ($this->isAdmin()) {
1086                         return 31;
1087                 } else {
1088                         return $this->groupData['fileoper_perms'];
1089                 }
1090         }
1091
1092         /**
1093          * Returns true or false, depending if an alert popup (a javascript confirmation) should be shown
1094          * call like $GLOBALS['BE_USER']->jsConfirmation($BITMASK)
1095          *
1096          *    1 - typeChange
1097          *    2 - copy/move/paste
1098          *    4 - delete
1099          *    8 - frontend editing
1100          *    128 - other (not used yet)
1101          *
1102          * @param       integer   Bitmask
1103          * @return      boolean         true if the confirmation should be shown
1104          */
1105          function jsConfirmation($bitmask)      {
1106                  $alertPopup = $GLOBALS['BE_USER']->getTSConfig('options.alertPopups');
1107                  if (empty($alertPopup['value']))       {
1108                          $alertPopup = 255;     // default: show all warnings
1109                  } else {
1110                          $alertPopup = (int)$alertPopup['value'];
1111                  }
1112                  if(($alertPopup&$bitmask) == $bitmask) { // show confirmation
1113                          return 1;
1114                  } else { // don't show confirmation
1115                          return 0;
1116                  }
1117          }
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127         /*************************************
1128          *
1129          * Authentication methods
1130          *
1131          *************************************/
1132
1133
1134         /**
1135          * Initializes a lot of stuff like the access-lists, database-mountpoints and filemountpoints
1136          * This method is called by ->backendCheckLogin() (from extending class t3lib_beuserauth) if the backend user login has verified OK.
1137          * Generally this is required initialization of a backend user.
1138          *
1139          * @return      void
1140          * @access private
1141          * @see t3lib_TSparser
1142          */
1143         function fetchGroupData()       {
1144                 if ($this->user['uid']) {
1145
1146                                 // Get lists for the be_user record and set them as default/primary values.
1147                         $this->dataLists['modList'] = $this->user['userMods'];                                  // Enabled Backend Modules
1148                         $this->dataLists['allowed_languages'] = $this->user['allowed_languages'];                                       // Add Allowed Languages
1149                         $this->dataLists['workspace_perms'] = $this->user['workspace_perms'];                                   // Set user value for workspace permissions.
1150                         $this->dataLists['webmount_list'] = $this->user['db_mountpoints'];              // Database mountpoints
1151                         $this->dataLists['filemount_list'] = $this->user['file_mountpoints'];   // File mountpoints
1152                         $this->dataLists['fileoper_perms'] = (int)$this->user['fileoper_perms'];        // Fileoperation permissions
1153
1154                                 // Setting default User TSconfig:
1155                         $this->TSdataArray[]=$this->addTScomment('From $GLOBALS["TYPO3_CONF_VARS"]["BE"]["defaultUserTSconfig"]:').
1156                                                                         $GLOBALS['TYPO3_CONF_VARS']['BE']['defaultUserTSconfig'];
1157
1158                                 // Default TSconfig for admin-users
1159                         if ($this->isAdmin())   {
1160                                 $this->TSdataArray[]=$this->addTScomment('"admin" user presets:').'
1161                                         admPanel.enable.all = 1
1162                                         options.shortcutFrame = 1
1163                                 ';
1164                                 if (t3lib_extMgm::isLoaded('sys_note')) {
1165                                         $this->TSdataArray[]='
1166                                                 // Setting defaults for sys_note author / email...
1167                                                 TCAdefaults.sys_note.author = '.$this->user['realName'].'
1168                                                 TCAdefaults.sys_note.email = '.$this->user['email'].'
1169                                         ';
1170                                 }
1171                         }
1172
1173                                 // FILE MOUNTS:
1174                                 // Admin users has the base fileadmin dir mounted
1175                         if ($this->isAdmin() && $GLOBALS['TYPO3_CONF_VARS']['BE']['fileadminDir'])      {
1176                                 $this->addFileMount($GLOBALS['TYPO3_CONF_VARS']['BE']['fileadminDir'], '', PATH_site.$GLOBALS['TYPO3_CONF_VARS']['BE']['fileadminDir'], 0, '');
1177                         }
1178
1179                                 // If userHomePath is set, we attempt to mount it
1180                         if ($GLOBALS['TYPO3_CONF_VARS']['BE']['userHomePath'])  {
1181                                         // First try and mount with [uid]_[username]
1182                                 $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');
1183                                 if (!$didMount) {
1184                                                 // If that failed, try and mount with only [uid]
1185                                         $this->addFileMount($this->user['username'], '', $GLOBALS['TYPO3_CONF_VARS']['BE']['userHomePath'].$this->user['uid'].$GLOBALS['TYPO3_CONF_VARS']['BE']['userUploadDir'], 0, 'user');
1186                                 }
1187                         }
1188
1189                                 // BE_GROUPS:
1190                                 // Get the groups...
1191 #                       $grList = t3lib_BEfunc::getSQLselectableList($this->user[$this->usergroup_column],$this->usergroup_table,$this->usergroup_table);
1192                         $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.
1193                         if ($grList)    {
1194                                         // Fetch groups will add a lot of information to the internal arrays: modules, accesslists, TSconfig etc. Refer to fetchGroups() function.
1195                                 $this->fetchGroups($grList);
1196                         }
1197
1198                                 // Add the TSconfig for this specific user:
1199                         $this->TSdataArray[] = $this->addTScomment('USER TSconfig field').$this->user['TSconfig'];
1200                                 // Check include lines.
1201                         $this->TSdataArray = t3lib_TSparser::checkIncludeLines_array($this->TSdataArray);
1202
1203                         $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.
1204
1205                         if ($GLOBALS['TYPO3_CONF_VARS']['BE']['TSconfigConditions'] && !$this->userTS_dontGetCached) {
1206                                         // Perform TS-Config parsing with condition matching
1207                                 $parseObj = t3lib_div::makeInstance('t3lib_TSparser_TSconfig');
1208                                 $res = $parseObj->parseTSconfig($this->userTS_text, 'userTS');
1209                                 if ($res) {
1210                                         $this->userTS = $res['TSconfig'];
1211                                         $this->userTSUpdated = ($res['cached'] ? 0 : 1);
1212                                 }
1213                         } else {
1214                                         // Parsing the user TSconfig (or getting from cache)
1215                                 $hash = md5('userTS:' . $this->userTS_text);
1216                                 $cachedContent = t3lib_BEfunc::getHash($hash);
1217                                 if (isset($cachedContent) && !$this->userTS_dontGetCached) {
1218                                         $this->userTS = unserialize($cachedContent);
1219                                 } else {
1220                                         $parseObj = t3lib_div::makeInstance('t3lib_TSparser');
1221                                         $parseObj->parse($this->userTS_text);
1222                                         $this->userTS = $parseObj->setup;
1223                                         t3lib_BEfunc::storeHash($hash, serialize($this->userTS), 'BE_USER_TSconfig');
1224                                                 // Update UC:
1225                                         $this->userTSUpdated=1;
1226                                 }
1227                         }
1228
1229                                 // Processing webmounts
1230                         if ($this->isAdmin() && !$this->getTSConfigVal('options.dontMountAdminMounts')) {       // Admin's always have the root mounted
1231                                 $this->dataLists['webmount_list']='0,'.$this->dataLists['webmount_list'];
1232                         }
1233
1234                                 // Processing filemounts
1235                         t3lib_div::loadTCA('sys_filemounts');
1236                         $orderBy = $GLOBALS['TCA']['sys_filemounts']['ctrl']['default_sortby'] ? $GLOBALS['TYPO3_DB']->stripOrderBy($GLOBALS['TCA']['sys_filemounts']['ctrl']['default_sortby']) : 'sorting';
1237                         $this->dataLists['filemount_list'] = t3lib_div::uniqueList($this->dataLists['filemount_list']);
1238                         if ($this->dataLists['filemount_list']) {
1239                                 $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery('*', 'sys_filemounts', 'deleted=0 AND hidden=0 AND pid=0 AND uid IN ('.$this->dataLists['filemount_list'].')', '', $orderBy);
1240                                 while ($row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res))      {
1241                                         $this->addFileMount($row['title'], $row['path'], $row['path'], $row['base']?1:0, '');
1242                                 }
1243                         }
1244
1245                                 // The lists are cleaned for duplicates
1246                         $this->groupData['webmounts'] = t3lib_div::uniqueList($this->dataLists['webmount_list']);
1247                         $this->groupData['pagetypes_select'] = t3lib_div::uniqueList($this->dataLists['pagetypes_select']);
1248                         $this->groupData['tables_select'] = t3lib_div::uniqueList($this->dataLists['tables_modify'].','.$this->dataLists['tables_select']);
1249                         $this->groupData['tables_modify'] = t3lib_div::uniqueList($this->dataLists['tables_modify']);
1250                         $this->groupData['non_exclude_fields'] = t3lib_div::uniqueList($this->dataLists['non_exclude_fields']);
1251                         $this->groupData['explicit_allowdeny'] = t3lib_div::uniqueList($this->dataLists['explicit_allowdeny']);
1252                         $this->groupData['allowed_languages'] = t3lib_div::uniqueList($this->dataLists['allowed_languages']);
1253                         $this->groupData['custom_options'] = t3lib_div::uniqueList($this->dataLists['custom_options']);
1254                         $this->groupData['modules'] = t3lib_div::uniqueList($this->dataLists['modList']);
1255                         $this->groupData['fileoper_perms'] = $this->dataLists['fileoper_perms'];
1256                         $this->groupData['workspace_perms'] = $this->dataLists['workspace_perms'];
1257
1258                                 // populating the $this->userGroupsUID -array with the groups in the order in which they were LAST included.!!
1259                         $this->userGroupsUID = array_reverse(array_unique(array_reverse($this->includeGroupArray)));
1260
1261                                 // 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)
1262                         $this->groupList = implode(',',$this->userGroupsUID);
1263                         $this->setCachedList($this->groupList);
1264
1265                                 // Checking read access to webmounts:
1266                         if (trim($this->groupData['webmounts'])!=='')   {
1267                                 $webmounts = explode(',',$this->groupData['webmounts']);        // Explode mounts
1268                                 $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
1269                                 foreach($webmounts as $idx => $mountPointUid)   {
1270                                         if ($mountPointUid>0 && !isset($MProws[$mountPointUid]))        {       // If the mount ID is NOT found among selected pages, unset it:
1271                                                 unset($webmounts[$idx]);
1272                                         }
1273                                 }
1274                                 $this->groupData['webmounts'] = implode(',',$webmounts);        // Implode mounts in the end.
1275                         }
1276
1277                                 // Setting up workspace situation (after webmounts are processed!):
1278                         $this->workspaceInit();
1279                 }
1280         }
1281
1282         /**
1283          * Fetches the group records, subgroups and fills internal arrays.
1284          * Function is called recursively to fetch subgroups
1285          *
1286          * @param       string          Commalist of be_groups uid numbers
1287          * @param       string          List of already processed be_groups-uids so the function will not fall into a eternal recursion.
1288          * @return      void
1289          * @access private
1290          */
1291         function fetchGroups($grList,$idList='')        {
1292                 global $TYPO3_CONF_VARS;
1293
1294                         // Fetching records of the groups in $grList (which are not blocked by lockedToDomain either):
1295                 $lockToDomain_SQL = ' AND (lockToDomain=\'\' OR lockToDomain IS NULL OR lockToDomain=\''.t3lib_div::getIndpEnv('HTTP_HOST').'\')';
1296                 $whereSQL = 'deleted=0 AND hidden=0 AND pid=0 AND uid IN ('.$grList.')'.$lockToDomain_SQL;
1297
1298                         // Hook for manipulation of the WHERE sql sentence which controls which BE-groups are included
1299                 if (is_array ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_userauthgroup.php']['fetchGroupQuery'])) {
1300                         foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_userauthgroup.php']['fetchGroupQuery'] as $classRef) {
1301                         $hookObj = t3lib_div::getUserObj($classRef);
1302                         if(method_exists($hookObj,'fetchGroupQuery_processQuery')){
1303                                 $whereSQL = $hookObj->fetchGroupQuery_processQuery($this, $grList, $idList, $whereSQL);
1304                         }
1305                         }
1306                 }
1307
1308                 $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery('*', $this->usergroup_table, $whereSQL);
1309
1310                         // The userGroups array is filled
1311                 while ($row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res))      {
1312                         $this->userGroups[$row['uid']] = $row;
1313                 }
1314
1315                         // Traversing records in the correct order
1316                 $include_staticArr = t3lib_div::intExplode(',',$grList);
1317                 reset($include_staticArr);
1318                 while(list(,$uid)=each($include_staticArr))     {       // traversing list
1319
1320                                 // Get row:
1321                         $row=$this->userGroups[$uid];
1322                         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
1323
1324                                         // Include sub groups
1325                                 if (trim($row['subgroup']))     {
1326                                         $theList = implode(',',t3lib_div::intExplode(',',$row['subgroup']));    // Make integer list
1327                                         $this->fetchGroups($theList, $idList.','.$uid);         // Call recursively, pass along list of already processed groups so they are not recursed again.
1328                                 }
1329                                         // Add the group uid, current list, TSconfig to the internal arrays.
1330                                 $this->includeGroupArray[]=$uid;
1331                                 $this->includeHierarchy[]=$idList;
1332                                 $this->TSdataArray[] = $this->addTScomment('Group "'.$row['title'].'" ['.$row['uid'].'] TSconfig field:').$row['TSconfig'];
1333
1334                                         // Mount group database-mounts
1335                                 if (($this->user['options']&1) == 1)    {       $this->dataLists['webmount_list'].= ','.$row['db_mountpoints']; }
1336
1337                                         // Mount group file-mounts
1338                                 if (($this->user['options']&2) == 2)    {       $this->dataLists['filemount_list'].= ','.$row['file_mountpoints'];      }
1339
1340                                         // Mount group home-dirs
1341                                 if (($this->user['options']&2) == 2)    {
1342                                                 // If groupHomePath is set, we attempt to mount it
1343                                         if ($GLOBALS['TYPO3_CONF_VARS']['BE']['groupHomePath']) {
1344                                                 $this->addFileMount($row['title'], '', $GLOBALS['TYPO3_CONF_VARS']['BE']['groupHomePath'].$row['uid'], 0, 'group');
1345                                         }
1346                                 }
1347
1348                                         // The lists are made: groupMods, tables_select, tables_modify, pagetypes_select, non_exclude_fields, explicit_allowdeny, allowed_languages, custom_options
1349                                 if ($row['inc_access_lists']==1)        {
1350                                         $this->dataLists['modList'].= ','.$row['groupMods'];
1351                                         $this->dataLists['tables_select'].= ','.$row['tables_select'];
1352                                         $this->dataLists['tables_modify'].= ','.$row['tables_modify'];
1353                                         $this->dataLists['pagetypes_select'].= ','.$row['pagetypes_select'];
1354                                         $this->dataLists['non_exclude_fields'].= ','.$row['non_exclude_fields'];
1355                                         $this->dataLists['explicit_allowdeny'].= ','.$row['explicit_allowdeny'];
1356                                         $this->dataLists['allowed_languages'].= ','.$row['allowed_languages'];
1357                                         $this->dataLists['custom_options'].= ','.$row['custom_options'];
1358                                 }
1359
1360                                 // Setting fileoperation permissions
1361                                 $this->dataLists['fileoper_perms'] |= (int)$row['fileoper_perms'];
1362
1363                                         // Setting workspace permissions:
1364                                 $this->dataLists['workspace_perms'] |= $row['workspace_perms'];
1365
1366                                         // 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.
1367                                 if (!strcmp($idList,'') && !$this->firstMainGroup)      {
1368                                         $this->firstMainGroup=$uid;
1369                                 }
1370                         }
1371                 }
1372
1373                 // ****************
1374                 // HOOK: fetchGroups_postProcessing
1375                 // ****************
1376                 if (is_array($TYPO3_CONF_VARS['SC_OPTIONS']['t3lib/class.t3lib_userauthgroup.php']['fetchGroups_postProcessing'])) {
1377                         foreach($TYPO3_CONF_VARS['SC_OPTIONS']['t3lib/class.t3lib_userauthgroup.php']['fetchGroups_postProcessing'] as $_funcRef) {
1378                                 $_params = array();
1379                                 t3lib_div::callUserFunction($_funcRef, $_params, $this);
1380                         }
1381                 }
1382         }
1383
1384         /**
1385          * Updates the field be_users.usergroup_cached_list if the groupList of the user has changed/is different from the current list.
1386          * 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.
1387          *
1388          * @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.
1389          * @return      void
1390          * @access private
1391          */
1392         function setCachedList($cList)  {
1393                 if ((string)$cList != (string)$this->user['usergroup_cached_list'])     {
1394                         $GLOBALS['TYPO3_DB']->exec_UPDATEquery('be_users', 'uid='.intval($this->user['uid']), array('usergroup_cached_list' => $cList));
1395                 }
1396         }
1397
1398         /**
1399          * Adds a filemount to the users array of filemounts, $this->groupData['filemounts'][hash_key] = Array ('name'=>$name, 'path'=>$path, 'type'=>$type);
1400          * Is a part of the authentication proces of the user.
1401          * 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!
1402          * Paths in the mounted information will always be absolute and have a trailing slash.
1403          *
1404          * @param       string          $title will be the (root)name of the filemount in the folder tree
1405          * @param       string          $altTitle will be the (root)name of the filemount IF $title is not true (blank or zero)
1406          * @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.
1407          * @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.
1408          * @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.
1409          * @return      boolean         Returns "1" if the requested filemount was mounted, otherwise no return value.
1410          * @access private
1411          */
1412         function addFileMount($title, $altTitle, $path, $webspace, $type)       {
1413                         // Return false if fileadminDir is not set and we try to mount a relative path
1414                 if ($webspace && !$GLOBALS['TYPO3_CONF_VARS']['BE']['fileadminDir'])    return false;
1415
1416                         // Trimming and pre-processing
1417                 $path=trim($path);
1418                 if ($this->OS=='WIN')   {               // with WINDOWS convert backslash to slash!!
1419                         $path=str_replace('\\','/',$path);
1420                 }
1421                         // If the path is true and validates as a valid path string:
1422                 if ($path && t3lib_div::validPathStr($path))    {
1423                                 // normalize path: remove leading '/' and './', and trailing '/' and '/.'
1424                         $path=trim($path);
1425                         $path=preg_replace('#^\.?/|/\.?$#','',$path);
1426
1427                         if ($path)      {       // there must be some chars in the path
1428                                 $fdir=PATH_site.$GLOBALS['TYPO3_CONF_VARS']['BE']['fileadminDir'];      // fileadmin dir, absolute
1429                                 if ($webspace)  {
1430                                         $path=$fdir.$path;      // PATH_site + fileadmin dir is prepended
1431                                 } else {
1432                                         if ($this->OS!='WIN')   {               // with WINDOWS no prepending!!
1433                                                 $path='/'.$path;        // root-level is the start...
1434                                         }
1435                                 }
1436                                 $path.='/';
1437
1438                                         // We now have a path with slash after and slash before (if unix)
1439                                 if (@is_dir($path) &&
1440                                         (($GLOBALS['TYPO3_CONF_VARS']['BE']['lockRootPath'] && t3lib_div::isFirstPartOfStr($path,$GLOBALS['TYPO3_CONF_VARS']['BE']['lockRootPath'])) || t3lib_div::isFirstPartOfStr($path,$fdir)))      {
1441                                                         // Alternative title?
1442                                                 $name = $title ? $title : $altTitle;
1443                                                         // 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.
1444                                                 $this->groupData['filemounts'][md5($name.'|'.$path.'|'.$type)] = Array('name'=>$name, 'path'=>$path, 'type'=>$type);
1445                                                         // Return true - went well, success!
1446                                                 return 1;
1447                                 }
1448                         }
1449                 }
1450         }
1451
1452         /**
1453          * Creates a TypoScript comment with the string text inside.
1454          *
1455          * @param       string          The text to wrap in comment prefixes and delimiters.
1456          * @return      string          TypoScript comment with the string text inside.
1457          */
1458         function addTScomment($str)     {
1459                 $delimiter = '# ***********************************************';
1460
1461                 $out = $delimiter.chr(10);
1462                 $lines = t3lib_div::trimExplode(chr(10),$str);
1463                 foreach($lines as $v)   {
1464                         $out.= '# '.$v.chr(10);
1465                 }
1466                 $out.= $delimiter.chr(10);
1467                 return $out;
1468         }
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481         /************************************
1482          *
1483          * Workspaces
1484          *
1485          ************************************/
1486
1487         /**
1488          * Initializing workspace.
1489          * Called from within this function, see fetchGroupData()
1490          *
1491          * @return      void
1492          * @see fetchGroupData()
1493          */
1494         function workspaceInit()        {
1495
1496                         // Initializing workspace by evaluating and setting the workspace, possibly updating it in the user record!
1497                 $this->setWorkspace($this->user['workspace_id']);
1498
1499                         // Setting up the db mount points of the (custom) workspace, if any:
1500                 if ($this->workspace>0 && trim($this->workspaceRec['db_mountpoints'])!=='')     {
1501
1502                                 // Initialize:
1503                         $newMounts = array();
1504                         $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.
1505
1506                                 // Traverse mount points of the
1507                         $mountPoints = t3lib_div::intExplode(',',$this->workspaceRec['db_mountpoints']);
1508                         foreach($mountPoints as $mpId)  {
1509                                 if ($this->isInWebMount($mpId,$readPerms))      {
1510                                         $newMounts[] = $mpId;
1511                                 }
1512                         }
1513
1514                                 // Re-insert webmounts:
1515                         $this->groupData['webmounts'] = implode(',',array_unique($newMounts));
1516                 }
1517
1518                         // Setting up the file mount points of the (custom) workspace, if any:
1519                 if ($this->workspace!==0)       $this->groupData['filemounts'] = array();
1520                 if ($this->workspace>0 && trim($this->workspaceRec['file_mountpoints'])!=='')   {
1521
1522                                 // Processing filemounts
1523                         $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']).')');
1524                         while ($row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res))      {
1525                                 $this->addFileMount($row['title'], $row['path'], $row['path'], $row['base']?1:0, '');
1526                         }
1527                 }
1528
1529                 if ($allowed_languages = $this->getTSConfigVal('options.workspaces.allowed_languages.'.$this->workspace))       {
1530                         $this->groupData['allowed_languages'] = $allowed_languages;
1531                         $this->groupData['allowed_languages'] = t3lib_div::uniqueList($this->groupData['allowed_languages']);
1532                 }
1533         }
1534
1535         /**
1536          * Checking if a workspace is allowed for backend user
1537          *
1538          * @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)
1539          * @param       string          List of fields to select. Default fields are: uid,title,adminusers,members,reviewers,publish_access,stagechg_notification
1540          * @return      array           TRUE if access. Output will also show how access was granted. Admin users will have a true output regardless of input.
1541          */
1542         function checkWorkspace($wsRec,$fields='uid,title,adminusers,members,reviewers,publish_access,stagechg_notification')   {
1543                 $retVal = FALSE;
1544
1545                         // If not array, look up workspace record:
1546                 if (!is_array($wsRec))  {
1547                         switch((string)$wsRec)  {
1548                                 case '0':
1549                                 case '-1':
1550                                         $wsRec = array('uid' => $wsRec);
1551                                 break;
1552                                 default:
1553                                         list($wsRec) = $GLOBALS['TYPO3_DB']->exec_SELECTgetRows(
1554                                                 $fields,
1555                                                 'sys_workspace',
1556                                                 'pid=0 AND uid='.intval($wsRec).
1557                                                         t3lib_BEfunc::deleteClause('sys_workspace'),
1558                                                 '',
1559                                                 'title'
1560                                         );
1561                                 break;
1562                         }
1563                 }
1564
1565                         // If wsRec is set to an array, evaluate it:
1566                 if (is_array($wsRec))   {
1567                         if ($this->isAdmin())   {
1568                                 return array_merge($wsRec,array('_ACCESS' => 'admin'));
1569                         } else {
1570
1571                                 switch((string)$wsRec['uid'])   {
1572                                         case '0':
1573                                                 $retVal = ($this->groupData['workspace_perms']&1) ? array_merge($wsRec,array('_ACCESS' => 'online')) : FALSE;
1574                                         break;
1575                                         case '-1':
1576                                                 $retVal = ($this->groupData['workspace_perms']&2) ? array_merge($wsRec,array('_ACCESS' => 'offline')) : FALSE;
1577                                         break;
1578                                         default:
1579                                                         // Checking if the guy is admin:
1580                                                 if (t3lib_div::inList($wsRec['adminusers'],$this->user['uid'])) {
1581                                                         return array_merge($wsRec, array('_ACCESS' => 'owner'));
1582                                                 }
1583                                                         // Checking if he is reviewer user:
1584                                                 if (t3lib_div::inList($wsRec['reviewers'],'be_users_'.$this->user['uid']))      {
1585                                                         return array_merge($wsRec, array('_ACCESS' => 'reviewer'));
1586                                                 }
1587                                                         // Checking if he is reviewer through a user group of his:
1588                                                 foreach($this->userGroupsUID as $groupUid)      {
1589                                                         if (t3lib_div::inList($wsRec['reviewers'],'be_groups_'.$groupUid))      {
1590                                                                 return array_merge($wsRec, array('_ACCESS' => 'reviewer'));
1591                                                         }
1592                                                 }
1593                                                         // Checking if he is member as user:
1594                                                 if (t3lib_div::inList($wsRec['members'],'be_users_'.$this->user['uid']))        {
1595                                                         return array_merge($wsRec, array('_ACCESS' => 'member'));
1596                                                 }
1597                                                         // Checking if he is member through a user group of his:
1598                                                 foreach($this->userGroupsUID as $groupUid)      {
1599                                                         if (t3lib_div::inList($wsRec['members'],'be_groups_'.$groupUid))        {
1600                                                                 return array_merge($wsRec, array('_ACCESS' => 'member'));
1601                                                         }
1602                                                 }
1603                                         break;
1604                                 }
1605                         }
1606                 }
1607
1608                 return $retVal;
1609         }
1610
1611         /**
1612          * 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.
1613          *
1614          * @return      array           See checkWorkspace()
1615          * @see checkWorkspace()
1616          */
1617         function checkWorkspaceCurrent()        {
1618                 if (!isset($this->checkWorkspaceCurrent_cache)) {
1619                         $this->checkWorkspaceCurrent_cache = $this->checkWorkspace($this->workspace);
1620                 }
1621                 return $this->checkWorkspaceCurrent_cache;
1622         }
1623
1624         /**
1625          * Setting workspace ID
1626          *
1627          * @param       integer         ID of workspace to set for backend user. If not valid the default workspace for BE user is found and set.
1628          * @return      void
1629          */
1630         function setWorkspace($workspaceId)     {
1631
1632                         // Check workspace validity and if not found, revert to default workspace.
1633                 if ($this->workspaceRec = $this->checkWorkspace($workspaceId,'*'))      {
1634                                 // Set workspace ID internally
1635                         $this->workspace = (int)$workspaceId;
1636                 } else {
1637                         $this->workspace = (int)$this->getDefaultWorkspace();
1638                         $this->workspaceRec = $this->checkWorkspace($this->workspace,'*');
1639                 }
1640
1641                         // Unset access cache:
1642                 unset($this->checkWorkspaceCurrent_cache);
1643
1644                         // If ID is different from the stored one, change it:
1645                 if (strcmp($this->workspace, $this->user['workspace_id']))      {
1646                         $this->user['workspace_id'] = $this->workspace;
1647                         $GLOBALS['TYPO3_DB']->exec_UPDATEquery('be_users','uid='.intval($this->user['uid']),array('workspace_id' => $this->user['workspace_id']));
1648                         $this->simplelog('User changed workspace to "'.$this->workspace.'"');
1649                 }
1650         }
1651
1652         /**
1653          * Setting workspace preview state for user:
1654          *
1655          * @param       boolean         State of user preview.
1656          * @return      void
1657          */
1658         function setWorkspacePreview($previewState)     {
1659                 $this->user['workspace_preview'] = $previewState;
1660                 $GLOBALS['TYPO3_DB']->exec_UPDATEquery('be_users','uid='.intval($this->user['uid']),array('workspace_preview' => $this->user['workspace_preview']));
1661         }
1662
1663         /**
1664          * Return default workspace ID for user
1665          *
1666          * @return      integer         Default workspace id. If no workspace is available it will be "-99"
1667          */
1668         function getDefaultWorkspace()  {
1669
1670                 if ($this->checkWorkspace(0))   {       // Check online
1671                         return 0;
1672                 } elseif ($this->checkWorkspace(-1))    {       // Check offline
1673                         return -1;
1674                 } else {        // Traverse custom workspaces:
1675                         $workspaces = $GLOBALS['TYPO3_DB']->exec_SELECTgetRows('uid,title,adminusers,members,reviewers','sys_workspace','pid=0'.t3lib_BEfunc::deleteClause('sys_workspace'),'','title');
1676                         foreach($workspaces as $rec)    {
1677                                 if ($this->checkWorkspace($rec))        {
1678                                         return $rec['uid'];
1679                                 }
1680                         }
1681                 }
1682                 return -99;
1683         }
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695         /************************************
1696          *
1697          * Logging
1698          *
1699          ************************************/
1700
1701         /**
1702          * Writes an entry in the logfile/table
1703          * Documentation in "TYPO3 Core API"
1704          *
1705          * @param       integer         Denotes which module that has submitted the entry. See "TYPO3 Core API". Use "4" for extensions.
1706          * @param       integer         Denotes which specific operation that wrote the entry. Use "0" when no sub-categorizing applies
1707          * @param       integer         Flag. 0 = message, 1 = error (user problem), 2 = System Error (which should not happen), 3 = security notice (admin)
1708          * @param       integer         The message number. Specific for each $type and $action. This will make it possible to translate errormessages to other languages
1709          * @param       string          Default text that follows the message (in english!). Possibly translated by identification through type/action/details_nr
1710          * @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
1711          * @param       string          Table name. Special field used by tce_main.php.
1712          * @param       integer         Record UID. Special field used by tce_main.php.
1713          * @param       integer         Record PID. Special field used by tce_main.php. OBSOLETE
1714          * @param       integer         The page_uid (pid) where the event occurred. Used to select log-content for specific pages.
1715          * @param       string          Special field used by tce_main.php. NEWid string of newly created records.
1716          * @param       integer         Alternative Backend User ID (used for logging login actions where this is not yet known).
1717          * @return      integer         Log entry ID.
1718          */
1719         function writelog($type,$action,$error,$details_nr,$details,$data,$tablename='',$recuid='',$recpid='',$event_pid=-1,$NEWid='',$userId=0) {
1720
1721                 $fields_values = Array (
1722                         'userid' => $userId ? $userId : intval($this->user['uid']),
1723                         'type' => intval($type),
1724                         'action' => intval($action),
1725                         'error' => intval($error),
1726                         'details_nr' => intval($details_nr),
1727                         'details' => $details,
1728                         'log_data' => serialize($data),
1729                         'tablename' => $tablename,
1730                         'recuid' => intval($recuid),
1731 #                       'recpid' => intval($recpid),
1732                         'IP' => t3lib_div::getIndpEnv('REMOTE_ADDR'),
1733                         'tstamp' => $GLOBALS['EXEC_TIME'],
1734                         'event_pid' => intval($event_pid),
1735                         'NEWid' => $NEWid,
1736                         'workspace' => $this->workspace
1737                 );
1738
1739                 $GLOBALS['TYPO3_DB']->exec_INSERTquery('sys_log', $fields_values);
1740                 return $GLOBALS['TYPO3_DB']->sql_insert_id();
1741         }
1742
1743         /**
1744          * Simple logging function
1745          *
1746          * @param       string          Log message
1747          * @param       string          Option extension key / module name
1748          * @param       integer         Error level. 0 = message, 1 = error (user problem), 2 = System Error (which should not happen), 3 = security notice (admin)
1749          * @return      integer         Log entry UID
1750          */
1751         function simplelog($message, $extKey='', $error=0)      {
1752                 return $this->writelog(
1753                         4,
1754                         0,
1755                         $error,
1756                         0,
1757                         ($extKey?'['.$extKey.'] ':'').$message,
1758                         array()
1759                 );
1760         }
1761
1762         /**
1763          * Sends a warning to $email if there has been a certain amount of failed logins during a period.
1764          * 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.
1765          *
1766          * @param       string          Email address
1767          * @param       integer         Number of sections back in time to check. This is a kind of limit for how many failures an hour for instance.
1768          * @param       integer         Max allowed failures before a warning mail is sent
1769          * @return      void
1770          * @access private
1771          */
1772         function checkLogFailures($email, $secondsBack=3600, $max=3)    {
1773
1774                 if ($email)     {
1775
1776                                 // get last flag set in the log for sending
1777                         $theTimeBack = $GLOBALS['EXEC_TIME'] - $secondsBack;
1778                         $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery(
1779                                                         'tstamp',
1780                                                         'sys_log',
1781                                                         'type=255 AND action=4 AND tstamp>'.intval($theTimeBack),
1782                                                         '',
1783                                                         'tstamp DESC',
1784                                                         '1'
1785                                                 );
1786                         if ($testRow = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res))     {
1787                                 $theTimeBack = $testRow['tstamp'];
1788                         }
1789
1790                                 // Check for more than $max number of error failures with the last period.
1791                         $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery(
1792                                                         '*',
1793                                                         'sys_log',
1794                                                         'type=255 AND action=3 AND error!=0 AND tstamp>'.intval($theTimeBack),
1795                                                         '',
1796                                                         'tstamp'
1797                                                 );
1798                         if ($GLOBALS['TYPO3_DB']->sql_num_rows($res) > $max)    {
1799                                         // OK, so there were more than the max allowed number of login failures - so we will send an email then.
1800                                 $subject = 'TYPO3 Login Failure Warning (at '.$GLOBALS['TYPO3_CONF_VARS']['SYS']['sitename'].')';
1801                                 $email_body = '
1802 There has been numerous attempts ('.$GLOBALS['TYPO3_DB']->sql_num_rows($res).') to login at the TYPO3
1803 site "'.$GLOBALS['TYPO3_CONF_VARS']['SYS']['sitename'].'" ('.t3lib_div::getIndpEnv('HTTP_HOST').').
1804
1805 This is a dump of the failures:
1806
1807 ';
1808                                 while($testRows = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res))  {
1809                                         $theData = unserialize($testRows['log_data']);
1810                                         $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]);
1811                                         $email_body.= chr(10);
1812                                 }
1813                                 mail(   $email,
1814                                         $subject,
1815                                         $email_body,
1816                                         'From: TYPO3 Login WARNING<>'
1817                                 );
1818                                 $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
1819                         }
1820                 }
1821         }
1822 }
1823
1824
1825
1826 if (defined('TYPO3_MODE') && $TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['t3lib/class.t3lib_userauthgroup.php'])     {
1827         include_once($TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['t3lib/class.t3lib_userauthgroup.php']);
1828 }
1829
1830 ?>