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          * Checking if a user has editing access to a record from a $TCA table.
 542          * 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.
 543          * For instance languages settings, authMode selector boxes are evaluated (and maybe more in the future).
 544          * It will check for workspace dependent access.
 545          * The function takes an ID (integer) or row (array) as second argument.
 546          *
 547          * @param       string          Table name
 548          * @param       mixed           If integer, then this is the ID of the record. If Array this just represents fields in the record.
 549          * @param       boolean         Set, if testing a new (non-existing) record array. Will disable certain checks that doesn't make much sense in that context.
 550          * @return      boolean         True if OK, otherwise false
 551          */
 552         function recordEditAccessInternals($table,$idOrRow,$newRecord=FALSE)    {
 553                 global $TCA;
 554
 555                 if (isset($TCA[$table]))        {
 556                         t3lib_div::loadTCA($table);
 557
 558                                 // Always return true for Admin users.
 559                         if ($this->isAdmin())   return TRUE;
 560
 561                                 // Fetching the record if the $idOrRow variable was not an array on input:
 562                         if (!is_array($idOrRow))        {
 563                                 $idOrRow = t3lib_BEfunc::getRecord($table, $idOrRow);
 564                                 if (!is_array($idOrRow))        {
 565                                         $this->errorMsg = 'ERROR: Record could not be fetched.';
 566                                         return FALSE;
 567                                 }
 568                         }
 569
 570                                 // Checking languages:
 571                         if ($TCA[$table]['ctrl']['languageField'])      {
 572                                 if (isset($idOrRow[$TCA[$table]['ctrl']['languageField']]))     {       // Language field must be found in input row - otherwise it does not make sense.
 573                                         if (!$this->checkLanguageAccess($idOrRow[$TCA[$table]['ctrl']['languageField']]))       {
 574                                                 $this->errorMsg = 'ERROR: Language was not allowed.';
 575                                                 return FALSE;
 576                                         }
 577                                 } else {
 578                                         $this->errorMsg = 'ERROR: The "languageField" field named "'.$TCA[$table]['ctrl']['languageField'].'" was not found in testing record!';
 579                                         return FALSE;
 580                                 }
 581                         }
 582
 583                                 // Checking authMode fields:
 584                         if (is_array($TCA[$table]['columns']))  {
 585                                 foreach($TCA[$table]['columns'] as $fN => $fV)  {
 586                                         if (isset($idOrRow[$fN]))       {       //
 587                                                 if ($fV['config']['type']=='select' && $fV['config']['authMode'] && !strcmp($fV['config']['authMode_enforce'],'strict')) {
 588                                                         if (!$this->checkAuthMode($table,$fN,$idOrRow[$fN],$fV['config']['authMode']))  {
 589                                                                 $this->errorMsg = 'ERROR: authMode "'.$fV['config']['authMode'].'" failed for field "'.$fN.'" with value "'.$idOrRow[$fN].'" evaluated';
 590                                                                 return FALSE;
 591                                                         }
 592                                                 }
 593                                         }
 594                                 }
 595                         }
 596
 597                                 // Checking "editlock" feature (doesn't apply to new records)
 598                         if (!$newRecord && $TCA[$table]['ctrl']['editlock'])    {
 599                                 if (isset($idOrRow[$TCA[$table]['ctrl']['editlock']]))  {
 600                                         if ($idOrRow[$TCA[$table]['ctrl']['editlock']]) {
 601                                                 $this->errorMsg = 'ERROR: Record was locked for editing. Only admin users can change this state.';
 602                                                 return FALSE;
 603                                         }
 604                                 } else {
 605                                         $this->errorMsg = 'ERROR: The "editLock" field named "'.$TCA[$table]['ctrl']['editlock'].'" was not found in testing record!';
 606                                         return FALSE;
 607                                 }
 608                         }
 609
 610                                 // Checking record permissions
 611                         // THIS is where we can include a check for "perms_" fields for other records than pages...
 612
 613                                 // Process any hooks
 614                         if (is_array($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_userauthgroup.php']['recordEditAccessInternals']))    {
 615                                 foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_userauthgroup.php']['recordEditAccessInternals'] as $funcRef)     {
 616                                         $params = array(
 617                                                 'table' => $table,
 618                                                 'idOrRow' => $idOrRow,
 619                                                 'newRecord' => $newRecord
 620                                         );
 621                                         if (!t3lib_div::callUserFunction($funcRef, $params, $this)) {
 622                                                 return FALSE;
 623                                         }
 624                                 }
 625                         }
 626
 627                                 // Finally, return true if all is well.
 628                         return TRUE;
 629                 }
 630         }
 631
 632         /**
 633          * Will check a type of permission against the compiled permission integer, $lCP, and in relation to table, $table
 634          *
 635          * @param       integer         $lCP could typically be the "compiled permissions" integer returned by ->calcPerms
 636          * @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)
 637          * @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)
 638          * @return      boolean
 639          * @access private
 640          */
 641         function isPSet($lCP,$table,$type='')   {
 642                 if ($this->isAdmin())   return true;
 643                 if ($table=='pages')    {
 644                         if ($type=='edit')      return $lCP & 2;
 645                         if ($type=='new')       return ($lCP & 8) || ($lCP & 16);       // Create new page OR pagecontent
 646                         if ($type=='delete')    return $lCP & 4;
 647                         if ($type=='editcontent')       return $lCP & 16;
 648                 } else {
 649                         return $lCP & 16;
 650                 }
 651         }
 652
 653         /**
 654          * Returns true if the BE_USER is allowed to *create* shortcuts in the backend modules
 655          *
 656          * @return      boolean
 657          */
 658         function mayMakeShortcut()      {
 659                         // If the old BE is used (maybe with some parameters),
 660                         // check for options.enableShortcuts and options.shortcutFrame being set.
 661                 if (substr($this->getTSConfigVal('auth.BE.redirectToURL'), 0, 12) == 'alt_main.php') {
 662                         return $this->getTSConfigVal('options.enableShortcuts') &&
 663                                 $this->getTSConfigVal('options.shortcutFrame') &&
 664                                 !$this->getTSConfigVal('options.mayNotCreateEditShortcuts');
 665                 }
 666                         // If the new BE is used, don't check options.shortcutFrame,
 667                         // because this is not used there anymore.
 668                 else {
 669                         return $this->getTSConfigVal('options.enableShortcuts') &&
 670                                 !$this->getTSConfigVal('options.mayNotCreateEditShortcuts');
 671                 }
 672         }
 673
 674         /**
 675          * Checking if editing of an existing record is allowed in current workspace if that is offline.
 676          * Rules for editing in offline mode:
 677          *              - record supports versioning and is an offline version from workspace and has the corrent stage
 678          *              - 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
 679          *
 680          * @param       string          Table of record
 681          * @param       array           Integer (record uid) or array where fields are at least: pid, t3ver_wsid, t3ver_stage (if versioningWS is set)
 682          * @return      string          String error code, telling the failure state. FALSE=All ok
 683          */
 684         function workspaceCannotEditRecord($table,$recData)     {
 685
 686                 if ($this->workspace!==0)       {       // Only test offline spaces:
 687
 688                         if (!is_array($recData))        {
 689                                 $recData = t3lib_BEfunc::getRecord($table,$recData,'pid'.($GLOBALS['TCA'][$table]['ctrl']['versioningWS']?',t3ver_wsid,t3ver_stage':''));
 690                         }
 691
 692                         if (is_array($recData)) {
 693                                 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.
 694                                         if (!$GLOBALS['TCA'][$table]['ctrl']['versioningWS'])   {       // No versioning, basic error, inconsistency even! Such records should not have a pid of -1!
 695                                                 return 'Versioning disabled for table';
 696                                         } elseif ((int)$recData['t3ver_wsid']!==$this->workspace)       {       // So does workspace match?
 697                                                 return 'Workspace ID of record didn\'t match current workspace';
 698                                         } else {        // So what about the stage of the version, does that allow editing for this user?
 699                                                 return $this->workspaceCheckStageForCurrent($recData['t3ver_stage']) ? FALSE : 'Record stage "'.$recData['t3ver_stage'].'" and users access level did not allow for editing';
 700                                         }
 701                                 } else {        // We are testing a "live" record:
 702                                         if ($res = $this->workspaceAllowLiveRecordsInPID($recData['pid'], $table)) {    // For "Live" records, check that PID for table allows editing
 703                                                         // Live records are OK in this branch, but what about the stage of branch point, if any:
 704                                                 return $res>0 ? FALSE : 'Stage for versioning root point and users access level did not allow for editing';     // OK
 705                                         } else {        // If not offline and not in versionized branch, output error:
 706                                                 return 'Online record was not in versionized branch!';
 707                                         }
 708                                 }
 709                         } else return 'No record';
 710                 } else {
 711                         return FALSE;   // OK because workspace is 0
 712                 }
 713         }
 714
 715         /**
 716          * Evaluates if a user is allowed to edit the offline version
 717          *
 718          * @param       string          Table of record
 719          * @param       array           Integer (record uid) or array where fields are at least: pid, t3ver_wsid, t3ver_stage (if versioningWS is set)
 720          * @return      string          String error code, telling the failure state. FALSE=All ok
 721          * @see workspaceCannotEditRecord()
 722          */
 723         function workspaceCannotEditOfflineVersion($table,$recData)     {
 724                 if ($GLOBALS['TCA'][$table]['ctrl']['versioningWS'])    {
 725
 726                         if (!is_array($recData))        {
 727                                 $recData = t3lib_BEfunc::getRecord($table,$recData,'uid,pid,t3ver_wsid,t3ver_stage');
 728                         }
 729                         if (is_array($recData)) {
 730                                 if ((int)$recData['pid']===-1)  {
 731                                         return $this->workspaceCannotEditRecord($table,$recData);
 732                                 } else return 'Not an offline version';
 733                         } else return 'No record';
 734                 } else return 'Table does not support versioning.';
 735         }
 736
 737         /**
 738          * Check if "live" records from $table may be created or edited in this PID.
 739          * If the answer is FALSE it means the only valid way to create or edit records in the PID is by versioning
 740          * 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!
 741          *
 742          * @param       integer         PID value to check for.
 743          * @param       string          Table name
 744          * @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.
 745          */
 746         function workspaceAllowLiveRecordsInPID($pid, $table)   {
 747
 748                         // Always for Live workspace AND if live-edit is enabled and tables are completely without versioning it is ok as well.
 749                 if ($this->workspace===0 || ($this->workspaceRec['live_edit'] && !$GLOBALS['TCA'][$table]['ctrl']['versioningWS']) || $GLOBALS['TCA'][$table]['ctrl']['versioningWS_alwaysAllowLiveEdit'])      {
 750                         return 2;       // OK to create for this table.
 751                 } 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.
 752                                 // Now, check what the stage of that "page" or "branch" version type is:
 753                         $stage = t3lib_BEfunc::isPidInVersionizedBranch($pid, $table, TRUE);
 754                         return $this->workspaceCheckStageForCurrent($stage) ? 1 : -1;
 755                 } else {
 756                         return FALSE;   // If the answer is FALSE it means the only valid way to create or edit records in the PID is by versioning
 757                 }
 758         }
 759
 760         /**
 761          * Evaluates if a record from $table can be created in $pid
 762          *
 763          * @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!
 764          * @param       string          Table name
 765          * @return      boolean         TRUE if OK.
 766          */
 767         function workspaceCreateNewRecord($pid, $table) {
 768                 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
 769                         if ($res<0)     {
 770                                 return FALSE;   // Stage for versioning root point and users access level did not allow for editing
 771                         }
 772                 } elseif (!$GLOBALS['TCA'][$table]['ctrl']['versioningWS'])     {       // So, if no live records were allowed, we have to create a new version of this record:
 773                         return FALSE;
 774                 }
 775                 return TRUE;
 776         }
 777
 778         /**
 779          * Evaluates if auto creation of a version of a record is allowed.
 780          *
 781          * @param       string          Table of the record
 782          * @param       integer         UID of record
 783          * @param       integer         PID of record
 784          * @return      boolean         TRUE if ok.
 785          */
 786         function workspaceAllowAutoCreation($table,$id,$recpid) {
 787                         // 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.
 788                 if ($this->workspace!==0        // Only in draft workspaces
 789                         && !$this->workspaceRec['disable_autocreate']   // Auto-creation must not be disabled.
 790                         && $GLOBALS['TCA'][$table]['ctrl']['versioningWS']      // Table must be versionizable
 791                         && $recpid >= 0 // The PID of the record must NOT be -1 or less (would indicate that it already was a version!)
 792                         && !t3lib_BEfunc::getWorkspaceVersionOfRecord($this->workspace, $table, $id, 'uid')     // There must be no existing version of this record in workspace.
 793                         && !t3lib_BEfunc::isPidInVersionizedBranch($recpid, $table))    {       // PID must NOT be in a versionized branch either
 794                                 return TRUE;
 795                 }
 796         }
 797
 798         /**
 799          * Checks if an element stage allows access for the user in the current workspace
 800          * In workspaces 0 (Live) and -1 (Default draft) access is always granted for any stage.
 801          * Admins are always allowed.
 802          * An option for custom workspaces allows members to also edit when the stage is "Review"
 803          *
 804          * @param       integer         Stage id from an element: -1,0 = editing, 1 = reviewer, >1 = owner
 805          * @return      boolean         TRUE if user is allowed access
 806          */
 807         function workspaceCheckStageForCurrent($stage)  {
 808                 if ($this->isAdmin())   return TRUE;
 809
 810                 if ($this->workspace>0) {
 811                         $stat = $this->checkWorkspaceCurrent();
 812                         $memberStageLimit = $this->workspaceRec['review_stage_edit'] ? 1 : 0;
 813                         if (($stage<=$memberStageLimit && $stat['_ACCESS']==='member') ||
 814                                 ($stage<=1 && $stat['_ACCESS']==='reviewer') ||
 815                                 ($stat['_ACCESS']==='owner')) {
 816                                         return TRUE;    // OK for these criteria
 817                         }
 818                 } else return TRUE;     // Always OK for live and draft workspaces.
 819         }
 820
 821         /**
 822          * Returns TRUE if the user has access to publish content from the workspace ID given.
 823          * Admin-users are always granted access to do this
 824          * If the workspace ID is 0 (live) all users have access also
 825          * If -1 (draft workspace) TRUE is returned if the user has access to the Live workspace
 826          * For custom workspaces it depends on whether the user is owner OR like with draft workspace if the user has access to Live workspace.
 827          *
 828          * @param       integer         Workspace UID; -1,0,1+
 829          * @return      boolean         Returns TRUE if the user has access to publish content from the workspace ID given.
 830          */
 831         function workspacePublishAccess($wsid)  {
 832                 if ($this->isAdmin())   return TRUE;
 833
 834                         // If no access to workspace, of course you cannot publish!
 835                 $retVal = FALSE;
 836
 837                 $wsAccess = $this->checkWorkspace($wsid);
 838                 if ($wsAccess)  {
 839                         switch($wsAccess['uid'])        {
 840                                 case 0:         // Live workspace
 841                                         $retVal =  TRUE;        // If access to Live workspace, no problem.
 842                                 break;
 843                                 case -1:        // Default draft workspace
 844                                         $retVal =  $this->checkWorkspace(0) ? TRUE : FALSE;     // If access to Live workspace, no problem.
 845                                 break;
 846                                 default:        // Custom workspace
 847                                         $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.
 848                                 break;
 849                         }
 850                 }
 851                 return $retVal;
 852         }
 853
 854         /**
 855          * Workspace swap-mode access?
 856          *
 857          * @return      boolean         Returns TRUE if records can be swapped in the current workspace, otherwise false
 858          */
 859         function workspaceSwapAccess()  {
 860                 if ($this->workspace>0 && (int)$this->workspaceRec['swap_modes']===2)   {
 861                         return FALSE;
 862                 } else return TRUE;
 863         }
 864
 865         /**
 866          * Workspace Versioning type access?
 867          *
 868          * @param       integer         Versioning type to evaluation: -1, 0, >1
 869          * @return      boolean         TRUE if OK
 870          */
 871         function workspaceVersioningTypeAccess($type)   {
 872                 $retVal = FALSE;
 873
 874                 $type = t3lib_div::intInRange($type,-1);
 875
 876                         // Check if only element versioning is allowed:
 877                 if ($GLOBALS['TYPO3_CONF_VARS']['BE']['elementVersioningOnly'] && $type!=-1)    {
 878                         return FALSE;
 879                 }
 880
 881                 if ($this->workspace>0 && !$this->isAdmin())    {
 882                         $stat = $this->checkWorkspaceCurrent();
 883                         if ($stat['_ACCESS']!=='owner') {
 884
 885                                 switch((int)$type)      {
 886                                         case -1:
 887                                                 $retVal = $this->workspaceRec['vtypes']&1 ? FALSE : TRUE;
 888                                         break;
 889                                         case 0:
 890                                                 $retVal = $this->workspaceRec['vtypes']&2 ? FALSE : TRUE;
 891                                         break;
 892                                         default:
 893                                                 $retVal = $this->workspaceRec['vtypes']&4 ? FALSE : TRUE;
 894                                         break;
 895                                 }
 896                         } else $retVal = TRUE;
 897                 } else $retVal = TRUE;
 898
 899                 return $retVal;
 900         }
 901
 902         /**
 903          * Finding "closest" versioning type, used for creation of new records.
 904          *
 905          * @param       integer         Versioning type to evaluation: -1, 0, >1
 906          * @return      integer         Returning versioning type
 907          */
 908         function workspaceVersioningTypeGetClosest($type)       {
 909                 $type = t3lib_div::intInRange($type,-1);
 910
 911                 if ($this->workspace>0) {
 912                         switch((int)$type)      {
 913                                 case -1:
 914                                         $type = -1;
 915                                 break;
 916                                 case 0:
 917                                         $type = $this->workspaceVersioningTypeAccess($type) ? $type : -1;
 918                                 break;
 919                                 default:
 920                                         $type = $this->workspaceVersioningTypeAccess($type) ? $type : ($this->workspaceVersioningTypeAccess(0) ? 0 : -1);
 921                                 break;
 922                         }
 923                 }
 924                 return $type;
 925         }
 926
 927
 928
 929
 930
 931
 932
 933
 934
 935
 936         /*************************************
 937          *
 938          * Miscellaneous functions
 939          *
 940          *************************************/
 941
 942         /**
 943          * Returns the value/properties of a TS-object as given by $objectString, eg. 'options.dontMountAdminMounts'
 944          * Nice (general!) function for returning a part of a TypoScript array!
 945          *
 946          * @param       string          Pointer to an "object" in the TypoScript array, fx. 'options.dontMountAdminMounts'
 947          * @param       array           Optional TSconfig array: If array, then this is used and not $this->userTS. If not array, $this->userTS is used.
 948          * @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.
 949          * @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.
 950          */
 951         function getTSConfig($objectString,$config='')  {
 952                 if (!is_array($config)) {
 953                         $config=$this->userTS;  // Getting Root-ts if not sent
 954                 }
 955                 $TSConf=array();
 956                 $parts = explode('.',$objectString,2);
 957                 $key = $parts[0];
 958                 if (trim($key)) {
 959                         if (count($parts)>1 && trim($parts[1])) {
 960                                 // Go on, get the next level
 961                                 if (is_array($config[$key.'.']))        $TSConf = $this->getTSConfig($parts[1],$config[$key.'.']);
 962                         } else {
 963                                 $TSConf['value']=$config[$key];
 964                                 $TSConf['properties']=$config[$key.'.'];
 965                         }
 966                 }
 967                 return $TSConf;
 968         }
 969
 970         /**
 971          * Returns the "value" of the $objectString from the BE_USERS "User TSconfig" array
 972          *
 973          * @param       string          Object string, eg. "somestring.someproperty.somesubproperty"
 974          * @return      string          The value for that object string (object path)
 975          * @see getTSConfig()
 976          */
 977         function getTSConfigVal($objectString)  {
 978                 $TSConf = $this->getTSConfig($objectString);
 979                 return $TSConf['value'];
 980         }
 981
 982         /**
 983          * Returns the "properties" of the $objectString from the BE_USERS "User TSconfig" array
 984          *
 985          * @param       string          Object string, eg. "somestring.someproperty.somesubproperty"
 986          * @return      array           The properties for that object string (object path) - if any
 987          * @see getTSConfig()
 988          */
 989         function getTSConfigProp($objectString) {
 990                 $TSConf = $this->getTSConfig($objectString);
 991                 return $TSConf['properties'];
 992         }
 993
 994         /**
 995          * Returns true if $item is in $in_list
 996          *
 997          * @param       string          Comma list with items, no spaces between items!
 998          * @param       string          The string to find in the list of items
 999          * @return      string          Boolean
1000          */
1001         function inList($in_list,$item) {
1002                 return strstr(','.$in_list.',', ','.$item.',');
1003         }
1004
1005         /**
1006          * Returns an array with the webmounts.
1007          * If no webmounts, and empty array is returned.
1008          * 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.
1009          *
1010          * @return      array
1011          */
1012         function returnWebmounts()      {
1013                 return (string)($this->groupData['webmounts'])!='' ? explode(',',$this->groupData['webmounts']) : Array();
1014         }
1015
1016         /**
1017          * Returns an array with the filemounts for the user. Each filemount is represented with an array of a "name", "path" and "type".
1018          * If no filemounts an empty array is returned.
1019          *
1020          * @return      array
1021          */
1022         function returnFilemounts()     {
1023                 return $this->groupData['filemounts'];
1024         }
1025
1026         /**
1027          * Returns an integer bitmask that represents the permissions for file operations.
1028          * Permissions of the user and groups the user is a member of were combined by a logical OR.
1029          *
1030          * Meaning of each bit:
1031          *      1 - Files: Upload,Copy,Move,Delete,Rename
1032          *      2 - Files: Unzip
1033          *      4 - Directory: Move,Delete,Rename,New
1034          *      8 - Directory: Copy
1035          *      16 - Directory: Delete recursively (rm -Rf)
1036          *
1037          * @return      integer         File operation permission bitmask
1038          */
1039         public function getFileoperationPermissions() {
1040                 if ($this->isAdmin()) {
1041                         return 31;
1042                 } else {
1043                         return $this->groupData['fileoper_perms'];
1044                 }
1045         }
1046
1047         /**
1048          * Returns true or false, depending if an alert popup (a javascript confirmation) should be shown
1049          * call like $GLOBALS['BE_USER']->jsConfirmation($BITMASK)
1050          *
1051          *    1 - typeChange
1052          *    2 - copy/move/paste
1053          *    4 - delete
1054          *    8 - frontend editing
1055          *    128 - other (not used yet)
1056          *
1057          * @param       integer   Bitmask
1058          * @return      boolean         true if the confirmation should be shown
1059          */
1060          function jsConfirmation($bitmask)      {
1061                  $alertPopup = $GLOBALS['BE_USER']->getTSConfig('options.alertPopups');
1062                  if (empty($alertPopup['value']))       {
1063                          $alertPopup = 255;     // default: show all warnings
1064                  } else {
1065                          $alertPopup = (int)$alertPopup['value'];
1066                  }
1067                  if(($alertPopup&$bitmask) == $bitmask) { // show confirmation
1068                          return 1;
1069                  } else { // don't show confirmation
1070                          return 0;
1071                  }
1072          }
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082         /*************************************
1083          *
1084          * Authentication methods
1085          *
1086          *************************************/
1087
1088
1089         /**
1090          * Initializes a lot of stuff like the access-lists, database-mountpoints and filemountpoints
1091          * This method is called by ->backendCheckLogin() (from extending class t3lib_beuserauth) if the backend user login has verified OK.
1092          * Generally this is required initialization of a backend user.
1093          *
1094          * @return      void
1095          * @access private
1096          * @see t3lib_TSparser
1097          */
1098         function fetchGroupData()       {
1099                 if ($this->user['uid']) {
1100
1101                                 // Get lists for the be_user record and set them as default/primary values.
1102                         $this->dataLists['modList'] = $this->user['userMods'];                                  // Enabled Backend Modules
1103                         $this->dataLists['allowed_languages'] = $this->user['allowed_languages'];                                       // Add Allowed Languages
1104                         $this->dataLists['workspace_perms'] = $this->user['workspace_perms'];                                   // Set user value for workspace permissions.
1105                         $this->dataLists['webmount_list'] = $this->user['db_mountpoints'];              // Database mountpoints
1106                         $this->dataLists['filemount_list'] = $this->user['file_mountpoints'];   // File mountpoints
1107                         $this->dataLists['fileoper_perms'] = (int)$this->user['fileoper_perms'];        // Fileoperation permissions
1108
1109                                 // Setting default User TSconfig:
1110                         $this->TSdataArray[]=$this->addTScomment('From $GLOBALS["TYPO3_CONF_VARS"]["BE"]["defaultUserTSconfig"]:').
1111                                                                         $GLOBALS['TYPO3_CONF_VARS']['BE']['defaultUserTSconfig'];
1112
1113                                 // Default TSconfig for admin-users
1114                         if ($this->isAdmin())   {
1115                                 $this->TSdataArray[]=$this->addTScomment('"admin" user presets:').'
1116                                         admPanel.enable.all = 1
1117                                         options.shortcutFrame = 1
1118                                 ';
1119                                 if (t3lib_extMgm::isLoaded('sys_note')) {
1120                                         $this->TSdataArray[]='
1121                                                 // Setting defaults for sys_note author / email...
1122                                                 TCAdefaults.sys_note.author = '.$this->user['realName'].'
1123                                                 TCAdefaults.sys_note.email = '.$this->user['email'].'
1124                                         ';
1125                                 }
1126                         }
1127
1128                                 // FILE MOUNTS:
1129                                 // Admin users has the base fileadmin dir mounted
1130                         if ($this->isAdmin() && $GLOBALS['TYPO3_CONF_VARS']['BE']['fileadminDir'])      {
1131                                 $this->addFileMount($GLOBALS['TYPO3_CONF_VARS']['BE']['fileadminDir'], '', PATH_site.$GLOBALS['TYPO3_CONF_VARS']['BE']['fileadminDir'], 0, '');
1132                         }
1133
1134                                 // If userHomePath is set, we attempt to mount it
1135                         if ($GLOBALS['TYPO3_CONF_VARS']['BE']['userHomePath'])  {
1136                                         // First try and mount with [uid]_[username]
1137                                 $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');
1138                                 if (!$didMount) {
1139                                                 // If that failed, try and mount with only [uid]
1140                                         $this->addFileMount($this->user['username'], '', $GLOBALS['TYPO3_CONF_VARS']['BE']['userHomePath'].$this->user['uid'].$GLOBALS['TYPO3_CONF_VARS']['BE']['userUploadDir'], 0, 'user');
1141                                 }
1142                         }
1143
1144                                 // BE_GROUPS:
1145                                 // Get the groups...
1146 #                       $grList = t3lib_BEfunc::getSQLselectableList($this->user[$this->usergroup_column],$this->usergroup_table,$this->usergroup_table);
1147                         $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.
1148                         if ($grList)    {
1149                                         // Fetch groups will add a lot of information to the internal arrays: modules, accesslists, TSconfig etc. Refer to fetchGroups() function.
1150                                 $this->fetchGroups($grList);
1151                         }
1152
1153                                 // Add the TSconfig for this specific user:
1154                         $this->TSdataArray[] = $this->addTScomment('USER TSconfig field').$this->user['TSconfig'];
1155                                 // Check include lines.
1156                         $this->TSdataArray = t3lib_TSparser::checkIncludeLines_array($this->TSdataArray);
1157
1158                                 // Parsing the user TSconfig (or getting from cache)
1159                         $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.
1160                         $hash = md5('userTS:'.$this->userTS_text);
1161                         $cachedContent = t3lib_BEfunc::getHash($hash);
1162                         if (isset($cachedContent) && !$this->userTS_dontGetCached)      {
1163                                 $this->userTS = unserialize($cachedContent);
1164                         } else {
1165                                 $parseObj = t3lib_div::makeInstance('t3lib_TSparser');
1166                                 $parseObj->parse($this->userTS_text);
1167                                 $this->userTS = $parseObj->setup;
1168                                 t3lib_BEfunc::storeHash($hash,serialize($this->userTS),'BE_USER_TSconfig');
1169                                         // Update UC:
1170                                 $this->userTSUpdated=1;
1171                         }
1172
1173                                 // Processing webmounts
1174                         if ($this->isAdmin() && !$this->getTSConfigVal('options.dontMountAdminMounts')) {       // Admin's always have the root mounted
1175                                 $this->dataLists['webmount_list']='0,'.$this->dataLists['webmount_list'];
1176                         }
1177
1178                                 // Processing filemounts
1179                         $this->dataLists['filemount_list'] = t3lib_div::uniqueList($this->dataLists['filemount_list']);
1180                         if ($this->dataLists['filemount_list']) {
1181                                 $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery('*', 'sys_filemounts', 'deleted=0 AND hidden=0 AND pid=0 AND uid IN ('.$this->dataLists['filemount_list'].')');
1182                                 while ($row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res))      {
1183                                         $this->addFileMount($row['title'], $row['path'], $row['path'], $row['base']?1:0, '');
1184                                 }
1185                         }
1186
1187                                 // The lists are cleaned for duplicates
1188                         $this->groupData['webmounts'] = t3lib_div::uniqueList($this->dataLists['webmount_list']);
1189                         $this->groupData['pagetypes_select'] = t3lib_div::uniqueList($this->dataLists['pagetypes_select']);
1190                         $this->groupData['tables_select'] = t3lib_div::uniqueList($this->dataLists['tables_modify'].','.$this->dataLists['tables_select']);
1191                         $this->groupData['tables_modify'] = t3lib_div::uniqueList($this->dataLists['tables_modify']);
1192                         $this->groupData['non_exclude_fields'] = t3lib_div::uniqueList($this->dataLists['non_exclude_fields']);
1193                         $this->groupData['explicit_allowdeny'] = t3lib_div::uniqueList($this->dataLists['explicit_allowdeny']);
1194                         $this->groupData['allowed_languages'] = t3lib_div::uniqueList($this->dataLists['allowed_languages']);
1195                         $this->groupData['custom_options'] = t3lib_div::uniqueList($this->dataLists['custom_options']);
1196                         $this->groupData['modules'] = t3lib_div::uniqueList($this->dataLists['modList']);
1197                         $this->groupData['fileoper_perms'] = $this->dataLists['fileoper_perms'];
1198                         $this->groupData['workspace_perms'] = $this->dataLists['workspace_perms'];
1199
1200                                 // populating the $this->userGroupsUID -array with the groups in the order in which they were LAST included.!!
1201                         $this->userGroupsUID = array_reverse(array_unique(array_reverse($this->includeGroupArray)));
1202
1203                                 // 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)
1204                         $this->groupList = implode(',',$this->userGroupsUID);
1205                         $this->setCachedList($this->groupList);
1206
1207                                 // Checking read access to webmounts:
1208                         if (trim($this->groupData['webmounts'])!=='')   {
1209                                 $webmounts = explode(',',$this->groupData['webmounts']);        // Explode mounts
1210                                 $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
1211                                 foreach($webmounts as $idx => $mountPointUid)   {
1212                                         if ($mountPointUid>0 && !isset($MProws[$mountPointUid]))        {       // If the mount ID is NOT found among selected pages, unset it:
1213                                                 unset($webmounts[$idx]);
1214                                         }
1215                                 }
1216                                 $this->groupData['webmounts'] = implode(',',$webmounts);        // Implode mounts in the end.
1217                         }
1218
1219                                 // Setting up workspace situation (after webmounts are processed!):
1220                         $this->workspaceInit();
1221                 }
1222         }
1223
1224         /**
1225          * Fetches the group records, subgroups and fills internal arrays.
1226          * Function is called recursively to fetch subgroups
1227          *
1228          * @param       string          Commalist of be_groups uid numbers
1229          * @param       string          List of already processed be_groups-uids so the function will not fall into a eternal recursion.
1230          * @return      void
1231          * @access private
1232          */
1233         function fetchGroups($grList,$idList='')        {
1234                 global $TYPO3_CONF_VARS;
1235
1236                         // Fetching records of the groups in $grList (which are not blocked by lockedToDomain either):
1237                 $lockToDomain_SQL = ' AND (lockToDomain=\'\' OR lockToDomain IS NULL OR lockToDomain=\''.t3lib_div::getIndpEnv('HTTP_HOST').'\')';
1238                 $whereSQL = 'deleted=0 AND hidden=0 AND pid=0 AND uid IN ('.$grList.')'.$lockToDomain_SQL;
1239
1240                         // Hook for manipulation of the WHERE sql sentence which controls which BE-groups are included
1241                 if (is_array ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_userauthgroup.php']['fetchGroupQuery'])) {
1242                         foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_userauthgroup.php']['fetchGroupQuery'] as $classRef) {
1243                         $hookObj = &t3lib_div::getUserObj($classRef);
1244                         if(method_exists($hookObj,'fetchGroupQuery_processQuery')){
1245                                 $whereSQL = $hookObj->fetchGroupQuery_processQuery($this, $grList, $idList, $whereSQL);
1246                         }
1247                         }
1248                 }
1249
1250                 $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery('*', $this->usergroup_table, $whereSQL);
1251
1252                         // The userGroups array is filled
1253                 while ($row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res))      {
1254                         $this->userGroups[$row['uid']] = $row;
1255                 }
1256
1257                         // Traversing records in the correct order
1258                 $include_staticArr = t3lib_div::intExplode(',',$grList);
1259                 reset($include_staticArr);
1260                 while(list(,$uid)=each($include_staticArr))     {       // traversing list
1261
1262                                 // Get row:
1263                         $row=$this->userGroups[$uid];
1264                         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
1265
1266                                         // Include sub groups
1267                                 if (trim($row['subgroup']))     {
1268                                         $theList = implode(',',t3lib_div::intExplode(',',$row['subgroup']));    // Make integer list
1269                                         $this->fetchGroups($theList, $idList.','.$uid);         // Call recursively, pass along list of already processed groups so they are not recursed again.
1270                                 }
1271                                         // Add the group uid, current list, TSconfig to the internal arrays.
1272                                 $this->includeGroupArray[]=$uid;
1273                                 $this->includeHierarchy[]=$idList;
1274                                 $this->TSdataArray[] = $this->addTScomment('Group "'.$row['title'].'" ['.$row['uid'].'] TSconfig field:').$row['TSconfig'];
1275
1276                                         // Mount group database-mounts
1277                                 if (($this->user['options']&1) == 1)    {       $this->dataLists['webmount_list'].= ','.$row['db_mountpoints']; }
1278
1279                                         // Mount group file-mounts
1280                                 if (($this->user['options']&2) == 2)    {       $this->dataLists['filemount_list'].= ','.$row['file_mountpoints'];      }
1281
1282                                         // Mount group home-dirs
1283                                 if (($this->user['options']&2) == 2)    {
1284                                                 // If groupHomePath is set, we attempt to mount it
1285                                         if ($GLOBALS['TYPO3_CONF_VARS']['BE']['groupHomePath']) {
1286                                                 $this->addFileMount($row['title'], '', $GLOBALS['TYPO3_CONF_VARS']['BE']['groupHomePath'].$row['uid'], 0, 'group');
1287                                         }
1288                                 }
1289
1290                                         // The lists are made: groupMods, tables_select, tables_modify, pagetypes_select, non_exclude_fields, explicit_allowdeny, allowed_languages, custom_options
1291                                 if ($row['inc_access_lists']==1)        {
1292                                         $this->dataLists['modList'].= ','.$row['groupMods'];
1293                                         $this->dataLists['tables_select'].= ','.$row['tables_select'];
1294                                         $this->dataLists['tables_modify'].= ','.$row['tables_modify'];
1295                                         $this->dataLists['pagetypes_select'].= ','.$row['pagetypes_select'];
1296                                         $this->dataLists['non_exclude_fields'].= ','.$row['non_exclude_fields'];
1297                                         $this->dataLists['explicit_allowdeny'].= ','.$row['explicit_allowdeny'];
1298                                         $this->dataLists['allowed_languages'].= ','.$row['allowed_languages'];
1299                                         $this->dataLists['custom_options'].= ','.$row['custom_options'];
1300                                 }
1301
1302                                 // Setting fileoperation permissions
1303                                 $this->dataLists['fileoper_perms'] |= (int)$row['fileoper_perms'];
1304
1305                                         // Setting workspace permissions:
1306                                 $this->dataLists['workspace_perms'] |= $row['workspace_perms'];
1307
1308                                         // 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.
1309                                 if (!strcmp($idList,'') && !$this->firstMainGroup)      {
1310                                         $this->firstMainGroup=$uid;
1311                                 }
1312                         }
1313                 }
1314
1315                 // ****************
1316                 // HOOK: fetchGroups_postProcessing
1317                 // ****************
1318                 if (is_array($TYPO3_CONF_VARS['SC_OPTIONS']['t3lib/class.t3lib_userauthgroup.php']['fetchGroups_postProcessing'])) {
1319                         foreach($TYPO3_CONF_VARS['SC_OPTIONS']['t3lib/class.t3lib_userauthgroup.php']['fetchGroups_postProcessing'] as $_funcRef) {
1320                                 $_params = array();
1321                                 t3lib_div::callUserFunction($_funcRef, $_params, $this);
1322                         }
1323                 }
1324         }
1325
1326         /**
1327          * Updates the field be_users.usergroup_cached_list if the groupList of the user has changed/is different from the current list.
1328          * 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.
1329          *
1330          * @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.
1331          * @return      void
1332          * @access private
1333          */
1334         function setCachedList($cList)  {
1335                 if ((string)$cList != (string)$this->user['usergroup_cached_list'])     {
1336                         $GLOBALS['TYPO3_DB']->exec_UPDATEquery('be_users', 'uid='.intval($this->user['uid']), array('usergroup_cached_list' => $cList));
1337                 }
1338         }
1339
1340         /**
1341          * Adds a filemount to the users array of filemounts, $this->groupData['filemounts'][hash_key] = Array ('name'=>$name, 'path'=>$path, 'type'=>$type);
1342          * Is a part of the authentication proces of the user.
1343          * 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!
1344          * Paths in the mounted information will always be absolute and have a trailing slash.
1345          *
1346          * @param       string          $title will be the (root)name of the filemount in the folder tree
1347          * @param       string          $altTitle will be the (root)name of the filemount IF $title is not true (blank or zero)
1348          * @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.
1349          * @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.
1350          * @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.
1351          * @return      boolean         Returns "1" if the requested filemount was mounted, otherwise no return value.
1352          * @access private
1353          */
1354         function addFileMount($title, $altTitle, $path, $webspace, $type)       {
1355                         // Return false if fileadminDir is not set and we try to mount a relative path
1356                 if ($webspace && !$GLOBALS['TYPO3_CONF_VARS']['BE']['fileadminDir'])    return false;
1357
1358                         // Trimming and pre-processing
1359                 $path=trim($path);
1360                 if ($this->OS=='WIN')   {               // with WINDOWS convert backslash to slash!!
1361                         $path=str_replace('\\','/',$path);
1362                 }
1363                         // If the path is true and validates as a valid path string:
1364                 if ($path && t3lib_div::validPathStr($path))    {
1365                                 // normalize path: remove leading '/' and './', and trailing '/' and '/.'
1366                         $path=trim($path);
1367                         $path=preg_replace('#^\.?/|/\.?$#','',$path);
1368
1369                         if ($path)      {       // there must be some chars in the path
1370                                 $fdir=PATH_site.$GLOBALS['TYPO3_CONF_VARS']['BE']['fileadminDir'];      // fileadmin dir, absolute
1371                                 if ($webspace)  {
1372                                         $path=$fdir.$path;      // PATH_site + fileadmin dir is prepended
1373                                 } else {
1374                                         if ($this->OS!='WIN')   {               // with WINDOWS no prepending!!
1375                                                 $path='/'.$path;        // root-level is the start...
1376                                         }
1377                                 }
1378                                 $path.='/';
1379
1380                                         // We now have a path with slash after and slash before (if unix)
1381                                 if (@is_dir($path) &&
1382                                         (($GLOBALS['TYPO3_CONF_VARS']['BE']['lockRootPath'] && t3lib_div::isFirstPartOfStr($path,$GLOBALS['TYPO3_CONF_VARS']['BE']['lockRootPath'])) || t3lib_div::isFirstPartOfStr($path,$fdir)))      {
1383                                                         // Alternative title?
1384                                                 $name = $title ? $title : $altTitle;
1385                                                         // 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.
1386                                                 $this->groupData['filemounts'][md5($name.'|'.$path.'|'.$type)] = Array('name'=>$name, 'path'=>$path, 'type'=>$type);
1387                                                         // Return true - went well, success!
1388                                                 return 1;
1389                                 }
1390                         }
1391                 }
1392         }
1393
1394         /**
1395          * Creates a TypoScript comment with the string text inside.
1396          *
1397          * @param       string          The text to wrap in comment prefixes and delimiters.
1398          * @return      string          TypoScript comment with the string text inside.
1399          */
1400         function addTScomment($str)     {
1401                 $delimiter = '# ***********************************************';
1402
1403                 $out = $delimiter.chr(10);
1404                 $lines = t3lib_div::trimExplode(chr(10),$str);
1405                 foreach($lines as $v)   {
1406                         $out.= '# '.$v.chr(10);
1407                 }
1408                 $out.= $delimiter.chr(10);
1409                 return $out;
1410         }
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423         /************************************
1424          *
1425          * Workspaces
1426          *
1427          ************************************/
1428
1429         /**
1430          * Initializing workspace.
1431          * Called from within this function, see fetchGroupData()
1432          *
1433          * @return      void
1434          * @see fetchGroupData()
1435          */
1436         function workspaceInit()        {
1437
1438                         // Initializing workspace by evaluating and setting the workspace, possibly updating it in the user record!
1439                 $this->setWorkspace($this->user['workspace_id']);
1440
1441                         // Setting up the db mount points of the (custom) workspace, if any:
1442                 if ($this->workspace>0 && trim($this->workspaceRec['db_mountpoints'])!=='')     {
1443
1444                                 // Initialize:
1445                         $newMounts = array();
1446                         $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.
1447
1448                                 // Traverse mount points of the
1449                         $mountPoints = t3lib_div::intExplode(',',$this->workspaceRec['db_mountpoints']);
1450                         foreach($mountPoints as $mpId)  {
1451                                 if ($this->isInWebMount($mpId,$readPerms))      {
1452                                         $newMounts[] = $mpId;
1453                                 }
1454                         }
1455
1456                                 // Re-insert webmounts:
1457                         $this->groupData['webmounts'] = implode(',',array_unique($newMounts));
1458                 }
1459
1460                         // Setting up the file mount points of the (custom) workspace, if any:
1461                 if ($this->workspace!==0)       $this->groupData['filemounts'] = array();
1462                 if ($this->workspace>0 && trim($this->workspaceRec['file_mountpoints'])!=='')   {
1463
1464                                 // Processing filemounts
1465                         $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']).')');
1466                         while ($row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res))      {
1467                                 $this->addFileMount($row['title'], $row['path'], $row['path'], $row['base']?1:0, '');
1468                         }
1469                 }
1470         }
1471
1472         /**
1473          * Checking if a workspace is allowed for backend user
1474          *
1475          * @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)
1476          * @param       string          List of fields to select. Default fields are: uid,title,adminusers,members,reviewers,publish_access,stagechg_notification
1477          * @return      array           TRUE if access. Output will also show how access was granted. Admin users will have a true output regardless of input.
1478          */
1479         function checkWorkspace($wsRec,$fields='uid,title,adminusers,members,reviewers,publish_access,stagechg_notification')   {
1480                 $retVal = FALSE;
1481
1482                         // If not array, look up workspace record:
1483                 if (!is_array($wsRec))  {
1484                         switch((string)$wsRec)  {
1485                                 case '0':
1486                                 case '-1':
1487                                         $wsRec = array('uid' => $wsRec);
1488                                 break;
1489                                 default:
1490                                         list($wsRec) = $GLOBALS['TYPO3_DB']->exec_SELECTgetRows(
1491                                                 $fields,
1492                                                 'sys_workspace',
1493                                                 'pid=0 AND uid='.intval($wsRec).
1494                                                         t3lib_BEfunc::deleteClause('sys_workspace'),
1495                                                 '',
1496                                                 'title'
1497                                         );
1498                                 break;
1499                         }
1500                 }
1501
1502                         // If wsRec is set to an array, evaluate it:
1503                 if (is_array($wsRec))   {
1504                         if ($this->isAdmin())   {
1505                                 return array_merge($wsRec,array('_ACCESS' => 'admin'));
1506                         } else {
1507
1508                                 switch((string)$wsRec['uid'])   {
1509                                         case '0':
1510                                                 $retVal = ($this->groupData['workspace_perms']&1) ? array_merge($wsRec,array('_ACCESS' => 'online')) : FALSE;
1511                                         break;
1512                                         case '-1':
1513                                                 $retVal = ($this->groupData['workspace_perms']&2) ? array_merge($wsRec,array('_ACCESS' => 'offline')) : FALSE;
1514                                         break;
1515                                         default:
1516                                                         // Checking if the guy is admin:
1517                                                 if (t3lib_div::inList($wsRec['adminusers'],$this->user['uid'])) {
1518                                                         return array_merge($wsRec, array('_ACCESS' => 'owner'));
1519                                                 }
1520                                                         // Checking if he is reviewer user:
1521                                                 if (t3lib_div::inList($wsRec['reviewers'],'be_users_'.$this->user['uid']))      {
1522                                                         return array_merge($wsRec, array('_ACCESS' => 'reviewer'));
1523                                                 }
1524                                                         // Checking if he is reviewer through a user group of his:
1525                                                 foreach($this->userGroupsUID as $groupUid)      {
1526                                                         if (t3lib_div::inList($wsRec['reviewers'],'be_groups_'.$groupUid))      {
1527                                                                 return array_merge($wsRec, array('_ACCESS' => 'reviewer'));
1528                                                         }
1529                                                 }
1530                                                         // Checking if he is member as user:
1531                                                 if (t3lib_div::inList($wsRec['members'],'be_users_'.$this->user['uid']))        {
1532                                                         return array_merge($wsRec, array('_ACCESS' => 'member'));
1533                                                 }
1534                                                         // Checking if he is member through a user group of his:
1535                                                 foreach($this->userGroupsUID as $groupUid)      {
1536                                                         if (t3lib_div::inList($wsRec['members'],'be_groups_'.$groupUid))        {
1537                                                                 return array_merge($wsRec, array('_ACCESS' => 'member'));
1538                                                         }
1539                                                 }
1540                                         break;
1541                                 }
1542                         }
1543                 }
1544
1545                 return $retVal;
1546         }
1547
1548         /**
1549          * 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.
1550          *
1551          * @return      array           See checkWorkspace()
1552          * @see checkWorkspace()
1553          */
1554         function checkWorkspaceCurrent()        {
1555                 if (!isset($this->checkWorkspaceCurrent_cache)) {
1556                         $this->checkWorkspaceCurrent_cache = $this->checkWorkspace($this->workspace);
1557                 }
1558                 return $this->checkWorkspaceCurrent_cache;
1559         }
1560
1561         /**
1562          * Setting workspace ID
1563          *
1564          * @param       integer         ID of workspace to set for backend user. If not valid the default workspace for BE user is found and set.
1565          * @return      void
1566          */
1567         function setWorkspace($workspaceId)     {
1568
1569                         // Check workspace validity and if not found, revert to default workspace.
1570                 if ($this->workspaceRec = $this->checkWorkspace($workspaceId,'*'))      {
1571                                 // Set workspace ID internally
1572                         $this->workspace = (int)$workspaceId;
1573                 } else {
1574                         $this->workspace = (int)$this->getDefaultWorkspace();
1575                         $this->workspaceRec = $this->checkWorkspace($this->workspace,'*');
1576                 }
1577
1578                         // Unset access cache:
1579                 unset($this->checkWorkspaceCurrent_cache);
1580
1581                         // If ID is different from the stored one, change it:
1582                 if (strcmp($this->workspace, $this->user['workspace_id']))      {
1583                         $this->user['workspace_id'] = $this->workspace;
1584                         $GLOBALS['TYPO3_DB']->exec_UPDATEquery('be_users','uid='.intval($this->user['uid']),array('workspace_id' => $this->user['workspace_id']));
1585                         $this->simplelog('User changed workspace to "'.$this->workspace.'"');
1586                 }
1587         }
1588
1589         /**
1590          * Setting workspace preview state for user:
1591          *
1592          * @param       boolean         State of user preview.
1593          * @return      void
1594          */
1595         function setWorkspacePreview($previewState)     {
1596                 $this->user['workspace_preview'] = $previewState;
1597                 $GLOBALS['TYPO3_DB']->exec_UPDATEquery('be_users','uid='.intval($this->user['uid']),array('workspace_preview' => $this->user['workspace_preview']));
1598         }
1599
1600         /**
1601          * Return default workspace ID for user
1602          *
1603          * @return      integer         Default workspace id. If no workspace is available it will be "-99"
1604          */
1605         function getDefaultWorkspace()  {
1606
1607                 if ($this->checkWorkspace(0))   {       // Check online
1608                         return 0;
1609                 } elseif ($this->checkWorkspace(-1))    {       // Check offline
1610                         return -1;
1611                 } else {        // Traverse custom workspaces:
1612                         $workspaces = $GLOBALS['TYPO3_DB']->exec_SELECTgetRows('uid,title,adminusers,members,reviewers','sys_workspace','pid=0'.t3lib_BEfunc::deleteClause('sys_workspace'),'','title');
1613                         foreach($workspaces as $rec)    {
1614                                 if ($this->checkWorkspace($rec))        {
1615                                         return $rec['uid'];
1616                                 }
1617                         }
1618                 }
1619                 return -99;
1620         }
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632         /************************************
1633          *
1634          * Logging
1635          *
1636          ************************************/
1637
1638         /**
1639          * Writes an entry in the logfile/table
1640          * Documentation in "TYPO3 Core API"
1641          *
1642          * @param       integer         Denotes which module that has submitted the entry. See "TYPO3 Core API". Use "4" for extensions.
1643          * @param       integer         Denotes which specific operation that wrote the entry. Use "0" when no sub-categorizing applies
1644          * @param       integer         Flag. 0 = message, 1 = error (user problem), 2 = System Error (which should not happen), 3 = security notice (admin)
1645          * @param       integer         The message number. Specific for each $type and $action. This will make it possible to translate errormessages to other languages
1646          * @param       string          Default text that follows the message (in english!). Possibly translated by identification through type/action/details_nr
1647          * @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
1648          * @param       string          Table name. Special field used by tce_main.php.
1649          * @param       integer         Record UID. Special field used by tce_main.php.
1650          * @param       integer         Record PID. Special field used by tce_main.php. OBSOLETE
1651          * @param       integer         The page_uid (pid) where the event occurred. Used to select log-content for specific pages.
1652          * @param       string          Special field used by tce_main.php. NEWid string of newly created records.
1653          * @param       integer         Alternative Backend User ID (used for logging login actions where this is not yet known).
1654          * @return      integer         Log entry ID.
1655          */
1656         function writelog($type,$action,$error,$details_nr,$details,$data,$tablename='',$recuid='',$recpid='',$event_pid=-1,$NEWid='',$userId=0) {
1657
1658                 $fields_values = Array (
1659                         'userid' => $userId ? $userId : intval($this->user['uid']),
1660                         'type' => intval($type),
1661                         'action' => intval($action),
1662                         'error' => intval($error),
1663                         'details_nr' => intval($details_nr),
1664                         'details' => $details,
1665                         'log_data' => serialize($data),
1666                         'tablename' => $tablename,
1667                         'recuid' => intval($recuid),
1668 #                       'recpid' => intval($recpid),
1669                         'IP' => t3lib_div::getIndpEnv('REMOTE_ADDR'),
1670                         'tstamp' => $GLOBALS['EXEC_TIME'],
1671                         'event_pid' => intval($event_pid),
1672                         'NEWid' => $NEWid,
1673                         'workspace' => $this->workspace
1674                 );
1675
1676                 $GLOBALS['TYPO3_DB']->exec_INSERTquery('sys_log', $fields_values);
1677                 return $GLOBALS['TYPO3_DB']->sql_insert_id();
1678         }
1679
1680         /**
1681          * Simple logging function
1682          *
1683          * @param       string          Log message
1684          * @param       string          Option extension key / module name
1685          * @param       integer         Error level. 0 = message, 1 = error (user problem), 2 = System Error (which should not happen), 3 = security notice (admin)
1686          * @return      integer         Log entry UID
1687          */
1688         function simplelog($message, $extKey='', $error=0)      {
1689                 return $this->writelog(
1690                         4,
1691                         0,
1692                         $error,
1693                         0,
1694                         ($extKey?'['.$extKey.'] ':'').$message,
1695                         array()
1696                 );
1697         }
1698
1699         /**
1700          * Sends a warning to $email if there has been a certain amount of failed logins during a period.
1701          * 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.
1702          *
1703          * @param       string          Email address
1704          * @param       integer         Number of sections back in time to check. This is a kind of limit for how many failures an hour for instance.
1705          * @param       integer         Max allowed failures before a warning mail is sent
1706          * @return      void
1707          * @access private
1708          */
1709         function checkLogFailures($email, $secondsBack=3600, $max=3)    {
1710
1711                 if ($email)     {
1712
1713                                 // get last flag set in the log for sending
1714                         $theTimeBack = $GLOBALS['EXEC_TIME'] - $secondsBack;
1715                         $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery(
1716                                                         'tstamp',
1717                                                         'sys_log',
1718                                                         'type=255 AND action=4 AND tstamp>'.intval($theTimeBack),
1719                                                         '',
1720                                                         'tstamp DESC',
1721                                                         '1'
1722                                                 );
1723                         if ($testRow = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res))     {
1724                                 $theTimeBack = $testRow['tstamp'];
1725                         }
1726
1727                                 // Check for more than $max number of error failures with the last period.
1728                         $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery(
1729                                                         '*',
1730                                                         'sys_log',
1731                                                         'type=255 AND action=3 AND error!=0 AND tstamp>'.intval($theTimeBack),
1732                                                         '',
1733                                                         'tstamp'
1734                                                 );
1735                         if ($GLOBALS['TYPO3_DB']->sql_num_rows($res) > $max)    {
1736                                         // OK, so there were more than the max allowed number of login failures - so we will send an email then.
1737                                 $subject = 'TYPO3 Login Failure Warning (at '.$GLOBALS['TYPO3_CONF_VARS']['SYS']['sitename'].')';
1738                                 $email_body = '
1739 There has been numerous attempts ('.$GLOBALS['TYPO3_DB']->sql_num_rows($res).') to login at the TYPO3
1740 site "'.$GLOBALS['TYPO3_CONF_VARS']['SYS']['sitename'].'" ('.t3lib_div::getIndpEnv('HTTP_HOST').').
1741
1742 This is a dump of the failures:
1743
1744 ';
1745                                 while($testRows = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res))  {
1746                                         $theData = unserialize($testRows['log_data']);
1747                                         $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]);
1748                                         $email_body.= chr(10);
1749                                 }
1750                                 mail(   $email,
1751                                         $subject,
1752                                         $email_body,
1753                                         'From: TYPO3 Login WARNING<>'
1754                                 );
1755                                 $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
1756                         }
1757                 }
1758         }
1759 }
1760
1761
1762
1763 if (defined('TYPO3_MODE') && $TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['t3lib/class.t3lib_userauthgroup.php'])     {
1764         include_once($TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['t3lib/class.t3lib_userauthgroup.php']);
1765 }
1766
1767 ?>