class.t3lib_userauthgroup.php

Go to the documentation of this file.

<?php
/***************************************************************
*  Copyright notice
*
*  (c) 1999-2008 Kasper Skaarhoj (kasperYYYY@typo3.com)
*  All rights reserved
*
*  This script is part of the TYPO3 project. The TYPO3 project is
*  free software; you can redistribute it and/or modify
*  it under the terms of the GNU General Public License as published by
*  the Free Software Foundation; either version 2 of the License, or
*  (at your option) any later version.
*
*  The GNU General Public License can be found at
*  http://www.gnu.org/copyleft/gpl.html.
*  A copy is found in the textfile GPL.txt and important notices to the license
*  from the author is found in LICENSE.txt distributed with these scripts.
*
*
*  This script is distributed in the hope that it will be useful,
*  but WITHOUT ANY WARRANTY; without even the implied warranty of
*  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
*  GNU General Public License for more details.
*
*  This copyright notice MUST APPEAR in all copies of the script!
***************************************************************/
/**
 * Contains an extension class specifically for authentication/initialization of backend users in TYPO3
 *
 * $Id: class.t3lib_userauthgroup.php 4579 2008-12-20 17:32:31Z ohader $
 * Revised for TYPO3 3.6 July/2003 by Kasper Skaarhoj
 *
 * @author  Kasper Skaarhoj <kasperYYYY@typo3.com>
 */
/**
 * [CLASS/FUNCTION INDEX of SCRIPT]
 *
 *
 *
 *  135: class t3lib_userAuthGroup extends t3lib_userAuth
 *
 *              SECTION: Permission checking functions:
 *  199:     function isAdmin()
 *  211:     function isMemberOfGroup($groupId)
 *  233:     function doesUserHaveAccess($row,$perms)
 *  250:     function isInWebMount($id,$readPerms='',$exitOnError=0)
 *  277:     function modAccess($conf,$exitOnError)
 *  328:     function getPagePermsClause($perms)
 *  367:     function calcPerms($row)
 *  405:     function isRTE()
 *  439:     function check($type,$value)
 *  456:     function checkAuthMode($table,$field,$value,$authMode)
 *  522:     function checkLanguageAccess($langValue)
 *  544:     function recordEditAccessInternals($table,$idOrRow,$newRecord=FALSE)
 *  619:     function isPSet($lCP,$table,$type='')
 *  636:     function mayMakeShortcut()
 *  650:     function workspaceCannotEditRecord($table,$recData)
 *  689:     function workspaceCannotEditOfflineVersion($table,$recData)
 *  712:     function workspaceAllowLiveRecordsInPID($pid, $table)
 *  733:     function workspaceCreateNewRecord($pid, $table)
 *  752:     function workspaceAllowAutoCreation($table,$id,$recpid)
 *  772:     function workspaceCheckStageForCurrent($stage)
 *  795:     function workspacePublishAccess($wsid)
 *  823:     function workspaceSwapAccess()
 *  835:     function workspaceVersioningTypeAccess($type)
 *  866:     function workspaceVersioningTypeGetClosest($type)
 *
 *              SECTION: Miscellaneous functions
 *  909:     function getTSConfig($objectString,$config='')
 *  935:     function getTSConfigVal($objectString)
 *  947:     function getTSConfigProp($objectString)
 *  959:     function inList($in_list,$item)
 *  970:     function returnWebmounts()
 *  980:     function returnFilemounts()
 *  997:     function jsConfirmation($bitmask)
 *
 *              SECTION: Authentication methods
 * 1035:     function fetchGroupData()
 * 1168:     function fetchGroups($grList,$idList='')
 * 1266:     function setCachedList($cList)
 * 1286:     function addFileMount($title, $altTitle, $path, $webspace, $type)
 * 1333:     function addTScomment($str)
 *
 *              SECTION: Workspaces
 * 1369:     function workspaceInit()
 * 1412:     function checkWorkspace($wsRec,$fields='uid,title,adminusers,members,reviewers,publish_access,stagechg_notification')
 * 1487:     function checkWorkspaceCurrent()
 * 1500:     function setWorkspace($workspaceId)
 * 1528:     function setWorkspacePreview($previewState)
 * 1538:     function getDefaultWorkspace()
 *
 *              SECTION: Logging
 * 1589:     function writelog($type,$action,$error,$details_nr,$details,$data,$tablename='',$recuid='',$recpid='',$event_pid=-1,$NEWid='',$userId=0)
 * 1621:     function simplelog($message, $extKey='', $error=0)
 * 1642:     function checkLogFailures($email, $secondsBack=3600, $max=3)
 *
 * TOTAL FUNCTIONS: 45
 * (This index is automatically created/updated by the extension "extdeveval")
 *
 */

    // Need this for parsing User TSconfig
require_once (PATH_t3lib.'class.t3lib_tsparser.php');





















/**
 * Extension to class.t3lib_userauth.php; Authentication of users in TYPO3 Backend
 *
 * Actually this class is extended again by t3lib_beuserauth which is the actual backend user class that will be instantiated.
 * 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.
 *
 * @author  Kasper Skaarhoj <kasperYYYY@typo3.com>
 * @package TYPO3
 * @subpackage t3lib
 */
class t3lib_userAuthGroup extends t3lib_userAuth {
    var $usergroup_column = 'usergroup';        // Should be set to the usergroup-column (id-list) in the user-record
    var $usergroup_table = 'be_groups';         // The name of the group-table

        // internal
    var $groupData = Array(             // This array holds lists of eg. tables, fields and other values related to the permission-system. See fetchGroupData
        'filemounts' => Array()         // Filemounts are loaded here
    );
    var $workspace = -99;               // User workspace. -99 is ERROR (none available), -1 is offline, 0 is online, >0 is custom workspaces.
    var $workspaceRec = array();        // Custom workspace record if any

    var $userGroups = Array();          // This array will hold the groups that the user is a member of
    var $userGroupsUID = Array();       // This array holds the uid's of the groups in the listed order
    var $groupList ='';                 // This is $this->userGroupsUID imploded to a comma list... Will correspond to the 'usergroup_cached_list'
    var $dataLists=array(               // Used internally to accumulate data for the user-group. DONT USE THIS EXTERNALLY! Use $this->groupData instead
        'webmount_list'=>'',
        'filemount_list'=>'',
        'fileoper_perms' => 0,
        'modList'=>'',
        'tables_select'=>'',
        'tables_modify'=>'',
        'pagetypes_select'=>'',
        'non_exclude_fields'=>'',
        'explicit_allowdeny'=>'',
        'allowed_languages' => '',
        'workspace_perms' => '',
        'custom_options' => '',
    );
    var $includeHierarchy=array();      // For debugging/display of order in which subgroups are included.
    var $includeGroupArray=array();     // List of group_id's in the order they are processed.

    var $OS='';                         // Set to 'WIN', if windows
    var $TSdataArray=array();           // Used to accumulate the TSconfig data of the user
    var $userTS_text = '';              // Contains the non-parsed user TSconfig
    var $userTS = array();              // Contains the parsed user TSconfig
    var $userTSUpdated=0;               // Set internally if the user TSconfig was parsed and needs to be cached.
    var $userTS_dontGetCached=0;        // Set this from outside if you want the user TSconfig to ALWAYS be parsed and not fetched from cache.

    var $RTE_errors = array();          // RTE availability errors collected.
    var $errorMsg = '';                 // Contains last error message

    var $checkWorkspaceCurrent_cache=NULL;  // Cache for checkWorkspaceCurrent()











    /************************************
     *
     * Permission checking functions:
     *
     ************************************/

    /**
     * Returns true if user is admin
     * Basically this function evaluates if the ->user[admin] field has bit 0 set. If so, user is admin.
     *
     * @return  boolean
     */
    function isAdmin()  {
        return (($this->user['admin']&1) ==1);
    }

    /**
     * Returns true if the current user is a member of group $groupId
     * $groupId must be set. $this->groupList must contain groups
     * Will return true also if the user is a member of a group through subgroups.
     *
     * @param   integer     Group ID to look for in $this->groupList
     * @return  boolean
     */
    function isMemberOfGroup($groupId)  {
        $groupId = intval($groupId);
        if ($this->groupList && $groupId)   {
            return $this->inList($this->groupList, $groupId);
        }
    }

    /**
     * Checks if the permissions is granted based on a page-record ($row) and $perms (binary and'ed)
     *
     * Bits for permissions, see $perms variable:
     *
     *      1 - Show:   See/Copy page and the pagecontent.
     *      16- Edit pagecontent: Change/Add/Delete/Move pagecontent.
     *      2- Edit page: Change/Move the page, eg. change title, startdate, hidden.
     *      4- Delete page: Delete the page and pagecontent.
     *      8- New pages: Create new pages under the page.
     *
     * @param   array       $row is the pagerow for which the permissions is checked
     * @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.
     * @return  boolean     True or False upon evaluation
     */
    function doesUserHaveAccess($row,$perms)    {
        $userPerms = $this->calcPerms($row);
        return ($userPerms & $perms)==$perms;
    }

    /**
     * Checks if the page id, $id, is found within the webmounts set up for the user.
     * This should ALWAYS be checked for any page id a user works with, whether it's about reading, writing or whatever.
     * 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.
     * 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
     * Otherwise the function will return the uid of the webmount which was first found in the rootline of the input page $id
     *
     * @param   integer     Page ID to check
     * @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!)
     * @param   boolean     If set, then the function will exit with an error message.
     * @return  integer     The page UID of a page in the rootline that matched a mount point
     */
    function isInWebMount($id,$readPerms='',$exitOnError=0) {
        if (!$GLOBALS['TYPO3_CONF_VARS']['BE']['lockBeUserToDBmounts'] || $this->isAdmin()) return 1;
        $id = intval($id);

            // Check if input id is an offline version page in which case we will map id to the online version:
        $checkRec = t3lib_beFUnc::getRecord('pages',$id,'pid,t3ver_oid');
        if ($checkRec['pid']==-1)   {
            $id = intval($checkRec['t3ver_oid']);
        }

        if (!$readPerms)    $readPerms = $this->getPagePermsClause(1);
        if ($id>0)  {
            $wM = $this->returnWebmounts();
            $rL = t3lib_BEfunc::BEgetRootLine($id,' AND '.$readPerms);

            foreach($rL as $v)  {
                if ($v['uid'] && in_array($v['uid'],$wM))   {
                    return $v['uid'];
                }
            }
        }
        if ($exitOnError)   {
            t3lib_BEfunc::typo3PrintError ('Access Error','This page is not within your DB-mounts',0);
            exit;
        }
    }

    /**
     * Checks access to a backend module with the $MCONF passed as first argument
     *
     * @param   array       $MCONF array of a backend module!
     * @param   boolean     If set, an array will issue an error message and exit.
     * @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
     */
    function modAccess($conf,$exitOnError)  {
        if (!t3lib_BEfunc::isModuleSetInTBE_MODULES($conf['name'])) {
            if ($exitOnError)   {
                t3lib_BEfunc::typo3PrintError ('Fatal Error','This module "'.$conf['name'].'" is not enabled in TBE_MODULES',0);
                exit;
            }
            return FALSE;
        }

            // Workspaces check:
        if ($conf['workspaces'])    {
            if (($this->workspace===0 && t3lib_div::inList($conf['workspaces'],'online')) ||
                ($this->workspace===-1 && t3lib_div::inList($conf['workspaces'],'offline')) ||
                ($this->workspace>0 && t3lib_div::inList($conf['workspaces'],'custom')))    {
                    // ok, go on...
            } else {
                if ($exitOnError)   {
                    t3lib_BEfunc::typo3PrintError ('Workspace Error','This module "'.$conf['name'].'" is not available under the current workspace',0);
                    exit;
                }
                return FALSE;
            }
        }

            // Returns true if conf[access] is not set at all or if the user is admin
        if (!$conf['access']  ||  $this->isAdmin()) return TRUE;

            // If $conf['access'] is set but not with 'admin' then we return true, if the module is found in the modList
        if (!strstr($conf['access'],'admin') && $conf['name'])  {
            $acs = $this->check('modules',$conf['name']);
        }
        if (!$acs && $exitOnError)  {
            t3lib_BEfunc::typo3PrintError ('Access Error','You don\'t have access to this module.',0);
            exit;
        } else return $acs;
    }

    /**
     * Returns a WHERE-clause for the pages-table where user permissions according to input argument, $perms, is validated.
     * $perms is the "mask" used to select. Fx. if $perms is 1 then you'll get all pages that a user can actually see!
     *      2^0 = show (1)
     *      2^1 = edit (2)
     *      2^2 = delete (4)
     *      2^3 = new (8)
     * If the user is 'admin' " 1=1" is returned (no effect)
     * 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)
     * 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.
     *
     * @param   integer     Permission mask to use, see function description
     * @return  string      Part of where clause. Prefix " AND " to this.
     */
    function getPagePermsClause($perms) {
        global $TYPO3_CONF_VARS;
        if (is_array($this->user))  {
            if ($this->isAdmin())   {
                return ' 1=1';
            }

            $perms = intval($perms);    // Make sure it's integer.
            $str= ' ('.
                '(pages.perms_everybody & '.$perms.' = '.$perms.')'.    // Everybody
                ' OR (pages.perms_userid = '.$this->user['uid'].' AND pages.perms_user & '.$perms.' = '.$perms.')'; // User
            if ($this->groupList)   {
                $str.= ' OR (pages.perms_groupid in ('.$this->groupList.') AND pages.perms_group & '.$perms.' = '.$perms.')';   // Group (if any is set)
            }
            $str.=')';

            // ****************
            // getPagePermsClause-HOOK
            // ****************
            if (is_array($TYPO3_CONF_VARS['SC_OPTIONS']['t3lib/class.t3lib_userauthgroup.php']['getPagePermsClause'])) {

                foreach($TYPO3_CONF_VARS['SC_OPTIONS']['t3lib/class.t3lib_userauthgroup.php']['getPagePermsClause'] as $_funcRef) {
                    $_params = array('currentClause' => $str, 'perms' => $perms);
                    $str = t3lib_div::callUserFunction($_funcRef, $_params, $this);
                }
            }

            return $str;
        } else {
            return ' 1=0';
        }
    }

    /**
     * Returns a combined binary representation of the current users permissions for the page-record, $row.
     * 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
     * If the user is admin, 31 is returned (full permissions for all five flags)
     *
     * @param   array       Input page row with all perms_* fields available.
     * @return  integer     Bitwise representation of the users permissions in relation to input page row, $row
     */
    function calcPerms($row)    {
        global $TYPO3_CONF_VARS;
        if ($this->isAdmin()) {return 31;}      // Return 31 for admin users.

        $out=0;
        if (isset($row['perms_userid']) && isset($row['perms_user']) && isset($row['perms_groupid']) && isset($row['perms_group']) && isset($row['perms_everybody']) && isset($this->groupList))    {
            if ($this->user['uid']==$row['perms_userid'])   {
                $out|=$row['perms_user'];
            }
            if ($this->isMemberOfGroup($row['perms_groupid']))  {
                $out|=$row['perms_group'];
            }
            $out|=$row['perms_everybody'];
        }

        // ****************
        // CALCPERMS hook
        // ****************
        if (is_array($TYPO3_CONF_VARS['SC_OPTIONS']['t3lib/class.t3lib_userauthgroup.php']['calcPerms'])) {
            foreach($TYPO3_CONF_VARS['SC_OPTIONS']['t3lib/class.t3lib_userauthgroup.php']['calcPerms'] as $_funcRef) {
                $_params = array(
                    'row' => $row,
                    'outputPermissions' => $out
                );
                $out = t3lib_div::callUserFunction($_funcRef, $_params, $this);
            }
        }

        return $out;
    }

    /**
     * Returns true if the RTE (Rich Text Editor) can be enabled for the user
     * 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]
     * The reasons for a FALSE return can be found in $this->RTE_errors
     *
     * @return  boolean
     */
    function isRTE()    {
        global $CLIENT;

            // Start:
        $this->RTE_errors = array();
        if (!$this->uc['edit_RTE'])
            $this->RTE_errors[] = 'RTE is not enabled for user!';
        if (!$GLOBALS['TYPO3_CONF_VARS']['BE']['RTEenabled'])
            $this->RTE_errors[] = 'RTE is not enabled in $TYPO3_CONF_VARS["BE"]["RTEenabled"]';


            // Acquire RTE object:
        $RTE = &t3lib_BEfunc::RTEgetObj();
        if (!is_object($RTE))   {
            $this->RTE_errors = array_merge($this->RTE_errors, $RTE);
        }

        if (!count($this->RTE_errors))  {
            return TRUE;
        } else {
            return FALSE;
        }
    }

    /**
     * Returns true if the $value is found in the list in a $this->groupData[] index pointed to by $type (array key).
     * Can thus be users to check for modules, exclude-fields, select/modify permissions for tables etc.
     * If user is admin true is also returned
     * Please see the document Inside TYPO3 for examples.
     *
     * @param   string      The type value; "webmounts", "filemounts", "pagetypes_select", "tables_select", "tables_modify", "non_exclude_fields", "modules"
     * @param   string      String to search for in the groupData-list
     * @return  boolean     True if permission is granted (that is, the value was found in the groupData list - or the BE_USER is "admin")
     */
    function check($type,$value)    {
        if (isset($this->groupData[$type])) {
            if ($this->isAdmin() || $this->inList($this->groupData[$type],$value)) {
                return 1;
            }
        }
    }

    /**
     * Checking the authMode of a select field with authMode set
     *
     * @param   string      Table name
     * @param   string      Field name (must be configured in TCA and of type "select" with authMode set!)
     * @param   string      Value to evaluation (single value, must not contain any of the chars ":,|")
     * @param   string      Auth mode keyword (explicitAllow, explicitDeny, individual)
     * @return  boolean     True or false whether access is granted or not.
     */
    function checkAuthMode($table,$field,$value,$authMode)  {
        global $TCA;

            // Admin users can do anything:
        if ($this->isAdmin())   return TRUE;

            // Allow all blank values:
        if (!strcmp($value,'')) return TRUE;

            // Certain characters are not allowed in the value
        if (ereg('[:|,]',$value))   {
            return FALSE;
        }

            // Initialize:
        $testValue = $table.':'.$field.':'.$value;
        $out = TRUE;

            // Checking value:
        switch((string)$authMode)   {
            case 'explicitAllow':
                if (!$this->inList($this->groupData['explicit_allowdeny'],$testValue.':ALLOW')) {
                    $out = FALSE;
                }
            break;
            case 'explicitDeny':
                if ($this->inList($this->groupData['explicit_allowdeny'],$testValue.':DENY'))   {
                    $out = FALSE;
                }
            break;
            case 'individual':
                t3lib_div::loadTCA($table);
                if (is_array($TCA[$table]) && is_array($TCA[$table]['columns'][$field]))    {
                    $items = $TCA[$table]['columns'][$field]['config']['items'];
                    if (is_array($items))   {
                        foreach($items as $iCfg)    {
                            if (!strcmp($iCfg[1],$value) && $iCfg[4])   {
                                switch((string)$iCfg[4])    {
                                    case 'EXPL_ALLOW':
                                        if (!$this->inList($this->groupData['explicit_allowdeny'],$testValue.':ALLOW')) {
                                            $out = FALSE;
                                        }
                                    break;
                                    case 'EXPL_DENY':
                                        if ($this->inList($this->groupData['explicit_allowdeny'],$testValue.':DENY'))   {
                                            $out = FALSE;
                                        }
                                    break;
                                }
                                break;
                            }
                        }
                    }
                }
            break;
        }

        return $out;
    }

    /**
     * Checking if a language value (-1, 0 and >0 for sys_language records) is allowed to be edited by the user.
     *
     * @param   integer     Language value to evaluate
     * @return  boolean     Returns true if the language value is allowed, otherwise false.
     */
    function checkLanguageAccess($langValue)    {
        if (strcmp(trim($this->groupData['allowed_languages']),'')) {   // The users language list must be non-blank - otherwise all languages are allowed.
            $langValue = intval($langValue);
            if ($langValue != -1 && !$this->check('allowed_languages',$langValue))  {   // Language must either be explicitly allowed OR the lang Value be "-1" (all languages)
                return FALSE;
            }
        }
        return TRUE;
    }

    /**
     * Checking if a user has editing access to a record from a $TCA table.
     * 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.
     * For instance languages settings, authMode selector boxes are evaluated (and maybe more in the future).
     * It will check for workspace dependent access.
     * The function takes an ID (integer) or row (array) as second argument.
     *
     * @param   string      Table name
     * @param   mixed       If integer, then this is the ID of the record. If Array this just represents fields in the record.
     * @param   boolean     Set, if testing a new (non-existing) record array. Will disable certain checks that doesn't make much sense in that context.
     * @return  boolean     True if OK, otherwise false
     */
    function recordEditAccessInternals($table,$idOrRow,$newRecord=FALSE)    {
        global $TCA;

        if (isset($TCA[$table]))    {
            t3lib_div::loadTCA($table);

                // Always return true for Admin users.
            if ($this->isAdmin())   return TRUE;

                // Fetching the record if the $idOrRow variable was not an array on input:
            if (!is_array($idOrRow))    {
                $idOrRow = t3lib_BEfunc::getRecord($table, $idOrRow);
                if (!is_array($idOrRow))    {
                    $this->errorMsg = 'ERROR: Record could not be fetched.';
                    return FALSE;
                }
            }

                // Checking languages:
            if ($TCA[$table]['ctrl']['languageField'])  {
                if (isset($idOrRow[$TCA[$table]['ctrl']['languageField']])) {   // Language field must be found in input row - otherwise it does not make sense.
                    if (!$this->checkLanguageAccess($idOrRow[$TCA[$table]['ctrl']['languageField']]))   {
                        $this->errorMsg = 'ERROR: Language was not allowed.';
                        return FALSE;
                    }
                } else {
                    $this->errorMsg = 'ERROR: The "languageField" field named "'.$TCA[$table]['ctrl']['languageField'].'" was not found in testing record!';
                    return FALSE;
                }
            }

                // Checking authMode fields:
            if (is_array($TCA[$table]['columns']))  {
                foreach($TCA[$table]['columns'] as $fN => $fV)  {
                    if (isset($idOrRow[$fN]))   {   //
                        if ($fV['config']['type']=='select' && $fV['config']['authMode'] && !strcmp($fV['config']['authMode_enforce'],'strict')) {
                            if (!$this->checkAuthMode($table,$fN,$idOrRow[$fN],$fV['config']['authMode']))  {
                                $this->errorMsg = 'ERROR: authMode "'.$fV['config']['authMode'].'" failed for field "'.$fN.'" with value "'.$idOrRow[$fN].'" evaluated';
                                return FALSE;
                            }
                        }
                    }
                }
            }

                // Checking "editlock" feature (doesn't apply to new records)
            if (!$newRecord && $TCA[$table]['ctrl']['editlock'])    {
                if (isset($idOrRow[$TCA[$table]['ctrl']['editlock']]))  {
                    if ($idOrRow[$TCA[$table]['ctrl']['editlock']]) {
                        $this->errorMsg = 'ERROR: Record was locked for editing. Only admin users can change this state.';
                        return FALSE;
                    }
                } else {
                    $this->errorMsg = 'ERROR: The "editLock" field named "'.$TCA[$table]['ctrl']['editlock'].'" was not found in testing record!';
                    return FALSE;
                }
            }

                // Checking record permissions
            // THIS is where we can include a check for "perms_" fields for other records than pages...

                // Process any hooks
            if (is_array($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_userauthgroup.php']['recordEditAccessInternals']))    {
                foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_userauthgroup.php']['recordEditAccessInternals'] as $funcRef) {
                    $params = array(
                        'table' => $table,
                        'idOrRow' => $idOrRow,
                        'newRecord' => $newRecord
                    );
                    if (!t3lib_div::callUserFunction($funcRef, $params, $this)) {
                        return FALSE;
                    }
                }
            }

                // Finally, return true if all is well.
            return TRUE;
        }
    }

    /**
     * Will check a type of permission against the compiled permission integer, $lCP, and in relation to table, $table
     *
     * @param   integer     $lCP could typically be the "compiled permissions" integer returned by ->calcPerms
     * @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)
     * @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)
     * @return  boolean
     * @access private
     */
    function isPSet($lCP,$table,$type='')   {
        if ($this->isAdmin())   return true;
        if ($table=='pages')    {
            if ($type=='edit')  return $lCP & 2;
            if ($type=='new')   return ($lCP & 8) || ($lCP & 16);   // Create new page OR pagecontent
            if ($type=='delete')    return $lCP & 4;
            if ($type=='editcontent')   return $lCP & 16;
        } else {
            return $lCP & 16;
        }
    }

    /**
     * Returns true if the BE_USER is allowed to *create* shortcuts in the backend modules
     *
     * @return  boolean
     */
    function mayMakeShortcut()  {
        return $this->getTSConfigVal('options.shortcutFrame') && !$this->getTSConfigVal('options.mayNotCreateEditShortcuts');
    }

    /**
     * Checking if editing of an existing record is allowed in current workspace if that is offline.
     * Rules for editing in offline mode:
     *      - record supports versioning and is an offline version from workspace and has the corrent stage
     *      - 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
     *
     * @param   string      Table of record
     * @param   array       Integer (record uid) or array where fields are at least: pid, t3ver_wsid, t3ver_stage (if versioningWS is set)
     * @return  string      String error code, telling the failure state. FALSE=All ok
     */
    function workspaceCannotEditRecord($table,$recData) {

        if ($this->workspace!==0)   {   // Only test offline spaces:

            if (!is_array($recData))    {
                $recData = t3lib_BEfunc::getRecord($table,$recData,'pid'.($GLOBALS['TCA'][$table]['ctrl']['versioningWS']?',t3ver_wsid,t3ver_stage':''));
            }

            if (is_array($recData)) {
                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.
                    if (!$GLOBALS['TCA'][$table]['ctrl']['versioningWS'])   {   // No versioning, basic error, inconsistency even! Such records should not have a pid of -1!
                        return 'Versioning disabled for table';
                    } elseif ((int)$recData['t3ver_wsid']!==$this->workspace)   {   // So does workspace match?
                        return 'Workspace ID of record didn\'t match current workspace';
                    } else {    // So what about the stage of the version, does that allow editing for this user?
                        return $this->workspaceCheckStageForCurrent($recData['t3ver_stage']) ? FALSE : 'Record stage "'.$recData['t3ver_stage'].'" and users access level did not allow for editing';
                    }
                } else {    // We are testing a "live" record:
                    if ($res = $this->workspaceAllowLiveRecordsInPID($recData['pid'], $table)) {    // For "Live" records, check that PID for table allows editing
                            // Live records are OK in this branch, but what about the stage of branch point, if any:
                        return $res>0 ? FALSE : 'Stage for versioning root point and users access level did not allow for editing'; // OK
                    } else {    // If not offline and not in versionized branch, output error:
                        return 'Online record was not in versionized branch!';
                    }
                }
            } else return 'No record';
        } else {
            return FALSE;   // OK because workspace is 0
        }
    }

    /**
     * Evaluates if a user is allowed to edit the offline version
     *
     * @param   string      Table of record
     * @param   array       Integer (record uid) or array where fields are at least: pid, t3ver_wsid, t3ver_stage (if versioningWS is set)
     * @return  string      String error code, telling the failure state. FALSE=All ok
     * @see workspaceCannotEditRecord()
     */
    function workspaceCannotEditOfflineVersion($table,$recData) {
        if ($GLOBALS['TCA'][$table]['ctrl']['versioningWS'])    {

            if (!is_array($recData))    {
                $recData = t3lib_BEfunc::getRecord($table,$recData,'uid,pid,t3ver_wsid,t3ver_stage');
            }
            if (is_array($recData)) {
                if ((int)$recData['pid']===-1)  {
                    return $this->workspaceCannotEditRecord($table,$recData);
                } else return 'Not an offline version';
            } else return 'No record';
        } else return 'Table does not support versioning.';
    }

    /**
     * Check if "live" records from $table may be created or edited in this PID.
     * If the answer is FALSE it means the only valid way to create or edit records in the PID is by versioning
     * 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!
     *
     * @param   integer     PID value to check for.
     * @param   string      Table name
     * @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.
     */
    function workspaceAllowLiveRecordsInPID($pid, $table)   {

            // Always for Live workspace AND if live-edit is enabled and tables are completely without versioning it is ok as well.
        if ($this->workspace===0 || ($this->workspaceRec['live_edit'] && !$GLOBALS['TCA'][$table]['ctrl']['versioningWS']) || $GLOBALS['TCA'][$table]['ctrl']['versioningWS_alwaysAllowLiveEdit'])  {
            return 2;   // OK to create for this table.
        } 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.
                // Now, check what the stage of that "page" or "branch" version type is:
            $stage = t3lib_BEfunc::isPidInVersionizedBranch($pid, $table, TRUE);
            return $this->workspaceCheckStageForCurrent($stage) ? 1 : -1;
        } else {
            return FALSE;   // If the answer is FALSE it means the only valid way to create or edit records in the PID is by versioning
        }
    }

    /**
     * Evaluates if a record from $table can be created in $pid
     *
     * @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!
     * @param   string      Table name
     * @return  boolean     TRUE if OK.
     */
    function workspaceCreateNewRecord($pid, $table) {
        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
            if ($res<0) {
                return FALSE;   // Stage for versioning root point and users access level did not allow for editing
            }
        } elseif (!$GLOBALS['TCA'][$table]['ctrl']['versioningWS']) {   // So, if no live records were allowed, we have to create a new version of this record:
            return FALSE;
        }
        return TRUE;
    }

    /**
     * Evaluates if auto creation of a version of a record is allowed.
     *
     * @param   string      Table of the record
     * @param   integer     UID of record
     * @param   integer     PID of record
     * @return  boolean     TRUE if ok.
     */
    function workspaceAllowAutoCreation($table,$id,$recpid) {
            // 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.
        if ($this->workspace!==0    // Only in draft workspaces
            && !$this->workspaceRec['disable_autocreate']   // Auto-creation must not be disabled.
            && $GLOBALS['TCA'][$table]['ctrl']['versioningWS']  // Table must be versionizable
            && $recpid >= 0 // The PID of the record must NOT be -1 or less (would indicate that it already was a version!)
            && !t3lib_BEfunc::getWorkspaceVersionOfRecord($this->workspace, $table, $id, 'uid') // There must be no existing version of this record in workspace.
            && !t3lib_BEfunc::isPidInVersionizedBranch($recpid, $table))    {   // PID must NOT be in a versionized branch either
                return TRUE;
        }
    }

    /**
     * Checks if an element stage allows access for the user in the current workspace
     * In workspaces 0 (Live) and -1 (Default draft) access is always granted for any stage.
     * Admins are always allowed.
     * An option for custom workspaces allows members to also edit when the stage is "Review"
     *
     * @param   integer     Stage id from an element: -1,0 = editing, 1 = reviewer, >1 = owner
     * @return  boolean     TRUE if user is allowed access
     */
    function workspaceCheckStageForCurrent($stage)  {
        if ($this->isAdmin())   return TRUE;

        if ($this->workspace>0) {
            $stat = $this->checkWorkspaceCurrent();
            $memberStageLimit = $this->workspaceRec['review_stage_edit'] ? 1 : 0;
            if (($stage<=$memberStageLimit && $stat['_ACCESS']==='member') ||
                ($stage<=1 && $stat['_ACCESS']==='reviewer') ||
                ($stat['_ACCESS']==='owner')) {
                    return TRUE;    // OK for these criteria
            }
        } else return TRUE; // Always OK for live and draft workspaces.
    }

    /**
     * Returns TRUE if the user has access to publish content from the workspace ID given.
     * Admin-users are always granted access to do this
     * If the workspace ID is 0 (live) all users have access also
     * If -1 (draft workspace) TRUE is returned if the user has access to the Live workspace
     * For custom workspaces it depends on whether the user is owner OR like with draft workspace if the user has access to Live workspace.
     *
     * @param   integer     Workspace UID; -1,0,1+
     * @return  boolean     Returns TRUE if the user has access to publish content from the workspace ID given.
     */
    function workspacePublishAccess($wsid)  {
        if ($this->isAdmin())   return TRUE;

            // If no access to workspace, of course you cannot publish!
        $retVal = FALSE;

        $wsAccess = $this->checkWorkspace($wsid);
        if ($wsAccess)  {
            switch($wsAccess['uid'])    {
                case 0:     // Live workspace
                    $retVal =  TRUE;    // If access to Live workspace, no problem.
                break;
                case -1:    // Default draft workspace
                    $retVal =  $this->checkWorkspace(0) ? TRUE : FALSE; // If access to Live workspace, no problem.
                break;
                default:    // Custom workspace
                    $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.
                break;
            }
        }
        return $retVal;
    }

    /**
     * Workspace swap-mode access?
     *
     * @return  boolean     Returns TRUE if records can be swapped in the current workspace, otherwise false
     */
    function workspaceSwapAccess()  {
        if ($this->workspace>0 && (int)$this->workspaceRec['swap_modes']===2)   {
            return FALSE;
        } else return TRUE;
    }

    /**
     * Workspace Versioning type access?
     *
     * @param   integer     Versioning type to evaluation: -1, 0, >1
     * @return  boolean     TRUE if OK
     */
    function workspaceVersioningTypeAccess($type)   {
        $retVal = FALSE;

        $type = t3lib_div::intInRange($type,-1);

            // Check if only element versioning is allowed:
        if ($GLOBALS['TYPO3_CONF_VARS']['BE']['elementVersioningOnly'] && $type!=-1)    {
            return FALSE;
        }

        if ($this->workspace>0 && !$this->isAdmin())    {
            $stat = $this->checkWorkspaceCurrent();
            if ($stat['_ACCESS']!=='owner') {

                switch((int)$type)  {
                    case -1:
                        $retVal = $this->workspaceRec['vtypes']&1 ? FALSE : TRUE;
                    break;
                    case 0:
                        $retVal = $this->workspaceRec['vtypes']&2 ? FALSE : TRUE;
                    break;
                    default:
                        $retVal = $this->workspaceRec['vtypes']&4 ? FALSE : TRUE;
                    break;
                }
            } else $retVal = TRUE;
        } else $retVal = TRUE;

        return $retVal;
    }

    /**
     * Finding "closest" versioning type, used for creation of new records.
     *
     * @param   integer     Versioning type to evaluation: -1, 0, >1
     * @return  integer     Returning versioning type
     */
    function workspaceVersioningTypeGetClosest($type)   {
        $type = t3lib_div::intInRange($type,-1);

        if ($this->workspace>0) {
            switch((int)$type)  {
                case -1:
                    $type = -1;
                break;
                case 0:
                    $type = $this->workspaceVersioningTypeAccess($type) ? $type : -1;
                break;
                default:
                    $type = $this->workspaceVersioningTypeAccess($type) ? $type : ($this->workspaceVersioningTypeAccess(0) ? 0 : -1);
                break;
            }
        }
        return $type;
    }










    /*************************************
     *
     * Miscellaneous functions
     *
     *************************************/

    /**
     * Returns the value/properties of a TS-object as given by $objectString, eg. 'options.dontMountAdminMounts'
     * Nice (general!) function for returning a part of a TypoScript array!
     *
     * @param   string      Pointer to an "object" in the TypoScript array, fx. 'options.dontMountAdminMounts'
     * @param   array       Optional TSconfig array: If array, then this is used and not $this->userTS. If not array, $this->userTS is used.
     * @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.
     * @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.
     */
    function getTSConfig($objectString,$config='')  {
        if (!is_array($config)) {
            $config=$this->userTS;  // Getting Root-ts if not sent
        }
        $TSConf=array();
        $parts = explode('.',$objectString,2);
        $key = $parts[0];
        if (trim($key)) {
            if (count($parts)>1 && trim($parts[1])) {
                // Go on, get the next level
                if (is_array($config[$key.'.']))    $TSConf = $this->getTSConfig($parts[1],$config[$key.'.']);
            } else {
                $TSConf['value']=$config[$key];
                $TSConf['properties']=$config[$key.'.'];
            }
        }
        return $TSConf;
    }

    /**
     * Returns the "value" of the $objectString from the BE_USERS "User TSconfig" array
     *
     * @param   string      Object string, eg. "somestring.someproperty.somesubproperty"
     * @return  string      The value for that object string (object path)
     * @see getTSConfig()
     */
    function getTSConfigVal($objectString)  {
        $TSConf = $this->getTSConfig($objectString);
        return $TSConf['value'];
    }

    /**
     * Returns the "properties" of the $objectString from the BE_USERS "User TSconfig" array
     *
     * @param   string      Object string, eg. "somestring.someproperty.somesubproperty"
     * @return  array       The properties for that object string (object path) - if any
     * @see getTSConfig()
     */
    function getTSConfigProp($objectString) {
        $TSConf = $this->getTSConfig($objectString);
        return $TSConf['properties'];
    }

    /**
     * Returns true if $item is in $in_list
     *
     * @param   string      Comma list with items, no spaces between items!
     * @param   string      The string to find in the list of items
     * @return  string      Boolean
     */
    function inList($in_list,$item) {
        return strstr(','.$in_list.',', ','.$item.',');
    }

    /**
     * Returns an array with the webmounts.
     * If no webmounts, and empty array is returned.
     * 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.
     *
     * @return  array
     */
    function returnWebmounts()  {
        return (string)($this->groupData['webmounts'])!='' ? explode(',',$this->groupData['webmounts']) : Array();
    }

    /**
     * Returns an array with the filemounts for the user. Each filemount is represented with an array of a "name", "path" and "type".
     * If no filemounts an empty array is returned.
     *
     * @return  array
     */
    function returnFilemounts() {
        return $this->groupData['filemounts'];
    }

    /**
     * Returns an integer bitmask that represents the permissions for file operations.
     * Permissions of the user and groups the user is a member of were combined by a logical OR.
     *
     * Meaning of each bit:
     *  1 - Files: Upload,Copy,Move,Delete,Rename
     *  2 - Files: Unzip
     *  4 - Directory: Move,Delete,Rename,New
     *  8 - Directory: Copy
     *  16 - Directory: Delete recursively (rm -Rf)
     *
     * @return  integer     File operation permission bitmask
     */
    public function getFileoperationPermissions() {
        return $this->groupData['fileoper_perms'];
    }

    /**
     * Returns true or false, depending if an alert popup (a javascript confirmation) should be shown
     * call like $GLOBALS['BE_USER']->jsConfirmation($BITMASK)
     *
     *    1 - typeChange
     *    2 - copy/move/paste
     *    4 - delete
     *    8 - frontend editing
     *    128 - other (not used yet)
     *
     * @param   integer   Bitmask
     * @return  boolean     true if the confirmation should be shown
     */
     function jsConfirmation($bitmask)  {
         $alertPopup = $GLOBALS['BE_USER']->getTSConfig('options.alertPopups');
         if (empty($alertPopup['value']))   {
             $alertPopup = 255; // default: show all warnings
         } else {
             $alertPopup = (int)$alertPopup['value'];
         }
         if(($alertPopup&$bitmask) == $bitmask) { // show confirmation
             return 1;
         } else { // don't show confirmation
             return 0;
         }
     }









    /*************************************
     *
     * Authentication methods
     *
     *************************************/


    /**
     * Initializes a lot of stuff like the access-lists, database-mountpoints and filemountpoints
     * This method is called by ->backendCheckLogin() (from extending class t3lib_beuserauth) if the backend user login has verified OK.
     * Generally this is required initialization of a backend user.
     *
     * @return  void
     * @access private
     * @see t3lib_TSparser
     */
    function fetchGroupData()   {
        if ($this->user['uid']) {

                // Get lists for the be_user record and set them as default/primary values.
            $this->dataLists['modList'] = $this->user['userMods'];                  // Enabled Backend Modules
            $this->dataLists['allowed_languages'] = $this->user['allowed_languages'];                   // Add Allowed Languages
            $this->dataLists['workspace_perms'] = $this->user['workspace_perms'];                   // Set user value for workspace permissions.
            $this->dataLists['webmount_list'] = $this->user['db_mountpoints'];      // Database mountpoints
            $this->dataLists['filemount_list'] = $this->user['file_mountpoints'];   // File mountpoints
            $this->dataLists['fileoper_perms'] = (int)$this->user['fileoper_perms'];    // Fileoperation permissions

                // Setting default User TSconfig:
            $this->TSdataArray[]=$this->addTScomment('From $GLOBALS["TYPO3_CONF_VARS"]["BE"]["defaultUserTSconfig"]:').
                                    $GLOBALS['TYPO3_CONF_VARS']['BE']['defaultUserTSconfig'];

                // Default TSconfig for admin-users
            if ($this->isAdmin())   {
                $this->TSdataArray[]=$this->addTScomment('"admin" user presets:').'
                    admPanel.enable.all = 1
                    options.shortcutFrame = 1
                ';
                if (t3lib_extMgm::isLoaded('sys_note')) {
                    $this->TSdataArray[]='
                        // Setting defaults for sys_note author / email...
                        TCAdefaults.sys_note.author = '.$this->user['realName'].'
                        TCAdefaults.sys_note.email = '.$this->user['email'].'
                    ';
                }
            }

                // FILE MOUNTS:
                // Admin users has the base fileadmin dir mounted
            if ($this->isAdmin() && $GLOBALS['TYPO3_CONF_VARS']['BE']['fileadminDir'])  {
                $this->addFileMount($GLOBALS['TYPO3_CONF_VARS']['BE']['fileadminDir'], '', PATH_site.$GLOBALS['TYPO3_CONF_VARS']['BE']['fileadminDir'], 0, '');
            }

                // If userHomePath is set, we attempt to mount it
            if ($GLOBALS['TYPO3_CONF_VARS']['BE']['userHomePath'])  {
                    // First try and mount with [uid]_[username]
                $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');
                if (!$didMount) {
                        // If that failed, try and mount with only [uid]
                    $this->addFileMount($this->user['username'], '', $GLOBALS['TYPO3_CONF_VARS']['BE']['userHomePath'].$this->user['uid'].$GLOBALS['TYPO3_CONF_VARS']['BE']['userUploadDir'], 0, 'user');
                }
            }

                // BE_GROUPS:
                // Get the groups...
#           $grList = t3lib_BEfunc::getSQLselectableList($this->user[$this->usergroup_column],$this->usergroup_table,$this->usergroup_table);
            $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.
            if ($grList)    {