tslib/class.tslib_fe.php

Go to the documentation of this file.

<?php
/***************************************************************
*  Copyright notice
*
*  (c) 1999-2005 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!
***************************************************************/
 class tslib_fe {

                // CURRENT PAGE:
        var $id='';                                                     // The page id (int)
        var $type='';                                           // RO The type (int)
        var $idParts=array();                           // Loaded with the id, exploded by ','
        var $cHash='';                                          // The submitted cHash
        var $no_cache='';                                       // Page will not be cached. Write only true. Never clear value (some other code might have reasons to set it true)
        var $rootLine='';                                       // The rootLine (all the way to tree root, not only the current site!) (array)
        var $page='';                                           // The pagerecord (array)
        var $contentPid=0;                                      // This will normally point to the same value as id, but can be changed to point to another page from which content will then be displayed instead.
        var $sys_page='';                                       // The object with pagefunctions (object)
        var $jumpurl='';
        var $pageNotFound=0;                            // Is set to 1 if a pageNotFound handler could have been called.
        var $domainStartPage=0;                         // Domain start page
        var $pageAccessFailureHistory=array();  // Array containing a history of why a requested page was not accessible.
        var $MP='';
        var $RDCT='';
        var $page_cache_reg1=0;                         // This can be set from applications as a way to tag cached versions of a page and later perform some external cache management, like clearing only a part of the cache of a page...
        var $siteScript='';                                     // Contains the value of the current script path that activated the frontend. Typically "index.php" but by rewrite rules it could be something else! Used for Speaking Urls / Simulate Static Documents.

                // USER
        var $fe_user='';                                        // The user (object)
        var $loginUser='';                                      // Global falg indicating that a front-end user is logged in. This is set only if a user really IS logged in. The group-list may show other groups (like added by IP filter or so) even though there is no user.
        var $gr_list='';                                        // (RO=readonly) The group list, sorted numerically. Group '0,-1' is the default group, but other groups may be added by other means than a user being logged in though...
        var $beUserLogin='';                            // Flag that indicates if a Backend user is logged in!
        var $loginAllowedInBranch = TRUE;       // Shows whether logins are allowed in branch

                // PREVIEW
        var $fePreview='';                                      // Flag indication that preview is active. This is based on the login of a backend user and whether the backend user has read access to the current page.
        var $showHiddenPage='';                         // Flag indicating that hidden pages should be shown, selected and so on. This goes for almost all selection of pages!
        var $showHiddenRecords='';                      // Flag indicating that hidden records should be shown. This includes sys_template, pages_language_overlay and even fe_groups in addition to all other regular content. So in effect, this includes everything except pages.
        var $simUserGroup='0';                          // Value that contains the simulated usergroup if any
        var $versionPreviewMap=array();         // Versioning Preview record map (temporary, for sys_page)

                // CONFIGURATION
        var $TYPO3_CONF_VARS=array();           // The configuration array as set up in t3lib/config_default.php. Should be an EXACT copy of the global array.
        var $config='';                                         // 'CONFIG' object from TypoScript. Array generated based on the TypoScript configuration of the current page. Saved with the cached pages.
        var $TCAcachedExtras=array();           // Array of cached information from TCA. This is NOT TCA itself!

                // TEMPLATE / CACHE
        var $tmpl='';                                           // The TypoScript template object. Used to parse the TypoScript template
        var $cacheTimeOutDefault='';            // Is set to the time-to-live time of cached pages. If false, default is 60*60*24, which is 24 hours.
        var $cacheContentFlag='';                       // Set internally if cached content is fetched from the database
        var $cacheExpires=0;                            // Set to the expire time of cached content
        var $isClientCachable=FALSE;            // Set if cache headers allowing caching are sent.
        var $all='';                                            // $all used by template fetching system. This array is an identification of the template. If $this->all is empty it's because the template-data is not cached, which it must be.
        var $sPre='';                                           // toplevel - objArrayName, eg 'page'
        var $pSetup='';                                         // TypoScript configuration of the page-object pointed to by sPre. $this->tmpl->setup[$this->sPre.'.']
        var $newHash='';                                        // This hash is unique to the template, the $this->id and $this->type vars and the gr_list (list of groups). Used to get and later store the cached data
        var $getMethodUrlIdToken='';            // If config.ftu (Frontend Track User) is set in TypoScript for the current page, the string value of this var is substituted in the rendered source-code with the string, '&ftu=[token...]' which enables GET-method usertracking as opposed to cookie based
        var $noCacheBeforePageGen='';           // This flag is set before inclusion of pagegen.php IF no_cache is set. If this flag is set after the inclusion of pagegen.php, no_cache is forced to be set. This is done in order to make sure that php-code from pagegen does not falsely clear the no_cache flag.
        var $tempContent = FALSE;                       // This flag indicates if temporary content went into the cache during page-generation.
        var $forceTemplateParsing='';                           // Boolean, passed to TypoScript template class and tells it to render the template forcibly
        var $cHash_array=array();                       // The array which cHash_calc is based on, see ->makeCacheHash().
        var $hash_base='';                                      // Loaded with the serialized array that is used for generating a hashstring for the cache
        var $pagesTSconfig='';                          // May be set to the pagesTSconfig
                // PAGE-GENERATION / cOBJ
        /*
                Eg. insert JS-functions in this array ($additionalHeaderData) to include them once. Use associative keys.
                Keys in use:
                        JSFormValidate  :               <script type="text/javascript" src="'.$GLOBALS["TSFE"]->absRefPrefix.'t3lib/jsfunc.validateform.js"></script>
                        JSincludeFormupdate :   <script type="text/javascript" src="t3lib/jsfunc.updateform.js"></script>
                        JSMenuCode, JSMenuCode_menu :                   JavaScript for the JavaScript menu
                        JSCode : reserved
                        JSImgCode : reserved
        */
        var $defaultBodyTag='<body bgcolor="#FFFFFF">';         // Default bodytag, if nothing else is set. This can be overridden by applications like TemplaVoila.
        var $additionalHeaderData=array();      // used to accumulate additional HTML-code for the header-section, <head>...</head>. Insert either associative keys (like additionalHeaderData['myStyleSheet'], see reserved keys above) or num-keys (like additionalHeaderData[] = '...')
        var $additionalJavaScript=array();      // used to accumulate additional JavaScript-code. Works like additionalHeaderData. Reserved keys at 'openPic' and 'mouseOver'
        var $additionalCSS=array();                     // used to accumulate additional Style code. Works like additionalHeaderData.
        var $JSeventFuncCalls = array(          // you can add JavaScript functions to each entry in these arrays. Please see how this is done in the GMENU_LAYERS script. The point is that many applications on a page can set handlers for onload, onmouseover and onmouseup
                'onmousemove' => array(),
                'onmouseup' => array(),
                'onload' => array(),
        );
        var $JSCode='';                                         // Depreciated, use additionalJavaScript instead.
        var $JSImgCode='';                                      // Used to accumulate JavaScript loaded images (by menus)
        var $divSection='';                                     // Used to accumulate DHTML-layers.

                // RENDERING configuration, settings from TypoScript is loaded into these vars. See pagegen.php
        var $debug='';                                          // Debug flag, may output special debug html-code.
        var $intTarget='';                                      // Default internal target
        var $extTarget='';                                      // Default external target
        var $MP_defaults=array();                       // Keys are page ids and values are default &MP (mount point) values to set when using the linking features...)
        var $spamProtectEmailAddresses=0;       // If set, typolink() function encrypts email addresses. Is set in pagegen-class.
        var $absRefPrefix='';                           // Absolute Reference prefix
        var $absRefPrefix_force=0;                      // Absolute Reference prefix force flag. This is set, if the type and id is retrieve from PATH_INFO and thus we NEED to prefix urls with at least '/'
        var $compensateFieldWidth='';           // Factor for form-field widths compensation
        var $lockFilePath='';                           // Lock file path
        var $ATagParams='';                                     // <A>-tag parameters
        var $sWordRegEx='';                                     // Search word regex, calculated if there has been search-words send. This is used to mark up the found search words on a page when jumped to from a link in a search-result.
        var $sWordList='';                                      // Is set to the incoming array sword_list in case of a page-view jumped to from a search-result.
        var $linkVars='';                                       // A string prepared for insertion in all links on the page as url-parameters. Based on configuration in TypoScript where you defined which GET_VARS you would like to pass on.
        var $excludeCHashVars='';                       // A string set with a comma list of additional GET vars which should NOT be included in the cHash calculation. These vars should otherwise be detected and involved in caching, eg. through a condition in TypoScript.
        var $displayEditIcons='';                       // If set, edit icons are rendered aside content records. Must be set only if the ->beUserLogin flag is set and set_no_cache() must be called as well.
        var $displayFieldEditIcons='';          // If set, edit icons are rendered aside individual fields of content. Must be set only if the ->beUserLogin flag is set and set_no_cache() must be called as well.
        var $sys_language_uid=0;                        // Site language, 0 (zero) is default, int+ is uid pointing to a sys_language record. Should reflect which language it DOES actually display!
        var $sys_language_mode='';                      // Site language mode
        var $sys_language_content=0;            // Site content selection uid
        var $sys_language_contentOL=0;          // Site content overlay flag; If set - and sys_language_content is > 0 - , records selected will try to look for a translation pointing to their uid. (If configured in [ctrl][languageField] / [ctrl][transOrigP...]
        var $sys_language_isocode = '';         // Is set to the iso code of the sys_language_content if that is properly defined by the sys_language record representing the sys_language_uid. (Requires the extension "static_info_tables")

                // RENDERING data
        var $applicationData=Array();           //       'Global' Storage for various applications. Keys should be 'tx_'.extKey for extensions.
        var $register=Array();
        var $registerStack=Array();                     // Stack used for storing array and retrieving register arrays (see LOAD_REGISTER and CLEAR_REGISTER)
        var $cObjectDepthCounter = 50;          // Checking that the function is not called eternally. This is done by interrupting at a depth of 50
        var $recordRegister = Array();          // used by cObj->RECORDS and cObj->CONTENT to ensure the a records is NOT rendered twice through it!
        var $currentRecord = '';                        // This is set to the [table]:[uid] of the latest record rendered. Note that class tslib_cObj has an equal value, but that is pointing to the record delivered in the $data-array of the tslib_cObj instance, if the cObjects CONTENT or RECORD created that instance
        var $accessKey =array();                        // Used by class tslib_menu to keep track of access-keys.
        var $imagesOnPage=array();                      // Numerical array where image filenames are added if they are referenced in the rendered document. This includes only TYPO3 generated/inserted images.
        var $lastImageInfo=array();                     // Is set in tslib_cObj->cImage() function to the info-array of the most recent rendered image. The information is used in tslib_cObj->IMGTEXT
        var $uniqueCounter=0;                           // Used to generate page-unique keys. Point is that uniqid() functions is very slow, so a unikey key is made based on this, see function uniqueHash()
        var $uniqueString='';
        var $indexedDocTitle='';                        // This value will be used as the title for the page in the indexer (if indexing happens)
        var $altPageTitle='';                           // Alternative page title (normally the title of the page record). Can be set from applications you make.
        var $pEncAllowedParamNames=array();     // An array that holds parameter names (keys) of GET parameters which MAY be MD5/base64 encoded with simulate_static_documents method.
        var $baseUrl='';                                        // The Base url set for the page header.
        var $anchorPrefix='';                           // The proper anchor prefix needed when using speaking urls. (only set if baseUrl is set)

                // Page content render object
        var $cObj ='';                                          // is instantiated object of tslib_cObj

                // CONTENT accumulation
        var $content='';                                        // All page content is accumulated in this variable. See pagegen.php

                // GENERAL
        var $clientInfo='';                                     // Set to the browser: net / msie if 4+ browsers
        var $scriptParseTime=0;
        var $TCAloaded = 0;                                     // Set ONLY if the full TCA is loaded

                // Character set (charset) conversion object:
        var $csConvObj;                                         // An instance of the "t3lib_cs" class. May be used by any application.
        var $defaultCharSet = 'iso-8859-1';     // The default charset used in the frontend if nothing else is set.
        var $renderCharset='';                          // Internal charset of the frontend during rendering: Defaults to "forceCharset" and if that is not set, to ->defaultCharSet
        var $metaCharset='';                            // Output charset of the websites content. This is the charset found in the header, meta tag etc. If different from $renderCharset a conversion happens before output to browser. Defaults to ->renderCharset if not set.
        var $localeCharset='';                          // Assumed charset of locale strings.

                // LANG:
        var $lang='';                                           // Set to the system language key (used on the site)
        var $langSplitIndex=0;                          // Set to the index number of the language key
        var $labelsCharset='';                          // Charset of the labels from locallang (based on $this->lang)
        var $convCharsetToFrom='';                      // Set to the charsets to convert from/to IF there are any difference. Otherwise this stays a string
        var $LL_labels_cache=array();
        var $LL_files_cache=array();





        function tslib_fe($TYPO3_CONF_VARS, $id, $type, $no_cache='', $cHash='', $jumpurl='',$MP='',$RDCT='')   {

                        // Setting some variables:
                $this->TYPO3_CONF_VARS = $TYPO3_CONF_VARS;
                $this->id = $id;
                $this->type = $type;
                $this->no_cache = $no_cache ? 1 : 0;
                $this->cHash = $cHash;
                $this->jumpurl = $jumpurl;
                $this->MP = $this->TYPO3_CONF_VARS['FE']['enable_mount_pids'] ? (string)$MP : '';
                $this->RDCT = $RDCT;
                $this->clientInfo = t3lib_div::clientInfo();
                $this->uniqueString=md5(microtime());

                $this->csConvObj = t3lib_div::makeInstance('t3lib_cs');

                        // Call post processing function for constructor:
                if (is_array($this->TYPO3_CONF_VARS['SC_OPTIONS']['tslib/class.tslib_fe.php']['tslib_fe-PostProc']))    {
                        $_params = array('pObj' => &$this);
                        foreach($this->TYPO3_CONF_VARS['SC_OPTIONS']['tslib/class.tslib_fe.php']['tslib_fe-PostProc'] as $_funcRef)     {
                                t3lib_div::callUserFunction($_funcRef,$_params,$this);
                        }
                }
        }

        function connectToMySQL()       {
          $this->connectToDB();
        }

        function connectToDB()  {
                if ($GLOBALS['TYPO3_DB']->sql_pconnect(TYPO3_db_host, TYPO3_db_username, TYPO3_db_password))    {
                        if (!TYPO3_db)  {
                                $this->printError('No database selected','Database Error');
                                        // Redirects to the Install Tool:
                                echo '<script type="text/javascript">
                                                /*<![CDATA[*/
                                        document.location = "'.TYPO3_mainDir.'install/index.php?mode=123&step=1&password=joh316";
                                                /*]]>*/
                                        </script>';
                                exit;
                        } elseif (!$GLOBALS['TYPO3_DB']->sql_select_db(TYPO3_db))       {
                                $this->printError('Cannot connect to the current database, "'.TYPO3_db.'"','Database Error');
                                exit;
                        }
                } else {
                        if (!TYPO3_db)  {
                                        // Redirects to the Install Tool:
                                echo '<script type="text/javascript">
                                                /*<![CDATA[*/
                                        document.location = "'.TYPO3_mainDir.'install/index.php?mode=123&step=1&password=joh316";
                                                /*]]>*/
                                        </script>';
                                exit;
                        }
                        $this->printError('The current username, password or host was not accepted when the connection to the database was attempted to be established!','Database Error');
                        exit;
                }


                        // Call post processing function for DB connection:
                if (is_array($this->TYPO3_CONF_VARS['SC_OPTIONS']['tslib/class.tslib_fe.php']['connectToDB']))  {
                        $_params = array('pObj' => &$this);
                        foreach($this->TYPO3_CONF_VARS['SC_OPTIONS']['tslib/class.tslib_fe.php']['connectToDB'] as $_funcRef)   {
                                t3lib_div::callUserFunction($_funcRef,$_params,$this);
                        }
                }
        }

        function sendRedirect() {
                $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery('params', 'cache_md5params', 'md5hash='.$GLOBALS['TYPO3_DB']->fullQuoteStr($this->RDCT, 'cache_md5params'));
                if ($row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res)) {
                        $this->updateMD5paramsRecord($this->RDCT);
                        header('Location: '.$row['params']);
                        exit;
                }
        }


















        /********************************************
         *
         * Initializing, resolving page id
         *
         ********************************************/


        function initFEuser()   {
                $this->fe_user = t3lib_div::makeInstance('tslib_feUserAuth');

                $this->fe_user->lockIP = $this->TYPO3_CONF_VARS['FE']['lockIP'];
                $this->fe_user->lockHashKeyWords = $this->TYPO3_CONF_VARS['FE']['lockHashKeyWords'];
                $this->fe_user->checkPid = $this->TYPO3_CONF_VARS['FE']['checkFeUserPid'];
                $this->fe_user->lifetime = intval($this->TYPO3_CONF_VARS['FE']['lifetime']);
                $this->fe_user->checkPid_value = $GLOBALS['TYPO3_DB']->cleanIntList(t3lib_div::_GP('pid'));     // List of pid's acceptable

                        // Check if a session is transferred:
                if (t3lib_div::_GP('FE_SESSION_KEY'))   {
                        $fe_sParts = explode('-',t3lib_div::_GP('FE_SESSION_KEY'));
                        if (!strcmp(md5($fe_sParts[0].'/'.$this->TYPO3_CONF_VARS['SYS']['encryptionKey']), $fe_sParts[1]))      {       // If the session key hash check is OK:
                                $_COOKIE[$this->fe_user->name] = $fe_sParts[0];
                                $this->fe_user->forceSetCookie = 1;
                        }
                }

                if ($this->TYPO3_CONF_VARS['FE']['dontSetCookie'])      {
                        $this->fe_user->dontSetCookie=1;
                }

                $this->fe_user->start();
                $this->fe_user->unpack_uc('');
                $this->fe_user->fetchSessionData();     // Gets session data
                $recs = t3lib_div::_GP('recs');
                if (is_array($recs))    {       // If any record registration is submitted, register the record.
                        $this->fe_user->record_registration($recs, $this->TYPO3_CONF_VARS['FE']['maxSessionDataSize']);
                }

                        // Call hook for possible manipulation of frontend user object
                if (is_array($this->TYPO3_CONF_VARS['SC_OPTIONS']['tslib/class.tslib_fe.php']['initFEuser']))   {
                        $_params = array('pObj' => &$this);
                        foreach($this->TYPO3_CONF_VARS['SC_OPTIONS']['tslib/class.tslib_fe.php']['initFEuser'] as $_funcRef)    {
                                t3lib_div::callUserFunction($_funcRef,$_params,$this);
                        }
                }

                        // For every 60 seconds the is_online timestamp is updated.
                if (is_array($this->fe_user->user) && $this->fe_user->user['uid'] && $this->fe_user->user['is_online']<($GLOBALS['EXEC_TIME']-60))      {
                        $GLOBALS['TYPO3_DB']->exec_UPDATEquery('fe_users', 'uid='.intval($this->fe_user->user['uid']), array('is_online' => $GLOBALS['EXEC_TIME']));
                }
        }

        function initUserGroups() {

                $this->fe_user->showHiddenRecords = $this->showHiddenRecords;           // This affects the hidden-flag selecting the fe_groups for the user!
                $this->fe_user->fetchGroupData();       // no matter if we have an active user we try to fetch matching groups which can be set without an user (simulation for instance!)

                if (is_array($this->fe_user->user) && count($this->fe_user->groupData['uid']))  {
                        $this->loginUser=1;     // global flag!
                        $this->gr_list = '0,-2';        // group -2 is not an existing group, but denotes a 'default' group when a user IS logged in. This is used to let elements be shown for all logged in users!
                        $gr_array = $this->fe_user->groupData['uid'];
                } else {
                        $this->loginUser=0;
                        $this->gr_list = '0,-1';        // group -1 is not an existing group, but denotes a 'default' group when not logged in. This is used to let elements be hidden, when a user is logged in!

                        if ($this->loginAllowedInBranch)        {
                                $gr_array = $this->fe_user->groupData['uid'];   // For cases where logins are not banned from a branch usergroups can be set based on IP masks so we should add the usergroups uids.
                        } else {
                                $gr_array = array();            // Set to blank since we will NOT risk any groups being set when no logins are allowed!
                        }
                }

                        // Clean up.
                $gr_array = array_unique($gr_array);    // Make unique...
                sort($gr_array);        // sort
                if (count($gr_array))   {
                        $this->gr_list.=','.implode(',',$gr_array);
                }

                if ($this->fe_user->writeDevLog)        t3lib_div::devLog('Valid usergroups for TSFE: '.$this->gr_list, 'tslib_fe');
        }

        function isUserOrGroupSet()     {
                return is_array($this->fe_user->user) || $this->gr_list!=='0,-1';
        }

        function checkAlternativeIdMethods()    {

                $this->siteScript = t3lib_div::getIndpEnv('TYPO3_SITE_SCRIPT');

                        // Resolving of "simulateStaticDocuments" URLs:
                if ($this->siteScript && substr($this->siteScript,0,9)!='index.php')    {               // If there has been a redirect (basically; we arrived here otherwise than via "index.php" in the URL) this can happend either due to a CGI-script or because of reWrite rule. Earlier we used $_SERVER['REDIRECT_URL'] to check but
                        $uParts = parse_url($this->siteScript); // Parse the path:
                        $fI = t3lib_div::split_fileref($uParts['path']);

                        if (!$fI['path'] && $fI['file'] && substr($fI['file'],-5)=='.html')     {
                                $parts = explode('.',$fI['file']);
                                $pCount = count($parts);
                                if ($pCount>2)  {
                                        $this->type = intval($parts[$pCount-2]);
                                        $this->id = $parts[$pCount-3];
                                } else {
                                        $this->type = 0;
                                        $this->id = $parts[0];
                                }
                        }
                }

                        // If PATH_INFO
                if (t3lib_div::getIndpEnv('PATH_INFO')) {               // If pathinfo contains stuff...
                        $parts=t3lib_div::trimExplode('/',t3lib_div::getIndpEnv('PATH_INFO'),1);
                        $parts[]='html';
                        $pCount = count($parts);
                        if ($pCount>2)  {
                                $this->type = intval($parts[$pCount-2]);
                                $this->id = $parts[$pCount-3];
                        } else {
                                $this->type = 0;
                                $this->id = $parts[0];
                        }
                        $this->absRefPrefix_force=1;
                }

                        // Call post processing function for custom URL methods.
                if (is_array($this->TYPO3_CONF_VARS['SC_OPTIONS']['tslib/class.tslib_fe.php']['checkAlternativeIdMethods-PostProc']))   {
                        $_params = array('pObj' => &$this);
                        foreach($this->TYPO3_CONF_VARS['SC_OPTIONS']['tslib/class.tslib_fe.php']['checkAlternativeIdMethods-PostProc'] as $_funcRef)    {
                                t3lib_div::callUserFunction($_funcRef,$_params,$this);
                        }
                }
        }

        function clear_preview()        {
                $this->showHiddenPage = 0;
                $this->showHiddenRecords = 0;
                $GLOBALS['SIM_EXEC_TIME'] = $GLOBALS['EXEC_TIME'];
                $this->fePreview = 0;
        }

        function determineId()  {

                        // Getting ARG-v values if some
                $this->setIDfromArgV();

                        // If there is a Backend login we are going to check for any preview settings:
                $GLOBALS['TT']->push('beUserLogin','');
                if ($this->beUserLogin) {
                        $this->fePreview = $GLOBALS['BE_USER']->extGetFeAdminValue('preview');

                                // If admin panel preview is enabled...
                        if ($this->fePreview)   {
                                $fe_user_OLD_USERGROUP = $this->fe_user->user['usergroup'];

                                $this->showHiddenPage = $GLOBALS['BE_USER']->extGetFeAdminValue('preview','showHiddenPages');
                                $this->showHiddenRecords = $GLOBALS['BE_USER']->extGetFeAdminValue('preview','showHiddenRecords');
                                        // simulate date
                                $simTime = $GLOBALS['BE_USER']->extGetFeAdminValue('preview','simulateDate');
                                if ($simTime)   $GLOBALS['SIM_EXEC_TIME']=$simTime;
                                        // simulate user
                                $simUserGroup = $GLOBALS['BE_USER']->extGetFeAdminValue('preview','simulateUserGroup');
                                $this->simUserGroup = $simUserGroup;
                                if ($simUserGroup)      $this->fe_user->user['usergroup']=$simUserGroup;
                                if (!$simUserGroup && !$simTime && !$this->showHiddenPage && !$this->showHiddenRecords) {
                                        $this->fePreview=0;
                                }
                        }

                                // Now it's investigated if the raw page-id points to a hidden page and if so, the flag is set.
                                // This does not require the preview flag to be set in the admin panel
                        if ($this->id)  {
                                $idQ = t3lib_div::testInt($this->id) ? 'uid='.intval($this->id) : 'alias='.$GLOBALS['TYPO3_DB']->fullQuoteStr($this->id, 'pages').' AND pid>=0';        // pid>=0 added for the sake of versioning...
                                $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery('hidden', 'pages', $idQ.' AND hidden!=0 AND deleted=0');
                                if ($GLOBALS['TYPO3_DB']->sql_num_rows($res))   {
                                        $this->fePreview = 1;   // The preview flag is set only if the current page turns out to actually be hidden!
                                        $this->showHiddenPage = 1;
                                }

                                        // Check root line for proper connection to tree root (done because of possible preview of page / branch versions)
                                if (!$this->fePreview)  {

                                                // Initialize the page-select functions to check rootline:
                                        $temp_sys_page = t3lib_div::makeInstance('t3lib_pageSelect');
                                        $temp_sys_page->init($this->showHiddenPage);

                                                // If root line contained NO records and ->error_getRootLine_failPid tells us that it was because of a pid=-1 (indicating a "version" record)...:
                                        if (!count($temp_sys_page->getRootLine($this->id,$this->MP)) && $temp_sys_page->error_getRootLine_failPid==-1)  {

                                                        // Setting versioningPreview flag and try again:
                                                $temp_sys_page->versioningPreview = TRUE;
                                                if (count($temp_sys_page->getRootLine($this->id,$this->MP)))    {
                                                                // Finally, we got a root line (meaning that it WAS due to versioning preview of a page somewhere) and we set the fePreview flag which in itself will allow sys_page class to display previews of versionized records.
                                                        $this->fePreview = 1;
#debug('version in rootline...');
                                                }
                                        }
                                }
                        }

                                // Checking for specific version preview of records:
                        if (is_array(t3lib_div::_GP('ADMCMD_vPrev')))   {
                                $this->fePreview = 1;
                                $this->versionPreviewMap = t3lib_div::_GP('ADMCMD_vPrev');
                        }

                        if ($this->fePreview)   {       // If the front-end is showing a preview, caching MUST be disabled.
                                $this->set_no_cache();
                        }
                }
                $GLOBALS['TT']->pull();

                        // Now, get the id, validate access etc:
                $this->fetch_the_id();

                        // Check if backend user has read access to this page. If not, recalculate the id.
                if ($this->beUserLogin && $this->fePreview)     {
                        if (!$GLOBALS['BE_USER']->doesUserHaveAccess($this->page,1))    {
                                        // Resetting
                                $this->clear_preview();
                                $this->fe_user->user['usergroup'] = $fe_user_OLD_USERGROUP;

                                        // Fetching the id again, now with the preview settings reset.
                                $this->fetch_the_id();
                        }
                }

                        // Checks if user logins are blocked for a certain branch and if so, will unset user login and re-fetch ID.
                $this->loginAllowedInBranch = $this->checkIfLoginAllowedInBranch();
                if (!$this->loginAllowedInBranch)       {       // Logins are not allowed:
                        if ($this->isUserOrGroupSet())  {       // Only if there is a login will we run this...

                                        // Clear out user and group:
                                unset($this->fe_user->user);
                                $this->gr_list = '0,-1';

                                        // Fetching the id again, now with the preview settings reset.
                                $this->fetch_the_id();
                        }
                }

                        // Final cleaning.
                $this->id = $this->contentPid = intval($this->id);      // Make sure it's an integer
                $this->type = intval($this->type);      // Make sure it's an integer

                        // Call post processing function for id determination:
                if (is_array($this->TYPO3_CONF_VARS['SC_OPTIONS']['tslib/class.tslib_fe.php']['determineId-PostProc'])) {
                        $_params = array('pObj' => &$this);
                        foreach($this->TYPO3_CONF_VARS['SC_OPTIONS']['tslib/class.tslib_fe.php']['determineId-PostProc'] as $_funcRef)  {
                                t3lib_div::callUserFunction($_funcRef,$_params,$this);
                        }
                }
        }

        function fetch_the_id() {
                $GLOBALS['TT']->push('fetch_the_id initialize/','');

                        // Initialize the page-select functions.
                $this->sys_page = t3lib_div::makeInstance('t3lib_pageSelect');
                $this->sys_page->init($this->showHiddenPage);
                $this->sys_page->versioningPreview = $this->fePreview ? TRUE : FALSE;
                if ($this->sys_page->versioningPreview) {
                        $this->sys_page->versionPreviewMap = $this->versionPreviewMap;
                }

                        // Set the valid usergroups for FE
                $this->initUserGroups();

                        // Sets sys_page where-clause
                $this->setSysPageWhereClause();

                        // Splitting $this->id by a period (.). First part is 'id' and second part - if exists - will overrule the &type param if given
                $pParts = explode('.',$this->id);
                $this->id = $pParts[0]; // Set it.
                if (isset($pParts[1]))  {$this->type=$pParts[1];}

                        // Splitting $this->id by a comma (,). First part is 'id' and other parts are just stored for use in scripts.
                $this->idParts = explode(',',$this->id);

                        // Splitting by a '+' sign - used for base64/md5 methods of parameter encryption for simulate static documents.
                list($pgID,$SSD_p)=explode('+',$this->idParts[0],2);
                if ($SSD_p)     {       $this->idPartsAnalyze($SSD_p);  }
                $this->id = $pgID;      // Set id

                        // If $this->id is a string, it's an alias
                $this->checkAndSetAlias();

                        // The id and type is set to the integer-value - just to be sure...
                $this->id = intval($this->id);
                $this->type = intval($this->type);
                $GLOBALS['TT']->pull();

                        // We find the first page belonging to the current domain
                $GLOBALS['TT']->push('fetch_the_id domain/','');
                $this->domainStartPage = $this->findDomainRecord($this->TYPO3_CONF_VARS['SYS']['recursiveDomainSearch']);       // the page_id of the current domain
                if (!$this->id) {
                        if ($this->domainStartPage)     {
                                $this->id = $this->domainStartPage;     // If the id was not previously set, set it to the id of the domain.
                        } else {
                                $theFirstPage = $this->sys_page->getFirstWebPage($this->id);    // Find the first 'visible' page in that domain
                                if ($theFirstPage)      {
                                        $this->id = $theFirstPage['uid'];
                                } else {
                                        $this->printError('No pages are found on the rootlevel!');
                                        exit;
                                }
                        }
                }
                $GLOBALS['TT']->pull();

                $GLOBALS['TT']->push('fetch_the_id rootLine/','');
                $requestedId = $this->id;               // We store the originally requested id
                $this->getPageAndRootlineWithDomain($this->domainStartPage);
                $GLOBALS['TT']->pull();

                if ($this->pageNotFound && $this->TYPO3_CONF_VARS['FE']['pageNotFound_handling'])       {
                        $pNotFoundMsg = array(
                                1 => 'ID was not an accessible page',
                                2 => 'Subsection was found and not accessible',
                                3 => 'ID was outside the domain',
                        );
                        $this->pageNotFoundAndExit($pNotFoundMsg[$this->pageNotFound]);
                }

                        // set no_cache if set
                if ($this->page['no_cache'])    {
                        $this->set_no_cache();
                }

                        // Init SYS_LASTCHANGED
                $this->register['SYS_LASTCHANGED'] = intval($this->page['tstamp']);
                if ($this->register['SYS_LASTCHANGED'] < intval($this->page['SYS_LASTCHANGED']))        {
                        $this->register['SYS_LASTCHANGED'] = intval($this->page['SYS_LASTCHANGED']);
                }
        }

        function getPageAndRootline() {
                $this->page = $this->sys_page->getPage($this->id);
                if (!count($this->page))        {
                                // If no page, we try to find the page before in the rootLine.
                        $this->pageNotFound=1;                  // Page is 'not found' in case the id itself was not an accessible page. code 1
                        $this->rootLine = $this->sys_page->getRootLine($this->id,$this->MP);
                        if (count($this->rootLine))     {
                                $c=count($this->rootLine)-1;
                                while($c>0)     {

                                                // Add to page access failure history:
                                        $this->pageAccessFailureHistory['direct_access'][] = $this->rootLine[$c];

                                                // Decrease to next page in rootline and check the access to that, if OK, set as page record and ID value.
                                        $c--;
                                        $this->id = $this->rootLine[$c]['uid'];
                                        $this->page = $this->sys_page->getPage($this->id);
                                        if (count($this->page)){ break; }
                                }
                        }
                                // If still no page...
                        if (!count($this->page))        {
                                if ($this->TYPO3_CONF_VARS['FE']['pageNotFound_handling'])      {
                                        $this->pageNotFoundAndExit('The requested page does not exist!');
                                } else {
                                        $this->printError('The requested page does not exist!');
                                        exit;
                                }
                        }
                }
                        // Is the ID a link to another page??
                if ($this->page['doktype']==4)  {
                        $this->MP = '';         // We need to clear MP if the page is a shortcut. Reason is if the short cut goes to another page, then we LEAVE the rootline which the MP expects.
                        $this->page = $this->getPageShortcut($this->page['shortcut'],$this->page['shortcut_mode'],$this->page['uid']);
                        $this->id = $this->page['uid'];
                }
                        // Gets the rootLine
                $this->rootLine = $this->sys_page->getRootLine($this->id,$this->MP);

                        // If not rootline we're off...
                if (!count($this->rootLine))    {
                        $this->printError('The requested page didn\'t have a proper connection to the tree-root! <br /><br />('.$this->sys_page->error_getRootLine.')');
                        exit;
                }

                        // Checking for include section regarding the hidden/starttime/endtime/fe_user (that is access control of a whole subbranch!)
                if ($this->checkRootlineForIncludeSection())    {
                        if (!count($this->rootLine))    {
                                $this->printError('The requested page was not accessible!');
                                exit;
                        } else {
                                $el = reset($this->rootLine);
                                $this->id = $el['uid'];
                                $this->page = $this->sys_page->getPage($this->id);
                                $this->rootLine = $this->sys_page->getRootLine($this->id,$this->MP);
                        }
                }
        }

        function getPageShortcut($SC,$mode,$thisUid,$itera=20,$pageLog=array()) {
                $idArray = t3lib_div::intExplode(',',$SC);

                        // Find $page record depending on shortcut mode:
                switch($mode)   {
                        case 1:
                        case 2:
                                $pageArray = $this->sys_page->getMenu($idArray[0]?$idArray[0]:$thisUid,'*','sorting','AND pages.doktype<199 AND pages.doktype!=6');
                                $pO = 0;
                                if ($mode==2 && count($pageArray))      {       // random
                                        $this->make_seed();
                                        $randval = intval(rand(0,count($pageArray)-1));
                                        $pO = $randval;
                                }
                                $c = 0;
                                reset($pageArray);
                                while(list(,$pV)=each($pageArray))      {
                                        if ($c==$pO)    {
                                                $page = $pV;
                                                break;
                                        }
                                        $c++;
                                }
                        break;
                        default:
                                $page = $this->sys_page->getPage($idArray[0]);
                        break;
                }

                        // Check if short cut page was a shortcut itself, if so look up recursively:
                if ($page['doktype']==4)        {
                        if (!in_array($page['uid'],$pageLog) && $itera>0)       {
                                $pageLog[] = $page['uid'];
                                $page = $this->getPageShortcut($page['shortcut'],$page['shortcut_mode'],$page['uid'],$itera-1,$pageLog);
                        } else {
                                $pageLog[] = $page['uid'];
                                $this->printError('Page shortcuts were looping in uids '.implode(',',$pageLog).'...!');
                                exit;
                        }
                }
                        // Return resulting page:
                return $page;
        }

        function checkRootlineForIncludeSection()       {
                $c=count($this->rootLine);
                $removeTheRestFlag=0;

                for ($a=0;$a<$c;$a++)   {
                        if (!$this->checkPagerecordForIncludeSection($this->rootLine[$a]))      {
                                        // Add to page access failure history:
                                $this->pageAccessFailureHistory['sub_section'][] = $this->rootLine[$a];
                                $removeTheRestFlag=1;
                        }
                        if ($this->rootLine[$a]['doktype']==6)  {
                                if ($this->beUserLogin) {       // If there is a backend user logged in, check if he has read access to the page:
                                        $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery('uid', 'pages', 'uid='.intval($this->id).' AND '.$GLOBALS['BE_USER']->getPagePermsClause(1));
                                        list($isPage) = $GLOBALS['TYPO3_DB']->sql_fetch_row($res);
                                        if (!$isPage)   $removeTheRestFlag=1;   // If there was no page selected, the user apparently did not have read access to the current PAGE (not position in rootline) and we set the remove-flag...
                                } else {        // Dont go here, if there is no backend user logged in.
                                        $removeTheRestFlag=1;
                                }
                        }
                        if ($removeTheRestFlag) {
                                $this->pageNotFound=2;                  // Page is 'not found' in case a subsection was found and not accessible, code 2
                                unset($this->rootLine[$a]);
                        }
                }
                return $removeTheRestFlag;
        }

        function checkEnableFields($row,$bypassGroupCheck=FALSE)        {
                if ((!$row['hidden'] || $this->showHiddenPage)
                        && $row['starttime']<=$GLOBALS['SIM_EXEC_TIME']
                        && ($row['endtime']==0 || $row['endtime']>$GLOBALS['SIM_EXEC_TIME'])
                        && ($bypassGroupCheck || $this->checkPageGroupAccess($row))
                ) { return TRUE; }
        }

        function checkPageGroupAccess($row, $groupList=NULL) {
                if(is_null($groupList)) {
                        $groupList = $this->gr_list;
                }
                if(!is_array($groupList)) {
                        $groupList = explode(',', $groupList);
                }
                $pageGroupList = explode(',', $row['fe_group']);
                return count(array_intersect($groupList, $pageGroupList)) > 0;
        }

        function checkPagerecordForIncludeSection($row) {
                return (!$row['extendToSubpages'] || $this->checkEnableFields($row)) ? 1 : 0;
        }

        function checkIfLoginAllowedInBranch()  {

                        // Initialize:
                $c = count($this->rootLine);
                $disable = FALSE;

                        // Traverse root line from root and outwards:
                for ($a=0; $a<$c; $a++) {

                                // If a value is set for login state:
                        if ($this->rootLine[$a]['fe_login_mode'] > 0)   {

                                        // Determine state from value:
                                $disable = (int)$this->rootLine[$a]['fe_login_mode'] === 1 ? TRUE : FALSE;
                        }
                }

                return !$disable;
        }

        function getPageAccessFailureReasons()  {
                $output = array();

                $combinedRecords = array_merge(
                        is_array($this->pageAccessFailureHistory['direct_access']) ? $this->pageAccessFailureHistory['direct_access'] : array(array('fe_group'=>0)),    // Adding fake first record for direct access if none, otherwise $k==0 below will be indicating a sub-section record to be first direct_access record which is of course false!
                        is_array($this->pageAccessFailureHistory['sub_section']) ? $this->pageAccessFailureHistory['sub_section'] : array()
                );

                if (count($combinedRecords))    {
                        foreach($combinedRecords as $k => $pagerec)     {
                                // If $k=0 then it is the very first page the original ID was pointing at and that will get a full check of course
                                // If $k>0 it is parent pages being tested. They are only significant for the access to the first page IF they had the extendToSubpages flag set, hence checked only then!
                                if (!$k || $pagerec['extendToSubpages'])        {
                                        if ($pagerec['hidden']) $output['hidden'][$pagerec['uid']] = TRUE;
                                        if ($pagerec['starttime'] > $GLOBALS['SIM_EXEC_TIME'])  $output['starttime'][$pagerec['uid']] = $pagerec['starttime'];
                                        if ($pagerec['endtime']!=0 && $pagerec['endtime'] <= $GLOBALS['SIM_EXEC_TIME']) $output['endtime'][$pagerec['uid']] = $pagerec['endtime'];
                                        if (!$this->checkPageGroupAccess($pagerec))     $output['fe_group'][$pagerec['uid']] = $pagerec['fe_group'];
                                }
                        }
                }

                return $output;
        }

        function setIDfromArgV()        {
                if (!$this->id) {
                        list($theAlias) = explode('&',t3lib_div::getIndpEnv('QUERY_STRING'));
                        $theAlias = trim($theAlias);
                        $this->id = $theAlias ? $theAlias : 0;
                }
        }

        function getPageAndRootlineWithDomain($domainStartPage) {
                $this->getPageAndRootline();

                // Checks if the $domain-startpage is in the rootLine. This is necessary so that references to page-id's from other domains are not possible.
                if ($domainStartPage && is_array($this->rootLine)) {
                        reset ($this->rootLine);
                        $idFound = 0;
                        while(list($key,$val)=each($this->rootLine)) {
                                if ($val['uid']==$domainStartPage)      {
                                        $idFound=1;
                                        break;
                                }
                        }
                        if (!$idFound)  {
                                $this->pageNotFound=3;                  // Page is 'not found' in case the id was outside the domain, code 3
                                $this->id = $domainStartPage;
                                $this->getPageAndRootline();            //re-get the page and rootline if the id was not found.
                        }
                }
        }

        function setSysPageWhereClause() {
                $this->sys_page->where_hid_del.=' AND doktype<200';
                $this->sys_page->where_groupAccess = $this->getPagesGroupClause();
        }

        function getPagesGroupClause() {
                return ' AND fe_group IN ('.$this->gr_list.')';
        }

        function findDomainRecord($recursive=0) {
                if ($recursive) {
                        $host = explode('.',t3lib_div::getIndpEnv('HTTP_HOST'));
                        while(count($host))     {
                                $pageUid = $this->sys_page->getDomainStartPage(implode('.',$host),t3lib_div::getIndpEnv('SCRIPT_NAME'),t3lib_div::getIndpEnv('REQUEST_URI'));
                                if ($pageUid)   return $pageUid; else array_shift($host);
                        }
                        return $pageUid;
                } else {
                        return $this->sys_page->getDomainStartPage(t3lib_div::getIndpEnv('HTTP_HOST'),t3lib_div::getIndpEnv('SCRIPT_NAME'),t3lib_div::getIndpEnv('REQUEST_URI'));
                }
        }

        function pageNotFoundAndExit($reason='')        {
                $this->pageNotFoundHandler($this->TYPO3_CONF_VARS['FE']['pageNotFound_handling'], $this->TYPO3_CONF_VARS['FE']['pageNotFound_handling_statheader'], $reason);
                exit;
        }

        function pageNotFoundHandler($code, $header='', $reason='')     {
                        // Issue header in any case:
                if ($header)    {header($header);}

                        // Create response:
                if (gettype($code)=='boolean' || !strcmp($code,1))      {       // Simply boolean; Just shows TYPO3 error page with reason:
                        $this->printError('The page did not exist or was inaccessible.'.($reason ? ' Reason: '.htmlspecialchars($reason) : ''));
                        exit;
                } elseif (t3lib_div::isFirstPartOfStr($code,'USER_FUNCTION:')) {
                        $funcRef = trim(substr($code,14));
                        $params = array(
                                'currentUrl' => t3lib_div::getIndpEnv('REQUEST_URI'),
                                'reasonText' => $reason,
                                'pageAccessFailureReasons' => $this->getPageAccessFailureReasons()
                        );
                        echo t3lib_div::callUserFunction($funcRef,$params,$this);
                        exit;
                } elseif (t3lib_div::isFirstPartOfStr($code,'READFILE:')) {
                        $readFile = t3lib_div::getFileAbsFileName(trim(substr($code,9)));
                        if (@is_file($readFile))        {
                                $fileContent = t3lib_div::getUrl($readFile);
                                $fileContent = str_replace('###CURRENT_URL###', t3lib_div::getIndpEnv('REQUEST_URI'), $fileContent);
                                $fileContent = str_replace('###REASON###', htmlspecialchars($reason), $fileContent);
                                echo $fileContent;
                        } else {
                                $this->printError('Configuration Error: 404 page "'.$readFile.'" could not be found.');
                        }
                        exit;
                } elseif (strlen($code)) {
                        header('Location: '.t3lib_div::locationHeaderUrl($code));
                        exit;
                } else {
                        $this->printError('Error.'.($reason ? ' Reason: '.htmlspecialchars($reason) : ''));
                        exit;
                }
        }

        function checkAndSetAlias()     {
                if ($this->id && !t3lib_div::testInt($this->id))        {
                        $aid = $this->sys_page->getPageIdFromAlias($this->id);
                        if ($aid)       {$this->id=$aid;}
                }
        }

        function idPartsAnalyze($str)   {
                $GET_VARS = '';
                switch(substr($str,0,2))        {
                        case 'B6':
                                $addParams = base64_decode(str_replace('_','=',str_replace('-','/',substr($str,2))));
                                parse_str($addParams,$GET_VARS);
                        break;
                        case 'M5':
                                $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery('params', 'cache_md5params', 'md5hash='.$GLOBALS['TYPO3_DB']->fullQuoteStr(substr($str,2), 'cache_md5params'));
                                $row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res);

                                $this->updateMD5paramsRecord(substr($str,2));
                                parse_str($row['params'],$GET_VARS);
                        break;
                }

                $this->mergingWithGetVars($GET_VARS);
        }

        function mergingWithGetVars($GET_VARS)  {
                if (is_array($GET_VARS))        {
                        $realGet = t3lib_div::_GET();           // Getting $_GET var, unescaped.
                        if (!is_array($realGet))        $realGet = array();

                                // Merge new values on top:
                        $realGet = t3lib_div::array_merge_recursive_overrule($realGet,$GET_VARS);

                                // Write values back to $_GET:
                        t3lib_div::_GETset($realGet);

                                // Setting these specifically (like in the init-function):
                        if (isset($GET_VARS['type']))           $this->type = intval($GET_VARS['type']);
                        if (isset($GET_VARS['cHash']))          $this->cHash = $GET_VARS['cHash'];
                        if (isset($GET_VARS['jumpurl']))        $this->jumpurl = $GET_VARS['jumpurl'];
                        if (isset($GET_VARS['MP']))                     $this->MP = $this->TYPO3_CONF_VARS['FE']['enable_mount_pids'] ? $GET_VARS['MP'] : '';

                        if (isset($GET_VARS['no_cache']) && $GET_VARS['no_cache'])      $this->set_no_cache();
                }
        }

















        /********************************************
         *
         * Template and caching related functions.
         *
         *******************************************/

        function makeCacheHash()        {
                $GET = t3lib_div::_GET();
                if ($this->cHash && is_array($GET))     {
                        $this->cHash_array = t3lib_div::cHashParams(t3lib_div::implodeArrayForUrl('',$GET));
                        $cHash_calc = t3lib_div::shortMD5(serialize($this->cHash_array));

                        if ($cHash_calc!=$this->cHash)  {
                                if ($this->TYPO3_CONF_VARS['FE']['pageNotFoundOnCHashError']) {