2 namespace TYPO3\CMS\Frontend\Controller
;
4 /***************************************************************
7 * (c) 1999-2013 Kasper Skårhøj (kasperYYYY@typo3.com)
10 * This script is part of the TYPO3 project. The TYPO3 project is
11 * free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
16 * The GNU General Public License can be found at
17 * http://www.gnu.org/copyleft/gpl.html.
18 * A copy is found in the textfile GPL.txt and important notices to the license
19 * from the author is found in LICENSE.txt distributed with these scripts.
22 * This script is distributed in the hope that it will be useful,
23 * but WITHOUT ANY WARRANTY; without even the implied warranty of
24 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
25 * GNU General Public License for more details.
27 * This copyright notice MUST APPEAR in all copies of the script!
28 ***************************************************************/
31 * Class for the built TypoScript based Front End. Instantiated in
32 * index_ts.php script as the global object TSFE
33 * Main frontend class, instantiated in the index_ts.php script as the global object TSFE
35 * This class has a lot of functions and internal variable which are use from index_ts.php.
36 * The class is instantiated as $GLOBALS['TSFE'] in index_ts.php.
37 * The use of this class should be inspired by the order of function calls as found in index_ts.php.
39 * Revised for TYPO3 3.6 June/2003 by Kasper Skårhøj
42 * @author Kasper Skårhøj <kasperYYYY@typo3.com>
44 class TypoScriptFrontendController
{
49 * @todo Define visibility
55 * @todo Define visibility
59 // Loaded with the id, exploded by ','
61 * @todo Define visibility
63 public $idParts = array();
65 // The submitted cHash
67 * @todo Define visibility
71 // Page will not be cached. Write only TRUE. Never clear value (some other code might have reasons to set it TRUE)
73 * @todo Define visibility
75 public $no_cache = '';
77 // The rootLine (all the way to tree root, not only the current site!) (array)
79 * @todo Define visibility
81 public $rootLine = '';
83 // The pagerecord (array)
85 * @todo Define visibility
89 // 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.
91 * @todo Define visibility
93 public $contentPid = 0;
95 // Gets set when we are processing a page of type shortcut in the early stages opf init.php when we do not know about languages yet, used later in init.php to determine the correct shortcut in case a translation changes the shortcut target (array)
96 protected $originalShortcutPage = NULL;
99 * sys_page-object, pagefunctions
101 * @var \TYPO3\CMS\Frontend\Page\PageRepository
102 * @todo Define visibility
104 public $sys_page = '';
107 * @todo Define visibility
109 public $jumpurl = '';
111 // Is set to 1 if a pageNotFound handler could have been called.
113 * @todo Define visibility
115 public $pageNotFound = 0;
119 * @todo Define visibility
121 public $domainStartPage = 0;
123 // Array containing a history of why a requested page was not accessible.
125 * @todo Define visibility
127 public $pageAccessFailureHistory = array();
130 * @todo Define visibility
135 * @todo Define visibility
139 // 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...
141 * @todo Define visibility
143 public $page_cache_reg1 = 0;
145 // 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.
147 * @todo Define visibility
149 public $siteScript = '';
154 * @var \TYPO3\CMS\Frontend\Authentication\FrontendUserAuthentication
155 * @todo Define visibility
157 public $fe_user = '';
159 // Global flag 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.
161 * @todo Define visibility
163 public $loginUser = '';
165 // (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...
167 * @todo Define visibility
169 public $gr_list = '';
171 // Flag that indicates if a Backend user is logged in!
173 * @todo Define visibility
175 public $beUserLogin = '';
177 // Integer, that indicates which workspace is being previewed.
179 * @todo Define visibility
181 public $workspacePreview = 0;
183 // Shows whether logins are allowed in branch
185 * @todo Define visibility
187 public $loginAllowedInBranch = TRUE;
189 // Shows specific mode (all or groups)
191 * @todo Define visibility
193 public $loginAllowedInBranch_mode = '';
195 // Integer, set to backend user ID to initialize when keyword-based preview is used.
197 * @todo Define visibility
199 public $ADMCMD_preview_BEUSER_uid = 0;
202 // 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. A value of 1 means ordinary preview, 2 means preview of a non-live workspace
204 * @todo Define visibility
206 public $fePreview = '';
208 // Flag indicating that hidden pages should be shown, selected and so on. This goes for almost all selection of pages!
210 * @todo Define visibility
212 public $showHiddenPage = '';
214 // 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.
216 * @todo Define visibility
218 public $showHiddenRecords = '';
220 // Value that contains the simulated usergroup if any
222 * @todo Define visibility
224 public $simUserGroup = '0';
228 * Copy of $GLOBALS['TYPO3_CONF_VARS']
232 public $TYPO3_CONF_VARS = array();
234 // "CONFIG" object from TypoScript. Array generated based on the TypoScript configuration of the current page. Saved with the cached pages.
236 * @todo Define visibility
242 * The TypoScript template object. Used to parse the TypoScript template
244 * @var \TYPO3\CMS\Core\TypoScript\TemplateService
245 * @todo Define visibility
249 // Is set to the time-to-live time of cached pages. If FALSE, default is 60*60*24, which is 24 hours.
251 * @todo Define visibility
253 public $cacheTimeOutDefault = FALSE;
255 // Set internally if cached content is fetched from the database
257 * @todo Define visibility
259 public $cacheContentFlag = 0;
261 // Set to the expire time of cached content
263 * @todo Define visibility
265 public $cacheExpires = 0;
267 // Set if cache headers allowing caching are sent.
269 * @todo Define visibility
271 public $isClientCachable = FALSE;
273 // $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.
275 * @todo Define visibility
279 // toplevel - objArrayName, eg 'page'
281 * @todo Define visibility
285 // TypoScript configuration of the page-object pointed to by sPre. $this->tmpl->setup[$this->sPre.'.']
287 * @todo Define visibility
291 // 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
293 * @todo Define visibility
295 public $newHash = '';
297 // 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
299 * @todo Define visibility
301 public $getMethodUrlIdToken = '';
303 // 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.
305 * @todo Define visibility
307 public $no_cacheBeforePageGen = '';
309 // This flag indicates if temporary content went into the cache during page-generation.
311 * @todo Define visibility
313 public $tempContent = FALSE;
315 // Boolean, passed to TypoScript template class and tells it to render the template forcibly
317 * @todo Define visibility
319 public $forceTemplateParsing = '';
321 // The array which cHash_calc is based on, see ->makeCacheHash().
323 * @todo Define visibility
325 public $cHash_array = array();
327 // Loaded with the serialized array that is used for generating a hashstring for the cache
329 * @todo Define visibility
331 public $hash_base = '';
333 // May be set to the pagesTSconfig
335 * @todo Define visibility
337 public $pagesTSconfig = '';
339 // PAGE-GENERATION / cOBJ
341 Eg. insert JS-functions in this array ($additionalHeaderData) to include them once. Use associative keys.
343 JSFormValidate : <script type="text/javascript" src="'.$GLOBALS["TSFE"]->absRefPrefix.'typo3/sysext/frontend/Resources/Public/JavaScript/jsfunc.validateform.js"></script>
344 JSincludeFormupdate : <script type="text/javascript" src="typo3/js/jsfunc.updateform.js"></script>
345 JSMenuCode, JSMenuCode_menu : JavaScript for the JavaScript menu
349 // 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[] = '...')
351 * @todo Define visibility
353 public $additionalHeaderData = array();
355 // used to accumulate additional HTML-code for the footer-section of the template
356 public $additionalFooterData = array();
358 // used to accumulate additional JavaScript-code. Works like additionalHeaderData. Reserved keys at 'openPic' and 'mouseOver'
360 * @todo Define visibility
362 public $additionalJavaScript = array();
364 // used to accumulate additional Style code. Works like additionalHeaderData.
366 * @todo Define visibility
368 public $additionalCSS = array();
370 // 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
372 * @todo Define visibility
374 public $JSeventFuncCalls = array(
375 'onmousemove' => array(),
376 'onmouseup' => array(),
377 'onkeydown' => array(),
378 'onkeyup' => array(),
379 'onkeypress' => array(),
381 'onunload' => array()
384 // Used to accumulate JavaScript loaded images (by menus)
386 * @todo Define visibility
388 public $JSImgCode = '';
390 // Used to accumulate DHTML-layers.
392 * @todo Define visibility
394 public $divSection = '';
396 // Default bodytag, if nothing else is set. This can be overridden by applications like TemplaVoila.
398 * @todo Define visibility
400 public $defaultBodyTag = '<body>';
402 // RENDERING configuration, settings from TypoScript is loaded into these vars. See pagegen.php
403 // Debug flag, may output special debug html-code.
405 * @todo Define visibility
409 // Default internal target
411 * @todo Define visibility
413 public $intTarget = '';
415 // Default external target
417 * @todo Define visibility
419 public $extTarget = '';
421 // Default file link target
423 * @todo Define visibility
425 public $fileTarget = '';
427 // Keys are page ids and values are default &MP (mount point) values to set when using the linking features...)
429 * @todo Define visibility
431 public $MP_defaults = array();
433 // If set, typolink() function encrypts email addresses. Is set in pagegen-class.
435 * @todo Define visibility
437 public $spamProtectEmailAddresses = 0;
439 // Absolute Reference prefix
441 * @todo Define visibility
443 public $absRefPrefix = '';
445 // 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 '/'
447 * @todo Define visibility
449 public $absRefPrefix_force = 0;
451 // Factor for form-field widths compensation
453 * @todo Define visibility
455 public $compensateFieldWidth = '';
459 * @todo Define visibility
461 public $lockFilePath = '';
463 // <A>-tag parameters
465 * @todo Define visibility
467 public $ATagParams = '';
469 // 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.
471 * @todo Define visibility
473 public $sWordRegEx = '';
475 // Is set to the incoming array sword_list in case of a page-view jumped to from a search-result.
477 * @todo Define visibility
479 public $sWordList = '';
481 // 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.
483 * @todo Define visibility
485 public $linkVars = '';
487 // 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.
489 * @todo Define visibility
491 public $excludeCHashVars = '';
493 // 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.
495 * @todo Define visibility
497 public $displayEditIcons = '';
499 // 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.
501 * @todo Define visibility
503 public $displayFieldEditIcons = '';
505 // Site language, 0 (zero) is default, int+ is uid pointing to a sys_language record. Should reflect which language menus, templates etc is displayed in (master language) - but not necessarily the content which could be falling back to default (see sys_language_content)
507 * @todo Define visibility
509 public $sys_language_uid = 0;
511 // Site language mode for content fall back.
513 * @todo Define visibility
515 public $sys_language_mode = '';
517 // Site content selection uid (can be different from sys_language_uid if content is to be selected from a fall-back language. Depends on sys_language_mode)
519 * @todo Define visibility
521 public $sys_language_content = 0;
523 // 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...]
525 * @todo Define visibility
527 public $sys_language_contentOL = 0;
529 // 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")
531 * @todo Define visibility
533 public $sys_language_isocode = '';
536 // 'Global' Storage for various applications. Keys should be 'tx_'.extKey for extensions.
538 * @todo Define visibility
540 public $applicationData = array();
543 * @todo Define visibility
545 public $register = array();
547 // Stack used for storing array and retrieving register arrays (see LOAD_REGISTER and RESTORE_REGISTER)
549 * @todo Define visibility
551 public $registerStack = array();
553 // Checking that the function is not called eternally. This is done by interrupting at a depth of 50
555 * @todo Define visibility
557 public $cObjectDepthCounter = 50;
559 // used by cObj->RECORDS and cObj->CONTENT to ensure the a records is NOT rendered twice through it!
561 * @todo Define visibility
563 public $recordRegister = array();
565 // This is set to the [table]:[uid] of the latest record rendered. Note that class ContentObjectRenderer has an equal value, but that is pointing to the record delivered in the $data-array of the ContentObjectRenderer instance, if the cObjects CONTENT or RECORD created that instance
567 * @todo Define visibility
569 public $currentRecord = '';
571 // Used by class \TYPO3\CMS\Frontend\ContentObject\Menu\AbstractMenuContentObject to keep track of access-keys.
573 * @todo Define visibility
575 public $accessKey = array();
577 // Numerical array where image filenames are added if they are referenced in the rendered document. This includes only TYPO3 generated/inserted images.
579 * @todo Define visibility
581 public $imagesOnPage = array();
583 // Is set in ContentObjectRenderer->cImage() function to the info-array of the most recent rendered image. The information is used in ContentObjectRenderer->IMGTEXT
585 * @todo Define visibility
587 public $lastImageInfo = array();
589 // 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()
591 * @todo Define visibility
593 public $uniqueCounter = 0;
596 * @todo Define visibility
598 public $uniqueString = '';
600 // This value will be used as the title for the page in the indexer (if indexing happens)
602 * @todo Define visibility
604 public $indexedDocTitle = '';
606 // Alternative page title (normally the title of the page record). Can be set from applications you make.
608 * @todo Define visibility
610 public $altPageTitle = '';
612 // The base URL set for the page header.
614 * @todo Define visibility
616 public $baseUrl = '';
618 // The proper anchor prefix needed when using speaking urls. (only set if baseUrl is set)
620 * @todo Define visibility
622 public $anchorPrefix = '';
625 * Page content render object
627 * @var \TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer
628 * @todo Define visibility
632 // CONTENT accumulation
633 // All page content is accumulated in this variable. See pagegen.php
635 * @todo Define visibility
637 public $content = '';
640 // Set to the browser: net / msie if 4+ browsers
642 * @todo Define visibility
644 public $clientInfo = '';
647 * @todo Define visibility
649 public $scriptParseTime = 0;
651 // Character set (charset) conversion object:
653 * charset conversion class. May be used by any application.
655 * @var \TYPO3\CMS\Core\Charset\CharsetConverter
656 * @todo Define visibility
660 // The default charset used in the frontend if nothing else is set.
662 * @todo Define visibility
664 public $defaultCharSet = 'utf-8';
666 // Internal charset of the frontend during rendering. (Default: UTF-8)
668 * @todo Define visibility
670 public $renderCharset = '';
672 // 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.
674 * @todo Define visibility
676 public $metaCharset = '';
678 // Assumed charset of locale strings.
680 * @todo Define visibility
682 public $localeCharset = '';
685 // Set to the system language key (used on the site)
687 * @todo Define visibility
692 * @todo Define visibility
694 public $LL_labels_cache = array();
697 * @todo Define visibility
699 public $LL_files_cache = array();
702 * List of language dependencies for actual language. This is used for local variants of a language
703 * that depend on their "main" language, like Brazilian Portuguese or Canadian French.
707 protected $languageDependencies = array();
710 * Locking object for accessing "cache_pagesection"
712 * @var \TYPO3\CMS\Core\Locking\Locker
713 * @todo Define visibility
715 public $pagesection_lockObj;
718 * Locking object for accessing "cache_pages"
720 * @var \TYPO3\CMS\Core\Locking\Locker
721 * @todo Define visibility
723 public $pages_lockObj;
726 * @var \TYPO3\CMS\Core\Page\PageRenderer
728 protected $pageRenderer;
731 * The page cache object, use this to save pages to the cache and to
732 * retrieve them again
734 * @var \TYPO3\CMS\Cache\Backend\AbstractBackend
736 protected $pageCache;
738 protected $pageCacheTags = array();
741 * @var \TYPO3\CMS\Frontend\Page\CacheHashCalculator The cHash Service class used for cHash related functionality
743 protected $cacheHash;
747 * Takes a number of GET/POST input variable as arguments and stores them internally.
748 * The processing of these variables goes on later in this class.
749 * Also sets internal clientInfo array (browser information) and a unique string (->uniqueString) for this script instance; A md5 hash of the microtime()
751 * @param array $TYPO3_CONF_VARS The global $TYPO3_CONF_VARS array. Will be set internally in ->TYPO3_CONF_VARS
752 * @param mixed $id The value of \TYPO3\CMS\Core\Utility\GeneralUtility::_GP('id')
753 * @param integer $type The value of \TYPO3\CMS\Core\Utility\GeneralUtility::_GP('type')
754 * @param boolean $no_cache The value of \TYPO3\CMS\Core\Utility\GeneralUtility::_GP('no_cache'), evaluated to 1/0
755 * @param string $cHash The value of \TYPO3\CMS\Core\Utility\GeneralUtility::_GP('cHash')
756 * @param string $jumpurl The value of \TYPO3\CMS\Core\Utility\GeneralUtility::_GP('jumpurl')
757 * @param string $MP The value of \TYPO3\CMS\Core\Utility\GeneralUtility::_GP('MP')
758 * @param string $RDCT The value of \TYPO3\CMS\Core\Utility\GeneralUtility::_GP('RDCT')
760 * @todo Define visibility
762 public function __construct($TYPO3_CONF_VARS, $id, $type, $no_cache = '', $cHash = '', $jumpurl = '', $MP = '', $RDCT = '') {
763 // Setting some variables:
764 $this->TYPO3_CONF_VARS
= $TYPO3_CONF_VARS;
768 if ($this->TYPO3_CONF_VARS
['FE']['disableNoCacheParameter']) {
769 $warning = '&no_cache=1 has been ignored because $TYPO3_CONF_VARS[\'FE\'][\'disableNoCacheParameter\'] is set!';
770 $GLOBALS['TT']->setTSlogMessage($warning, 2);
772 $warning = '&no_cache=1 has been supplied, so caching is disabled! URL: "' . \TYPO3\CMS\Core\Utility\GeneralUtility
::getIndpEnv('TYPO3_REQUEST_URL') . '"';
773 $this->disableCache();
775 \TYPO3\CMS\Core\Utility\GeneralUtility
::sysLog($warning, 'cms', \TYPO3\CMS\Core\Utility\GeneralUtility
::SYSLOG_SEVERITY_WARNING
);
777 $this->cHash
= $cHash;
778 $this->jumpurl
= $jumpurl;
779 $this->MP
= $this->TYPO3_CONF_VARS
['FE']['enable_mount_pids'] ?
(string) $MP : '';
781 $this->clientInfo
= \TYPO3\CMS\Core\Utility\GeneralUtility
::clientInfo();
782 $this->uniqueString
= md5(microtime());
783 $this->csConvObj
= \TYPO3\CMS\Core\Utility\GeneralUtility
::makeInstance('TYPO3\\CMS\\Core\\Charset\\CharsetConverter');
784 // Call post processing function for constructor:
785 if (is_array($this->TYPO3_CONF_VARS
['SC_OPTIONS']['tslib/class.tslib_fe.php']['tslib_fe-PostProc'])) {
786 $_params = array('pObj' => &$this);
787 foreach ($this->TYPO3_CONF_VARS
['SC_OPTIONS']['tslib/class.tslib_fe.php']['tslib_fe-PostProc'] as $_funcRef) {
788 \TYPO3\CMS\Core\Utility\GeneralUtility
::callUserFunction($_funcRef, $_params, $this);
791 $this->cacheHash
= \TYPO3\CMS\Core\Utility\GeneralUtility
::makeInstance('TYPO3\\CMS\\Frontend\\Page\\CacheHashCalculator');
796 * Connect to SQL database. May exit after outputting an error message
797 * or some JavaScript redirecting to the install tool.
799 * @throws \RuntimeException
800 * @throws \TYPO3\CMS\Core\Error\Http\ServiceUnavailableException
803 public function connectToDB() {
805 $GLOBALS['TYPO3_DB']->connectDB();
806 } catch (\RuntimeException
$exception) {
807 switch ($exception->getCode()) {
809 // Cannot connect to current database
810 $message = 'Cannot connect to the configured database "' . TYPO3_db
. '"';
811 if ($this->checkPageUnavailableHandler()) {
812 $this->pageUnavailableAndExit($message);
814 \TYPO3\CMS\Core\Utility\GeneralUtility
::sysLog($message, 'cms', \TYPO3\CMS\Core\Utility\GeneralUtility
::SYSLOG_SEVERITY_ERROR
);
815 throw new \TYPO3\CMS\Core\Error\Http\
ServiceUnavailableException($message, 1301648782);
819 // Username / password not accepted
820 $message = 'The current username, password or host was not accepted when' . ' the connection to the database was attempted to be established!';
821 if ($this->checkPageUnavailableHandler()) {
822 $this->pageUnavailableAndExit($message);
824 \TYPO3\CMS\Core\Utility\GeneralUtility
::sysLog($message, 'cms', \TYPO3\CMS\Core\Utility\GeneralUtility
::SYSLOG_SEVERITY_ERROR
);
825 throw new \TYPO3\CMS\Core\Error\Http\
ServiceUnavailableException('Database Error: ' . $message, 1301648945);
832 // Call post processing function for DB connection:
833 if (is_array($this->TYPO3_CONF_VARS
['SC_OPTIONS']['tslib/class.tslib_fe.php']['connectToDB'])) {
834 $_params = array('pObj' => &$this);
835 foreach ($this->TYPO3_CONF_VARS
['SC_OPTIONS']['tslib/class.tslib_fe.php']['connectToDB'] as $_funcRef) {
836 \TYPO3\CMS\Core\Utility\GeneralUtility
::callUserFunction($_funcRef, $_params, $this);
842 * Looks up the value of $this->RDCT in the database and if it is
843 * found to be associated with a redirect URL then the redirection
844 * is carried out with a 'Location:' header
845 * May exit after sending a location-header.
849 public function sendRedirect() {
851 $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery('params', 'cache_md5params', 'md5hash=' . $GLOBALS['TYPO3_DB']->fullQuoteStr($this->RDCT
, 'cache_md5params'));
852 if ($row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res)) {
853 $this->updateMD5paramsRecord($this->RDCT
);
854 header('Location: ' . $row['params']);
861 * Gets instance of PageRenderer
863 * @return \TYPO3\CMS\Core\Page\PageRenderer
865 public function getPageRenderer() {
866 if (!isset($this->pageRenderer
)) {
867 $this->pageRenderer
= \TYPO3\CMS\Core\Utility\GeneralUtility
::makeInstance('TYPO3\\CMS\\Core\\Page\\PageRenderer');
868 $this->pageRenderer
->setTemplateFile(PATH_tslib
. 'templates/tslib_page_frontend.html');
869 $this->pageRenderer
->setBackPath(TYPO3_mainDir
);
871 return $this->pageRenderer
;
875 * This is needed for USER_INT processing
877 * @param \TYPO3\CMS\Core\Page\PageRenderer $pageRenderer
879 protected function setPageRenderer(\TYPO3\CMS\Core\Page\PageRenderer
$pageRenderer) {
880 $this->pageRenderer
= $pageRenderer;
883 /********************************************
885 * Initializing, resolving page id
887 ********************************************/
889 * Initializes the caching system.
893 protected function initCaches() {
894 $this->pageCache
= $GLOBALS['typo3CacheManager']->getCache('cache_pages');
898 * Initializes the front-end login user.
901 * @todo Define visibility
903 public function initFEuser() {
904 $this->fe_user
= \TYPO3\CMS\Core\Utility\GeneralUtility
::makeInstance('TYPO3\\CMS\\Frontend\\Authentication\\FrontendUserAuthentication');
905 $this->fe_user
->lockIP
= $this->TYPO3_CONF_VARS
['FE']['lockIP'];
906 $this->fe_user
->checkPid
= $this->TYPO3_CONF_VARS
['FE']['checkFeUserPid'];
907 $this->fe_user
->lifetime
= intval($this->TYPO3_CONF_VARS
['FE']['lifetime']);
908 // List of pid's acceptable
909 $this->fe_user
->checkPid_value
= $GLOBALS['TYPO3_DB']->cleanIntList(\TYPO3\CMS\Core\Utility\GeneralUtility
::_GP('pid'));
910 // Check if a session is transferred:
911 if (\TYPO3\CMS\Core\Utility\GeneralUtility
::_GP('FE_SESSION_KEY')) {
912 $fe_sParts = explode('-', \TYPO3\CMS\Core\Utility\GeneralUtility
::_GP('FE_SESSION_KEY'));
913 // If the session key hash check is OK:
914 if (!strcmp(md5(($fe_sParts[0] . '/' . $this->TYPO3_CONF_VARS
['SYS']['encryptionKey'])), $fe_sParts[1])) {
915 $cookieName = \TYPO3\CMS\Frontend\Authentication\FrontendUserAuthentication
::getCookieName();
916 $_COOKIE[$cookieName] = $fe_sParts[0];
917 if (isset($_SERVER['HTTP_COOKIE'])) {
918 // See http://forge.typo3.org/issues/27740
919 $_SERVER['HTTP_COOKIE'] .= ';' . $cookieName . '=' . $fe_sParts[0];
921 $this->fe_user
->forceSetCookie
= 1;
925 if ($this->TYPO3_CONF_VARS
['FE']['dontSetCookie']) {
926 $this->fe_user
->dontSetCookie
= 1;
928 $this->fe_user
->start();
929 $this->fe_user
->unpack_uc('');
931 $this->fe_user
->fetchSessionData();
932 $recs = \TYPO3\CMS\Core\Utility\GeneralUtility
::_GP('recs');
933 // If any record registration is submitted, register the record.
934 if (is_array($recs)) {
935 $this->fe_user
->record_registration($recs, $this->TYPO3_CONF_VARS
['FE']['maxSessionDataSize']);
937 // Call hook for possible manipulation of frontend user object
938 if (is_array($this->TYPO3_CONF_VARS
['SC_OPTIONS']['tslib/class.tslib_fe.php']['initFEuser'])) {
939 $_params = array('pObj' => &$this);
940 foreach ($this->TYPO3_CONF_VARS
['SC_OPTIONS']['tslib/class.tslib_fe.php']['initFEuser'] as $_funcRef) {
941 \TYPO3\CMS\Core\Utility\GeneralUtility
::callUserFunction($_funcRef, $_params, $this);
944 // For every 60 seconds the is_online timestamp is updated.
945 if (is_array($this->fe_user
->user
) && $this->fe_user
->user
['uid'] && $this->fe_user
->user
['is_online'] < $GLOBALS['EXEC_TIME'] - 60) {
946 $GLOBALS['TYPO3_DB']->exec_UPDATEquery('fe_users', 'uid=' . intval($this->fe_user
->user
['uid']), array('is_online' => $GLOBALS['EXEC_TIME']));
951 * Initializes the front-end user groups.
952 * Sets ->loginUser and ->gr_list based on front-end user status.
955 * @todo Define visibility
957 public function initUserGroups() {
958 // This affects the hidden-flag selecting the fe_groups for the user!
959 $this->fe_user
->showHiddenRecords
= $this->showHiddenRecords
;
960 // no matter if we have an active user we try to fetch matching groups which can be set without an user (simulation for instance!)
961 $this->fe_user
->fetchGroupData();
962 if (is_array($this->fe_user
->user
) && count($this->fe_user
->groupData
['uid'])) {
964 $this->loginUser
= 1;
965 // 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!
966 $this->gr_list
= '0,-2';
967 $gr_array = $this->fe_user
->groupData
['uid'];
969 $this->loginUser
= 0;
970 // 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!
971 $this->gr_list
= '0,-1';
972 if ($this->loginAllowedInBranch
) {
973 // 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.
974 $gr_array = $this->fe_user
->groupData
['uid'];
976 // Set to blank since we will NOT risk any groups being set when no logins are allowed!
982 $gr_array = array_unique($gr_array);
985 if (count($gr_array) && !$this->loginAllowedInBranch_mode
) {
986 $this->gr_list
.= ',' . implode(',', $gr_array);
988 if ($this->fe_user
->writeDevLog
) {
989 \TYPO3\CMS\Core\Utility\GeneralUtility
::devLog('Valid usergroups for TSFE: ' . $this->gr_list
, 'TYPO3\\CMS\\Frontend\\Controller\\TypoScriptFrontendController');
994 * Checking if a user is logged in or a group constellation different from "0,-1"
996 * @return boolean TRUE if either a login user is found (array fe_user->user) OR if the gr_list is set to something else than '0,-1' (could be done even without a user being logged in!)
997 * @todo Define visibility
999 public function isUserOrGroupSet() {
1000 return is_array($this->fe_user
->user
) ||
$this->gr_list
!== '0,-1';
1004 * Provides ways to bypass the '?id=[xxx]&type=[xx]' format, using either PATH_INFO or virtual HTML-documents (using Apache mod_rewrite)
1007 * 1) Use PATH_INFO (also Apache) to extract id and type from that var. Does not require any special modules compiled with apache. (less typical)
1008 * 2) Using hook which enables features like those provided from "realurl" extension (AKA "Speaking URLs")
1011 * @todo Define visibility
1013 public function checkAlternativeIdMethods() {
1014 $this->siteScript
= \TYPO3\CMS\Core\Utility\GeneralUtility
::getIndpEnv('TYPO3_SITE_SCRIPT');
1015 // Call post processing function for custom URL methods.
1016 if (is_array($this->TYPO3_CONF_VARS
['SC_OPTIONS']['tslib/class.tslib_fe.php']['checkAlternativeIdMethods-PostProc'])) {
1017 $_params = array('pObj' => &$this);
1018 foreach ($this->TYPO3_CONF_VARS
['SC_OPTIONS']['tslib/class.tslib_fe.php']['checkAlternativeIdMethods-PostProc'] as $_funcRef) {
1019 \TYPO3\CMS\Core\Utility\GeneralUtility
::callUserFunction($_funcRef, $_params, $this);
1025 * Clears the preview-flags, sets sim_exec_time to current time.
1026 * Hidden pages must be hidden as default, $GLOBALS['SIM_EXEC_TIME'] is set to $GLOBALS['EXEC_TIME']
1027 * in bootstrap initializeGlobalTimeVariables(). Alter it by adding or subtracting seconds.
1030 * @todo Define visibility
1032 public function clear_preview() {
1033 $this->showHiddenPage
= 0;
1034 $this->showHiddenRecords
= 0;
1035 $GLOBALS['SIM_EXEC_TIME'] = $GLOBALS['EXEC_TIME'];
1036 $GLOBALS['SIM_ACCESS_TIME'] = $GLOBALS['ACCESS_TIME'];
1037 $this->fePreview
= 0;
1041 * Checks if a backend user is logged in
1043 * @return boolean whether a backend user is logged in
1045 public function isBackendUserLoggedIn() {
1046 return $this->beUserLogin ?
TRUE : FALSE;
1050 * Creates the backend user object and returns it.
1052 * @return \TYPO3\CMS\Backend\FrontendBackendUserAuthentication the backend user object
1054 public function initializeBackendUser() {
1056 if (is_array($this->TYPO3_CONF_VARS
['SC_OPTIONS']['tslib/index_ts.php']['preBeUser'])) {
1057 foreach ($this->TYPO3_CONF_VARS
['SC_OPTIONS']['tslib/index_ts.php']['preBeUser'] as $_funcRef) {
1059 \TYPO3\CMS\Core\Utility\GeneralUtility
::callUserFunction($_funcRef, $_params, $this);
1062 /** @var $BE_USER \TYPO3\CMS\Backend\FrontendBackendUserAuthentication */
1064 // If the backend cookie is set,
1065 // we proceed and check if a backend user is logged in.
1066 if ($_COOKIE[\TYPO3\CMS\Core\Authentication\BackendUserAuthentication
::getCookieName()]) {
1067 $GLOBALS['TYPO3_MISC']['microtime_BE_USER_start'] = microtime(TRUE);
1068 $GLOBALS['TT']->push('Back End user initialized', '');
1069 // TODO: validate the comment below: is this necessary? if so,
1070 // formfield_status should be set to "" in \TYPO3\CMS\Backend\FrontendBackendUserAuthentication
1071 // which is a subclass of \TYPO3\CMS\Core\Authentication\BackendUserAuthentication
1073 // the value this->formfield_status is set to empty in order to
1074 // disable login-attempts to the backend account through this script
1075 // New backend user object
1076 $BE_USER = \TYPO3\CMS\Core\Utility\GeneralUtility
::makeInstance('TYPO3\\CMS\\Backend\\FrontendBackendUserAuthentication');
1077 $BE_USER->OS
= TYPO3_OS
;
1078 $BE_USER->lockIP
= $this->TYPO3_CONF_VARS
['BE']['lockIP'];
1079 // Object is initialized
1081 $BE_USER->unpack_uc('');
1082 if ($BE_USER->user
['uid']) {
1083 $BE_USER->fetchGroupData();
1084 $this->beUserLogin
= 1;
1086 // Unset the user initialization.
1087 if (!$BE_USER->checkLockToIP() ||
!$BE_USER->checkBackendAccessSettingsFromInitPhp() ||
!$BE_USER->user
['uid']) {
1089 $this->beUserLogin
= 0;
1090 $_SESSION['TYPO3-TT-start'] = FALSE;
1092 $GLOBALS['TT']->pull();
1093 $GLOBALS['TYPO3_MISC']['microtime_BE_USER_end'] = microtime(TRUE);
1095 // POST BE_USER HOOK
1096 if (is_array($this->TYPO3_CONF_VARS
['SC_OPTIONS']['tslib/index_ts.php']['postBeUser'])) {
1098 'BE_USER' => &$BE_USER
1100 foreach ($this->TYPO3_CONF_VARS
['SC_OPTIONS']['tslib/index_ts.php']['postBeUser'] as $_funcRef) {
1101 \TYPO3\CMS\Core\Utility\GeneralUtility
::callUserFunction($_funcRef, $_params, $this);
1108 * Determines the id and evaluates any preview settings
1109 * Basically this function is about determining whether a backend user is logged in, if he has read access to the page and if he's previewing the page. That all determines which id to show and how to initialize the id.
1112 * @todo Define visibility
1114 public function determineId() {
1115 // Call pre processing function for id determination
1116 if (is_array($this->TYPO3_CONF_VARS
['SC_OPTIONS']['tslib/class.tslib_fe.php']['determineId-PreProcessing'])) {
1117 foreach ($this->TYPO3_CONF_VARS
['SC_OPTIONS']['tslib/class.tslib_fe.php']['determineId-PreProcessing'] as $functionReference) {
1118 $parameters = array('parentObject' => $this);
1119 \TYPO3\CMS\Core\Utility\GeneralUtility
::callUserFunction($functionReference, $parameters, $this);
1122 // Getting ARG-v values if some
1123 $this->setIDfromArgV();
1124 // If there is a Backend login we are going to check for any preview settings:
1125 $GLOBALS['TT']->push('beUserLogin', '');
1126 if ($this->beUserLogin ||
$this->doWorkspacePreview()) {
1127 // Backend user preview features:
1128 if ($this->beUserLogin
&& $GLOBALS['BE_USER']->adminPanel
instanceof \TYPO3\CMS\Frontend\View\AdminPanelView
) {
1129 $this->fePreview
= $GLOBALS['BE_USER']->adminPanel
->extGetFeAdminValue('preview') ?
TRUE : FALSE;
1130 // If admin panel preview is enabled...
1131 if ($this->fePreview
) {
1132 $fe_user_OLD_USERGROUP = $this->fe_user
->user
['usergroup'];
1133 $this->showHiddenPage
= $GLOBALS['BE_USER']->adminPanel
->extGetFeAdminValue('preview', 'showHiddenPages');
1134 $this->showHiddenRecords
= $GLOBALS['BE_USER']->adminPanel
->extGetFeAdminValue('preview', 'showHiddenRecords');
1136 $simTime = $GLOBALS['BE_USER']->adminPanel
->extGetFeAdminValue('preview', 'simulateDate');
1138 $GLOBALS['SIM_EXEC_TIME'] = $simTime;
1139 $GLOBALS['SIM_ACCESS_TIME'] = $simTime - $simTime %
60;
1142 $simUserGroup = $GLOBALS['BE_USER']->adminPanel
->extGetFeAdminValue('preview', 'simulateUserGroup');
1143 $this->simUserGroup
= $simUserGroup;
1144 if ($simUserGroup) {
1145 $this->fe_user
->user
['usergroup'] = $simUserGroup;
1147 if (!$simUserGroup && !$simTime && !$this->showHiddenPage
&& !$this->showHiddenRecords
) {
1148 $this->fePreview
= 0;
1153 if ($this->determineIdIsHiddenPage()) {
1154 // The preview flag is set only if the current page turns out to actually be hidden!
1155 $this->fePreview
= 1;
1156 $this->showHiddenPage
= 1;
1158 // For Live workspace: Check root line for proper connection to tree root (done because of possible preview of page / branch versions)
1159 if (!$this->fePreview
&& $this->whichWorkspace() === 0) {
1160 // Initialize the page-select functions to check rootline:
1161 $temp_sys_page = \TYPO3\CMS\Core\Utility\GeneralUtility
::makeInstance('TYPO3\\CMS\\Frontend\\Page\\PageRepository');
1162 $temp_sys_page->init($this->showHiddenPage
);
1163 // If root line contained NO records and ->error_getRootLine_failPid tells us that it was because of a pid=-1 (indicating a "version" record)...:
1164 if (!count($temp_sys_page->getRootLine($this->id
, $this->MP
)) && $temp_sys_page->error_getRootLine_failPid
== -1) {
1165 // Setting versioningPreview flag and try again:
1166 $temp_sys_page->versioningPreview
= TRUE;
1167 if (count($temp_sys_page->getRootLine($this->id
, $this->MP
))) {
1168 // 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.
1169 $this->fePreview
= 1;
1174 // The preview flag will be set if a backend user is in an offline workspace
1175 if (($GLOBALS['BE_USER']->user
['workspace_preview'] || \TYPO3\CMS\Core\Utility\GeneralUtility
::_GP('ADMCMD_view') ||
$this->doWorkspacePreview()) && ($this->whichWorkspace() === -1 ||
$this->whichWorkspace() > 0)) {
1176 // Will show special preview message.
1177 $this->fePreview
= 2;
1179 // If the front-end is showing a preview, caching MUST be disabled.
1180 if ($this->fePreview
) {
1181 $this->disableCache();
1184 $GLOBALS['TT']->pull();
1185 // Now, get the id, validate access etc:
1186 $this->fetch_the_id();
1187 // Check if backend user has read access to this page. If not, recalculate the id.
1188 if ($this->beUserLogin
&& $this->fePreview
) {
1189 if (!$GLOBALS['BE_USER']->doesUserHaveAccess($this->page
, 1)) {
1191 $this->clear_preview();
1192 $this->fe_user
->user
['usergroup'] = $fe_user_OLD_USERGROUP;
1193 // Fetching the id again, now with the preview settings reset.
1194 $this->fetch_the_id();
1197 // Checks if user logins are blocked for a certain branch and if so, will unset user login and re-fetch ID.
1198 $this->loginAllowedInBranch
= $this->checkIfLoginAllowedInBranch();
1199 // Logins are not allowed:
1200 if (!$this->loginAllowedInBranch
) {
1201 // Only if there is a login will we run this...
1202 if ($this->isUserOrGroupSet()) {
1203 if ($this->loginAllowedInBranch_mode
== 'all') {
1204 // Clear out user and group:
1205 unset($this->fe_user
->user
);
1206 $this->gr_list
= '0,-1';
1208 $this->gr_list
= '0,-2';
1210 // Fetching the id again, now with the preview settings reset.
1211 $this->fetch_the_id();
1215 // Make sure it's an integer
1216 $this->id
= ($this->contentPid
= intval($this->id
));
1217 // Make sure it's an integer
1218 $this->type
= intval($this->type
);
1219 // Call post processing function for id determination:
1220 if (is_array($this->TYPO3_CONF_VARS
['SC_OPTIONS']['tslib/class.tslib_fe.php']['determineId-PostProc'])) {
1221 $_params = array('pObj' => &$this);
1222 foreach ($this->TYPO3_CONF_VARS
['SC_OPTIONS']['tslib/class.tslib_fe.php']['determineId-PostProc'] as $_funcRef) {
1223 \TYPO3\CMS\Core\Utility\GeneralUtility
::callUserFunction($_funcRef, $_params, $this);
1229 * Checks if the page is hidden in the active workspace.
1230 * If it is hidden, preview flags will be set.
1234 protected function determineIdIsHiddenPage() {
1235 $field = \TYPO3\CMS\Core\Utility\MathUtility
::canBeInterpretedAsInteger($this->id
) ?
'uid' : 'alias';
1236 $pageSelectCondition = $field . '=' . $GLOBALS['TYPO3_DB']->fullQuoteStr($this->id
, 'pages');
1237 $page = $GLOBALS['TYPO3_DB']->exec_SELECTgetSingleRow('uid,hidden,starttime,endtime', 'pages', $pageSelectCondition . ' AND pid>=0 AND deleted=0');
1238 $workspace = $this->whichWorkspace();
1239 if ($workspace !== 0 && $workspace !== FALSE) {
1240 // Fetch overlay of page if in workspace and check if it is hidden
1241 $pageSelectObject = \TYPO3\CMS\Core\Utility\GeneralUtility
::makeInstance('TYPO3\\CMS\\Frontend\\Page\\PageRepository');
1242 $pageSelectObject->versioningPreview
= TRUE;
1243 $pageSelectObject->init(FALSE);
1244 $targetPage = $pageSelectObject->getWorkspaceVersionOfRecord($this->whichWorkspace(), 'pages', $page['uid']);
1245 $result = $targetPage === -1 ||
$targetPage === -2;
1247 $result = is_array($page) && ($page['hidden'] ||
$page['starttime'] > $GLOBALS['SIM_EXEC_TIME'] ||
$page['endtime'] != 0 && $page['endtime'] <= $GLOBALS['SIM_EXEC_TIME']);
1254 * This gets the id of the page, checks if the page is in the domain and if the page is accessible
1255 * Sets variables such as $this->sys_page, $this->loginUser, $this->gr_list, $this->id, $this->type, $this->domainStartPage, $this->idParts
1259 * @todo Define visibility
1261 public function fetch_the_id() {
1262 $GLOBALS['TT']->push('fetch_the_id initialize/', '');
1263 // Initialize the page-select functions.
1264 $this->sys_page
= \TYPO3\CMS\Core\Utility\GeneralUtility
::makeInstance('TYPO3\\CMS\\Frontend\\Page\\PageRepository');
1265 $this->sys_page
->versioningPreview
= $this->fePreview
=== 2 ||
intval($this->workspacePreview
) || \TYPO3\CMS\Core\Utility\GeneralUtility
::_GP('ADMCMD_view') ?
TRUE : FALSE;
1266 $this->sys_page
->versioningWorkspaceId
= $this->whichWorkspace();
1267 $this->sys_page
->init($this->showHiddenPage
);
1268 // Set the valid usergroups for FE
1269 $this->initUserGroups();
1270 // Sets sys_page where-clause
1271 $this->setSysPageWhereClause();
1272 // Splitting $this->id by a period (.).
1273 // First part is 'id' and second part (if exists) will overrule the &type param
1274 $idParts = explode('.', $this->id
, 2);
1275 $this->id
= $idParts[0];
1276 if (isset($idParts[1])) {
1277 $this->type
= $idParts[1];
1279 // Splitting $this->id by a comma (,).
1280 // First part is 'id' and other parts are just stored for use in scripts.
1281 // Still used in the old wapversion.lib files.
1282 $this->idParts
= explode(',', $this->id
);
1283 $this->id
= $this->idParts
[0];
1285 // Hook for further id manipulation
1286 if (is_array($this->TYPO3_CONF_VARS
['SC_OPTIONS']['tslib/class.tslib_fe.php']['modifyPageId'])) {
1287 $_params = array('id' => $this->id
);
1289 foreach ($this->TYPO3_CONF_VARS
['SC_OPTIONS']['tslib/class.tslib_fe.php']['modifyPageId'] as $_funcRef) {
1290 $deprecationMessage = 'Hook $TYPO3_CONF_VARS[SC_OPTIONS][tslib/class.tslib_fe.php][modifyPageId] is ' .
1291 'deprecated since 6.0 and will be removed two versions later';
1292 if (!is_object($_funcRef) ||
!is_a($_funcRef, 'Closure')) {
1293 $deprecationMessage .= '- used by ' . $_funcRef;
1295 \TYPO3\CMS\Core\Utility\GeneralUtility
::deprecationLog($deprecationMessage);
1296 $newIdFromFunc = \TYPO3\CMS\Core\Utility\GeneralUtility
::callUserFunction($_funcRef, $_params, $this);
1297 if ($newIdFromFunc !== FALSE) {
1298 $newId = $newIdFromFunc;
1301 if ($newId !== FALSE) {
1306 // If $this->id is a string, it's an alias
1307 $this->checkAndSetAlias();
1308 // The id and type is set to the integer-value - just to be sure...
1309 $this->id
= intval($this->id
);
1310 $this->type
= intval($this->type
);
1311 $GLOBALS['TT']->pull();
1312 // We find the first page belonging to the current domain
1313 $GLOBALS['TT']->push('fetch_the_id domain/', '');
1314 // The page_id of the current domain
1315 $this->domainStartPage
= $this->findDomainRecord($this->TYPO3_CONF_VARS
['SYS']['recursiveDomainSearch']);
1317 if ($this->domainStartPage
) {
1318 // If the id was not previously set, set it to the id of the domain.
1319 $this->id
= $this->domainStartPage
;
1321 // Find the first 'visible' page in that domain
1322 $theFirstPage = $this->sys_page
->getFirstWebPage($this->id
);
1323 if ($theFirstPage) {
1324 $this->id
= $theFirstPage['uid'];
1326 $message = 'No pages are found on the rootlevel!';
1327 if ($this->checkPageUnavailableHandler()) {
1328 $this->pageUnavailableAndExit($message);
1330 \TYPO3\CMS\Core\Utility\GeneralUtility
::sysLog($message, 'cms', \TYPO3\CMS\Core\Utility\GeneralUtility
::SYSLOG_SEVERITY_ERROR
);
1331 throw new \TYPO3\CMS\Core\Error\Http\
ServiceUnavailableException($message, 1301648975);
1336 $GLOBALS['TT']->pull();
1337 $GLOBALS['TT']->push('fetch_the_id rootLine/', '');
1338 // We store the originally requested id
1339 $requestedId = $this->id
;
1340 $this->getPageAndRootlineWithDomain($this->domainStartPage
);
1341 $GLOBALS['TT']->pull();
1342 if ($this->pageNotFound
&& $this->TYPO3_CONF_VARS
['FE']['pageNotFound_handling']) {
1343 $pNotFoundMsg = array(
1344 1 => 'ID was not an accessible page',
1345 2 => 'Subsection was found and not accessible',
1346 3 => 'ID was outside the domain',
1347 4 => 'The requested page alias does not exist'
1349 $this->pageNotFoundAndExit($pNotFoundMsg[$this->pageNotFound
]);
1351 if ($this->page
['url_scheme'] > 0) {
1353 $requestUrlScheme = parse_url(\TYPO3\CMS\Core\Utility\GeneralUtility
::getIndpEnv('TYPO3_REQUEST_URL'), PHP_URL_SCHEME
);
1354 if ((int) $this->page
['url_scheme'] === \TYPO3\CMS\Core\Utility\HttpUtility
::SCHEME_HTTP
&& $requestUrlScheme == 'https') {
1355 $newUrl = 'http://' . substr(\TYPO3\CMS\Core\Utility\GeneralUtility
::getIndpEnv('TYPO3_REQUEST_URL'), 8);
1356 } elseif ((int) $this->page
['url_scheme'] === \TYPO3\CMS\Core\Utility\HttpUtility
::SCHEME_HTTPS
&& $requestUrlScheme == 'http') {
1357 $newUrl = 'https://' . substr(\TYPO3\CMS\Core\Utility\GeneralUtility
::getIndpEnv('TYPO3_REQUEST_URL'), 7);
1359 if ($newUrl !== '') {
1360 if ($_SERVER['REQUEST_METHOD'] === 'POST') {
1361 $headerCode = \TYPO3\CMS\Core\Utility\HttpUtility
::HTTP_STATUS_303
;
1363 $headerCode = \TYPO3\CMS\Core\Utility\HttpUtility
::HTTP_STATUS_301
;
1365 \TYPO3\CMS\Core\Utility\HttpUtility
::redirect($newUrl, $headerCode);
1368 // Set no_cache if set
1369 if ($this->page
['no_cache']) {
1370 $this->set_no_cache('no_cache is set in page properties');
1372 // Init SYS_LASTCHANGED
1373 $this->register
['SYS_LASTCHANGED'] = intval($this->page
['tstamp']);
1374 if ($this->register
['SYS_LASTCHANGED'] < intval($this->page
['SYS_LASTCHANGED'])) {
1375 $this->register
['SYS_LASTCHANGED'] = intval($this->page
['SYS_LASTCHANGED']);
1377 if (is_array($this->TYPO3_CONF_VARS
['SC_OPTIONS']['tslib/class.tslib_fe.php']['fetchPageId-PostProcessing'])) {
1378 foreach ($this->TYPO3_CONF_VARS
['SC_OPTIONS']['tslib/class.tslib_fe.php']['fetchPageId-PostProcessing'] as $functionReference) {
1379 $parameters = array('parentObject' => $this);
1380 \TYPO3\CMS\Core\Utility\GeneralUtility
::callUserFunction($functionReference, $parameters, $this);
1386 * Gets the page and rootline arrays based on the id, $this->id
1388 * If the id does not correspond to a proper page, the 'previous' valid page in the rootline is found
1389 * If the page is a shortcut (doktype=4), the ->id is loaded with that id
1391 * Whether or not the ->id is changed to the shortcut id or the previous id in rootline (eg if a page is hidden), the ->page-array and ->rootline is found and must also be valid.
1393 * Sets or manipulates internal variables such as: $this->id, $this->page, $this->rootLine, $this->MP, $this->pageNotFound
1397 * @todo Define visibility
1399 public function getPageAndRootline() {
1400 $this->page
= $this->sys_page
->getPage($this->id
);
1401 if (!count($this->page
)) {
1402 // If no page, we try to find the page before in the rootLine.
1403 // Page is 'not found' in case the id itself was not an accessible page. code 1
1404 $this->pageNotFound
= 1;
1405 $this->rootLine
= $this->sys_page
->getRootLine($this->id
, $this->MP
);
1406 if (count($this->rootLine
)) {
1407 $c = count($this->rootLine
) - 1;
1409 // Add to page access failure history:
1410 $this->pageAccessFailureHistory
['direct_access'][] = $this->rootLine
[$c];
1411 // Decrease to next page in rootline and check the access to that, if OK, set as page record and ID value.
1413 $this->id
= $this->rootLine
[$c]['uid'];
1414 $this->page
= $this->sys_page
->getPage($this->id
);
1415 if (count($this->page
)) {
1420 // If still no page...
1421 if (!count($this->page
)) {
1422 $message = 'The requested page does not exist!';
1423 if ($this->TYPO3_CONF_VARS
['FE']['pageNotFound_handling']) {
1424 $this->pageNotFoundAndExit($message);
1426 \TYPO3\CMS\Core\Utility\GeneralUtility
::sysLog($message, 'cms', \TYPO3\CMS\Core\Utility\GeneralUtility
::SYSLOG_SEVERITY_ERROR
);
1427 throw new \TYPO3\CMS\Core\Error\Http\
PageNotFoundException($message, 1301648780);
1431 // Spacer is not accessible in frontend
1432 if ($this->page
['doktype'] == \TYPO3\CMS\Frontend\Page\PageRepository
::DOKTYPE_SPACER
) {
1433 $message = 'The requested page does not exist!';
1434 if ($this->TYPO3_CONF_VARS
['FE']['pageNotFound_handling']) {
1435 $this->pageNotFoundAndExit($message);
1437 \TYPO3\CMS\Core\Utility\GeneralUtility
::sysLog($message, 'cms', \TYPO3\CMS\Core\Utility\GeneralUtility
::SYSLOG_SEVERITY_ERROR
);
1438 throw new \TYPO3\CMS\Core\Error\Http\
PageNotFoundException($message, 1301648781);
1441 // Is the ID a link to another page??
1442 if ($this->page
['doktype'] == \TYPO3\CMS\Frontend\Page\PageRepository
::DOKTYPE_SHORTCUT
) {
1443 // 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.
1445 // saving the page so that we can check later - when we know
1446 // about languages - whether we took the correct shortcut or
1447 // whether a translation of the page overwrites the shortcut
1448 // target and we need to follow the new target
1449 $this->originalShortcutPage
= $this->page
;
1450 $this->page
= $this->getPageShortcut($this->page
['shortcut'], $this->page
['shortcut_mode'], $this->page
['uid']);
1451 $this->id
= $this->page
['uid'];
1453 // Gets the rootLine
1454 $this->rootLine
= $this->sys_page
->getRootLine($this->id
, $this->MP
);
1455 // If not rootline we're off...
1456 if (!count($this->rootLine
)) {
1457 $ws = $this->whichWorkspace();
1458 if ($this->sys_page
->error_getRootLine_failPid
== -1 && $ws) {
1459 $this->sys_page
->versioningPreview
= TRUE;
1460 $this->versioningWorkspaceId
= $ws;
1461 $this->rootLine
= $this->sys_page
->getRootLine($this->id
, $this->MP
);
1463 if (!count($this->rootLine
)) {
1464 $message = 'The requested page didn\'t have a proper connection to the tree-root!';
1465 if ($this->checkPageUnavailableHandler()) {
1466 $this->pageUnavailableAndExit($message);
1468 $rootline = '(' . $this->sys_page
->error_getRootLine
. ')';
1469 \TYPO3\CMS\Core\Utility\GeneralUtility
::sysLog($message, 'cms', \TYPO3\CMS\Core\Utility\GeneralUtility
::SYSLOG_SEVERITY_ERROR
);
1470 throw new \TYPO3\CMS\Core\Error\Http\
ServiceUnavailableException($message . '<br /><br />' . $rootline, 1301648167);
1473 $this->fePreview
= 1;
1475 // Checking for include section regarding the hidden/starttime/endtime/fe_user (that is access control of a whole subbranch!)
1476 if ($this->checkRootlineForIncludeSection()) {
1477 if (!count($this->rootLine
)) {
1478 $message = 'The requested page was not accessible!';
1479 if ($this->checkPageUnavailableHandler()) {
1480 $this->pageUnavailableAndExit($message);
1482 \TYPO3\CMS\Core\Utility\GeneralUtility
::sysLog($message, 'cms', \TYPO3\CMS\Core\Utility\GeneralUtility
::SYSLOG_SEVERITY_ERROR
);
1483 throw new \TYPO3\CMS\Core\Error\Http\
ServiceUnavailableException($message, 1301648234);
1486 $el = reset($this->rootLine
);
1487 $this->id
= $el['uid'];
1488 $this->page
= $this->sys_page
->getPage($this->id
);
1489 $this->rootLine
= $this->sys_page
->getRootLine($this->id
, $this->MP
);
1495 * Get page shortcut; Finds the records pointed to by input value $SC (the shortcut value)
1497 * @param integer $SC The value of the "shortcut" field from the pages record
1498 * @param integer $mode The shortcut mode: 1 will select first subpage, 2 a random subpage, 3 the parent page; default is the page pointed to by $SC
1499 * @param integer $thisUid The current page UID of the page which is a shortcut
1500 * @param integer $itera Safety feature which makes sure that the function is calling itself recursively max 20 times (since this function can find shortcuts to other shortcuts to other shortcuts...)
1501 * @param array $pageLog An array filled with previous page uids tested by the function - new page uids are evaluated against this to avoid going in circles.
1502 * @return mixed Returns the page record of the page that the shortcut pointed to.
1504 * @see getPageAndRootline()
1505 * @todo Define visibility
1507 public function getPageShortcut($SC, $mode, $thisUid, $itera = 20, $pageLog = array()) {
1508 $idArray = \TYPO3\CMS\Core\Utility\GeneralUtility
::intExplode(',', $SC);
1509 // Find $page record depending on shortcut mode:
1511 case \TYPO3\CMS\Frontend\Page\PageRepository
::SHORTCUT_MODE_FIRST_SUBPAGE
:
1513 case \TYPO3\CMS\Frontend\Page\PageRepository
::SHORTCUT_MODE_RANDOM_SUBPAGE
:
1514 $pageArray = $this->sys_page
->getMenu($idArray[0] ?
$idArray[0] : $thisUid, '*', 'sorting', 'AND pages.doktype<199 AND pages.doktype!=' . \TYPO3\CMS\Frontend\Page\PageRepository
::DOKTYPE_BE_USER_SECTION
);
1516 if ($mode == \TYPO3\CMS\Frontend\Page\PageRepository
::SHORTCUT_MODE_RANDOM_SUBPAGE
&& count($pageArray)) {
1517 $randval = intval(rand(0, count($pageArray) - 1));
1521 foreach ($pageArray as $pV) {
1528 if (count($page) == 0) {
1529 $message = 'This page (ID ' . $thisUid . ') is of type "Shortcut" and configured to redirect to a subpage. ' . 'However, this page has no accessible subpages.';
1530 throw new \TYPO3\CMS\Core\Error\Http\
PageNotFoundException($message, 1301648328);
1533 case \TYPO3\CMS\Frontend\Page\PageRepository
::SHORTCUT_MODE_PARENT_PAGE
:
1534 $parent = $this->sys_page
->getPage($thisUid);
1535 $page = $this->sys_page
->getPage($parent['pid']);
1536 if (count($page) == 0) {
1537 $message = 'This page (ID ' . $thisUid . ') is of type "Shortcut" and configured to redirect to its parent page. ' . 'However, the parent page is not accessible.';
1538 throw new \TYPO3\CMS\Core\Error\Http\
PageNotFoundException($message, 1301648358);
1542 $page = $this->sys_page
->getPage($idArray[0]);
1543 if (count($page) == 0) {
1544 $message = 'This page (ID ' . $thisUid . ') is of type "Shortcut" and configured to redirect to a page, which is not accessible (ID ' . $idArray[0] . ').';
1545 throw new \TYPO3\CMS\Core\Error\Http\
PageNotFoundException($message, 1301648404);
1549 // Check if short cut page was a shortcut itself, if so look up recursively:
1550 if ($page['doktype'] == \TYPO3\CMS\Frontend\Page\PageRepository
::DOKTYPE_SHORTCUT
) {
1551 if (!in_array($page['uid'], $pageLog) && $itera > 0) {
1552 $pageLog[] = $page['uid'];
1553 $page = $this->getPageShortcut($page['shortcut'], $page['shortcut_mode'], $page['uid'], $itera - 1, $pageLog);
1555 $pageLog[] = $page['uid'];
1556 $message = 'Page shortcuts were looping in uids ' . implode(',', $pageLog) . '...!';
1557 \TYPO3\CMS\Core\Utility\GeneralUtility
::sysLog($message, 'cms', \TYPO3\CMS\Core\Utility\GeneralUtility
::SYSLOG_SEVERITY_ERROR
);
1558 throw new \
RuntimeException($message, 1294587212);
1561 // Return resulting page:
1566 * Checks the current rootline for defined sections.
1570 * @todo Define visibility
1572 public function checkRootlineForIncludeSection() {
1573 $c = count($this->rootLine
);
1574 $removeTheRestFlag = 0;
1575 for ($a = 0; $a < $c; $a++
) {
1576 if (!$this->checkPagerecordForIncludeSection($this->rootLine
[$a])) {
1577 // Add to page access failure history:
1578 $this->pageAccessFailureHistory
['sub_section'][] = $this->rootLine
[$a];
1579 $removeTheRestFlag = 1;
1581 if ($this->rootLine
[$a]['doktype'] == \TYPO3\CMS\Frontend\Page\PageRepository
::DOKTYPE_BE_USER_SECTION
) {
1582 // If there is a backend user logged in, check if he has read access to the page:
1583 if ($this->beUserLogin
) {
1584 $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery('uid', 'pages', 'uid=' . intval($this->id
) . ' AND ' . $GLOBALS['BE_USER']->getPagePermsClause(1));
1586 list($isPage) = $GLOBALS['TYPO3_DB']->sql_fetch_row($res);
1588 // 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...
1589 $removeTheRestFlag = 1;
1592 // Dont go here, if there is no backend user logged in.
1593 $removeTheRestFlag = 1;
1596 if ($removeTheRestFlag) {
1597 // Page is 'not found' in case a subsection was found and not accessible, code 2
1598 $this->pageNotFound
= 2;
1599 unset($this->rootLine
[$a]);
1602 return $removeTheRestFlag;
1606 * Checks page record for enableFields
1607 * Returns TRUE if enableFields does not disable the page record.
1608 * Takes notice of the ->showHiddenPage flag and uses SIM_ACCESS_TIME for start/endtime evaluation
1610 * @param array $row The page record to evaluate (needs fields: hidden, starttime, endtime, fe_group)
1611 * @param boolean $bypassGroupCheck Bypass group-check
1612 * @return boolean TRUE, if record is viewable.
1613 * @see TYPO3\\CMS\\Frontend\\ContentObject\\ContentObjectRenderer::getTreeList(), checkPagerecordForIncludeSection()
1614 * @todo Define visibility
1616 public function checkEnableFields($row, $bypassGroupCheck = FALSE) {
1617 if (isset($this->TYPO3_CONF_VARS
['SC_OPTIONS']['tslib/class.tslib_fe.php']['hook_checkEnableFields']) && is_array($this->TYPO3_CONF_VARS
['SC_OPTIONS']['tslib/class.tslib_fe.php']['hook_checkEnableFields'])) {
1618 $_params = array('pObj' => $this, 'row' => &$row, 'bypassGroupCheck' => &$bypassGroupCheck);
1619 foreach ($this->TYPO3_CONF_VARS
['SC_OPTIONS']['tslib/class.tslib_fe.php']['hook_checkEnableFields'] as $_funcRef) {
1620 // Call hooks: If one returns FALSE, method execution is aborted with result "This record is not available"
1621 $return = \TYPO3\CMS\Core\Utility\GeneralUtility
::callUserFunction($_funcRef, $_params, $this);
1622 if ($return === FALSE) {
1627 if ((!$row['hidden'] ||
$this->showHiddenPage
) && $row['starttime'] <= $GLOBALS['SIM_ACCESS_TIME'] && ($row['endtime'] == 0 ||
$row['endtime'] > $GLOBALS['SIM_ACCESS_TIME']) && ($bypassGroupCheck ||
$this->checkPageGroupAccess($row))) {
1633 * Check group access against a page record
1635 * @param array $row The page record to evaluate (needs field: fe_group)
1636 * @param mixed $groupList List of group id's (comma list or array). Default is $this->gr_list
1637 * @return boolean TRUE, if group access is granted.
1639 * @todo Define visibility
1641 public function checkPageGroupAccess($row, $groupList = NULL) {
1642 if (is_null($groupList)) {
1643 $groupList = $this->gr_list
;
1645 if (!is_array($groupList)) {
1646 $groupList = explode(',', $groupList);
1648 $pageGroupList = explode(',', $row['fe_group'] ?
$row['fe_group'] : 0);
1649 return count(array_intersect($groupList, $pageGroupList)) > 0;
1653 * Checks page record for include section
1655 * @param array $row The page record to evaluate (needs fields: extendToSubpages + hidden, starttime, endtime, fe_group)
1656 * @return boolean Returns TRUE if either extendToSubpages is not checked or if the enableFields does not disable the page record.
1658 * @see checkEnableFields(), TYPO3\\CMS\\Frontend\\ContentObject\\ContentObjectRenderer::getTreeList(), checkRootlineForIncludeSection()
1659 * @todo Define visibility
1661 public function checkPagerecordForIncludeSection($row) {
1662 return !$row['extendToSubpages'] ||
$this->checkEnableFields($row) ?
1 : 0;
1666 * Checks if logins are allowed in the current branch of the page tree. Traverses the full root line and returns TRUE if logins are OK, otherwise FALSE (and then the login user must be unset!)
1668 * @return boolean returns TRUE if logins are OK, otherwise FALSE (and then the login user must be unset!)
1669 * @todo Define visibility
1671 public function checkIfLoginAllowedInBranch() {
1673 $c = count($this->rootLine
);
1675 // Traverse root line from root and outwards:
1676 for ($a = 0; $a < $c; $a++
) {
1677 // If a value is set for login state:
1678 if ($this->rootLine
[$a]['fe_login_mode'] > 0) {
1679 // Determine state from value:
1680 if ((int) $this->rootLine
[$a]['fe_login_mode'] === 1) {
1682 $this->loginAllowedInBranch_mode
= 'all';
1683 } elseif ((int) $this->rootLine
[$a]['fe_login_mode'] === 3) {
1685 $this->loginAllowedInBranch_mode
= 'groups';
1695 * Analysing $this->pageAccessFailureHistory into a summary array telling which features disabled display and on which pages and conditions. That data can be used inside a page-not-found handler
1697 * @return array Summary of why page access was not allowed.
1698 * @todo Define visibility
1700 public function getPageAccessFailureReasons() {
1702 $combinedRecords = array_merge(is_array($this->pageAccessFailureHistory
['direct_access']) ?
$this->pageAccessFailureHistory
['direct_access'] : array(array('fe_group' => 0)), is_array($this->pageAccessFailureHistory
['sub_section']) ?
$this->pageAccessFailureHistory
['sub_section'] : array());
1703 if (count($combinedRecords)) {
1704 foreach ($combinedRecords as $k => $pagerec) {
1705 // 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
1706 // 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!
1707 if (!$k ||
$pagerec['extendToSubpages']) {
1708 if ($pagerec['hidden']) {
1709 $output['hidden'][$pagerec['uid']] = TRUE;
1711 if ($pagerec['starttime'] > $GLOBALS['SIM_ACCESS_TIME']) {
1712 $output['starttime'][$pagerec['uid']] = $pagerec['starttime'];
1714 if ($pagerec['endtime'] != 0 && $pagerec['endtime'] <= $GLOBALS['SIM_ACCESS_TIME']) {
1715 $output['endtime'][$pagerec['uid']] = $pagerec['endtime'];
1717 if (!$this->checkPageGroupAccess($pagerec)) {
1718 $output['fe_group'][$pagerec['uid']] = $pagerec['fe_group'];
1727 * This checks if there are ARGV-parameters in the QUERY_STRING and if so, those are used for the id
1728 * $this->id must be 'FALSE' in order for any processing to happen in here
1729 * If an id/alias value is extracted from the QUERY_STRING it is set in $this->id
1733 * @todo Define visibility
1735 public function setIDfromArgV() {
1737 list($theAlias) = explode('&', \TYPO3\CMS\Core\Utility\GeneralUtility
::getIndpEnv('QUERY_STRING'));
1738 $theAlias = trim($theAlias);
1739 $this->id
= $theAlias != '' && strpos($theAlias, '=') === FALSE ?
$theAlias : 0;
1744 * Gets ->page and ->rootline information based on ->id. ->id may change during this operation.
1745 * If not inside domain, then default to first page in domain.
1747 * @param integer $domainStartPage Page uid of the page where the found domain record is (pid of the domain record)
1750 * @todo Define visibility
1752 public function getPageAndRootlineWithDomain($domainStartPage) {
1753 $this->getPageAndRootline();
1754 // 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.
1755 if ($domainStartPage && is_array($this->rootLine
)) {
1757 foreach ($this->rootLine
as $key => $val) {
1758 if ($val['uid'] == $domainStartPage) {
1764 // Page is 'not found' in case the id was outside the domain, code 3
1765 $this->pageNotFound
= 3;
1766 $this->id
= $domainStartPage;
1767 // re-get the page and rootline if the id was not found.
1768 $this->getPageAndRootline();
1774 * Sets sys_page where-clause
1778 * @todo Define visibility
1780 public function setSysPageWhereClause() {
1781 $this->sys_page
->where_hid_del
.= ' AND pages.doktype<200';
1782 $this->sys_page
->where_groupAccess
= $this->sys_page
->getMultipleGroupsWhereClause('pages.fe_group', 'pages');
1786 * Looking up a domain record based on HTTP_HOST
1788 * @param boolean $recursive If set, it looks "recursively" meaning that a domain like "123.456.typo3.com" would find a domain record like "typo3.com" if "123.456.typo3.com" or "456.typo3.com" did not exist.
1789 * @return integer Returns the page id of the page where the domain record was found.
1791 * @todo Define visibility
1793 public function findDomainRecord($recursive = 0) {
1795 $host = explode('.', \TYPO3\CMS\Core\Utility\GeneralUtility
::getIndpEnv('HTTP_HOST'));
1796 while (count($host)) {
1797 $pageUid = $this->sys_page
->getDomainStartPage(implode('.', $host), \TYPO3\CMS\Core\Utility\GeneralUtility
::getIndpEnv('SCRIPT_NAME'), \TYPO3\CMS\Core\Utility\GeneralUtility
::getIndpEnv('REQUEST_URI'));
1806 return $this->sys_page
->getDomainStartPage(\TYPO3\CMS\Core\Utility\GeneralUtility
::getIndpEnv('HTTP_HOST'), \TYPO3\CMS\Core\Utility\GeneralUtility
::getIndpEnv('SCRIPT_NAME'), \TYPO3\CMS\Core\Utility\GeneralUtility
::getIndpEnv('REQUEST_URI'));
1811 * Page unavailable handler for use in frontend plugins from extensions.
1813 * @param string $reason Reason text
1814 * @param string $header HTTP header to send
1815 * @return void Function exits.
1816 * @todo Define visibility
1818 public function pageUnavailableAndExit($reason = '', $header = '') {
1819 $header = $header ?
$header : $this->TYPO3_CONF_VARS
['FE']['pageUnavailable_handling_statheader'];
1820 $this->pageUnavailableHandler($this->TYPO3_CONF_VARS
['FE']['pageUnavailable_handling'], $header, $reason);
1825 * Page-not-found handler for use in frontend plugins from extensions.
1827 * @param string $reason Reason text
1828 * @param string $header HTTP header to send
1829 * @return void Function exits.
1830 * @todo Define visibility
1832 public function pageNotFoundAndExit($reason = '', $header = '') {
1833 $header = $header ?
$header : $this->TYPO3_CONF_VARS
['FE']['pageNotFound_handling_statheader'];
1834 $this->pageNotFoundHandler($this->TYPO3_CONF_VARS
['FE']['pageNotFound_handling'], $header, $reason);
1839 * Checks whether the pageUnavailableHandler should be used. To be used, pageUnavailable_handling must be set
1840 * and devIPMask must not match the current visitor's IP address.
1842 * @return boolean TRUE/FALSE whether the pageUnavailable_handler should be used.
1843 * @todo Define visibility
1845 public function checkPageUnavailableHandler() {
1847 $this->TYPO3_CONF_VARS
['FE']['pageUnavailable_handling']
1848 && !\TYPO3\CMS\Core\Utility\GeneralUtility
::cmpIP(
1849 \TYPO3\CMS\Core\Utility\GeneralUtility
::getIndpEnv('REMOTE_ADDR'),
1850 $this->TYPO3_CONF_VARS
['SYS']['devIPmask']
1853 $checkPageUnavailableHandler = TRUE;
1855 $checkPageUnavailableHandler = FALSE;
1857 return $checkPageUnavailableHandler;
1861 * Page unavailable handler. Acts a wrapper for the pageErrorHandler method.
1863 * @param mixed $code Which type of handling; If a true PHP-boolean or TRUE then a \TYPO3\CMS\Core\Messaging\ErrorpageMessage is outputted. If integer an error message with that number is shown. Otherwise the $code value is expected to be a "Location:" header value.
1864 * @param string $header If set, this is passed directly to the PHP function, header()
1865 * @param string $reason If set, error messages will also mention this as the reason for the page-not-found.
1866 * @return void (The function exits!)
1867 * @todo Define visibility
1869 public function pageUnavailableHandler($code, $header, $reason) {
1870 $this->pageErrorHandler($code, $header, $reason);
1874 * Page not found handler. Acts a wrapper for the pageErrorHandler method.
1876 * @param mixed $code Which type of handling; If a true PHP-boolean or TRUE then a \TYPO3\CMS\Core\Messaging\ErrorpageMessage is outputted. If integer an error message with that number is shown. Otherwise the $code value is expected to be a "Location:" header value.
1877 * @param string $header If set, this is passed directly to the PHP function, header()
1878 * @param string $reason If set, error messages will also mention this as the reason for the page-not-found.
1879 * @return void (The function exits!)
1880 * @todo Define visibility
1882 public function pageNotFoundHandler($code, $header = '', $reason = '') {
1883 $this->pageErrorHandler($code, $header, $reason);
1887 * Generic error page handler.
1890 * @param mixed $code Which type of handling; If a true PHP-boolean or TRUE then a \TYPO3\CMS\Core\Messaging\ErrorpageMessage is outputted. If integer an error message with that number is shown. Otherwise the $code value is expected to be a "Location:" header value.
1891 * @param string $header If set, this is passed directly to the PHP function, header()
1892 * @param string $reason If set, error messages will also mention this as the reason for the page-not-found.
1893 * @return void (The function exits!)
1894 * @todo Define visibility
1896 public function pageErrorHandler($code, $header = '', $reason = '') {
1897 // Issue header in any case:
1899 $headerArr = preg_split('/\\r|\\n/', $header, -1, PREG_SPLIT_NO_EMPTY
);
1900 foreach ($headerArr as $header) {
1905 // Simply boolean; Just shows TYPO3 error page with reason:
1906 if (gettype($code) == 'boolean' ||
!strcmp($code, 1)) {
1907 $title = 'Page Not Found';
1908 $message = 'The page did not exist or was inaccessible.' . ($reason ?
' Reason: ' . htmlspecialchars($reason) : '');
1909 $messagePage = \TYPO3\CMS\Core\Utility\GeneralUtility
::makeInstance('TYPO3\\CMS\\Core\\Messaging\\ErrorpageMessage', $message, $title);
1910 $messagePage->output();
1912 } elseif (\TYPO3\CMS\Core\Utility\GeneralUtility
::isFirstPartOfStr($code, 'USER_FUNCTION:')) {
1913 $funcRef = trim(substr($code, 14));
1915 'currentUrl' => \TYPO3\CMS\Core\Utility\GeneralUtility
::getIndpEnv('REQUEST_URI'),
1916 'reasonText' => $reason,
1917 'pageAccessFailureReasons' => $this->getPageAccessFailureReasons()
1919 echo \TYPO3\CMS\Core\Utility\GeneralUtility
::callUserFunction($funcRef, $params, $this);
1920 } elseif (\TYPO3\CMS\Core\Utility\GeneralUtility
::isFirstPartOfStr($code, 'READFILE:')) {
1921 $readFile = \TYPO3\CMS\Core\Utility\GeneralUtility
::getFileAbsFileName(trim(substr($code, 9)));
1922 if (@is_file
($readFile)) {
1923 $fileContent = \TYPO3\CMS\Core\Utility\GeneralUtility
::getUrl($readFile);
1924 $fileContent = str_replace('###CURRENT_URL###', \TYPO3\CMS\Core\Utility\GeneralUtility
::getIndpEnv('REQUEST_URI'), $fileContent);
1925 $fileContent = str_replace('###REASON###', htmlspecialchars($reason), $fileContent);
1928 throw new \
RuntimeException('Configuration Error: 404 page "' . $readFile . '" could not be found.', 1294587214);
1930 } elseif (\TYPO3\CMS\Core\Utility\GeneralUtility
::isFirstPartOfStr($code, 'REDIRECT:')) {
1931 \TYPO3\CMS\Core\Utility\HttpUtility
::redirect(substr($code, 9));
1932 } elseif (strlen($code)) {
1933 // Check if URL is relative
1934 $url_parts = parse_url($code);
1935 if ($url_parts['host'] == '') {
1936 $url_parts['host'] = \TYPO3\CMS\Core\Utility\GeneralUtility
::getIndpEnv('HTTP_HOST');
1937 if ($code[0] === '/') {
1938 $code = \TYPO3\CMS\Core\Utility\GeneralUtility
::getIndpEnv('TYPO3_REQUEST_HOST') . $code;
1940 $code = \TYPO3\CMS\Core\Utility\GeneralUtility
::getIndpEnv('TYPO3_REQUEST_DIR') . $code;
1942 $checkBaseTag = FALSE;
1944 $checkBaseTag = TRUE;
1947 if ($code == \TYPO3\CMS\Core\Utility\GeneralUtility
::getIndpEnv('TYPO3_REQUEST_URL')) {
1948 if ($reason == '') {
1949 $reason = 'Page cannot be found.';
1951 $reason .= LF
. LF
. 'Additionally, ' . $code . ' was not found while trying to retrieve the error document.';
1952 throw new \
RuntimeException(nl2br(htmlspecialchars($reason)), 1294587215);
1956 'User-agent: ' . \TYPO3\CMS\Core\Utility\GeneralUtility
::getIndpEnv('HTTP_USER_AGENT'),
1957 'Referer: ' . \TYPO3\CMS\Core\Utility\GeneralUtility
::getIndpEnv('TYPO3_REQUEST_URL')
1959 $res = \TYPO3\CMS\Core\Utility\GeneralUtility
::getUrl($code, 1, $headerArr);
1960 // Header and content are separated by an empty line
1961 list($header, $content) = explode(CRLF
. CRLF
, $res, 2);
1963 if (FALSE === $res) {
1964 // Last chance -- redirect
1965 \TYPO3\CMS\Core\Utility\HttpUtility
::redirect($code);
1967 // Forward these response headers to the client
1968 $forwardHeaders = array(
1971 $headerArr = preg_split('/\\r|\\n/', $header, -1, PREG_SPLIT_NO_EMPTY
);
1972 foreach ($headerArr as $header) {
1973 foreach ($forwardHeaders as $h) {
1974 if (preg_match('/^' . $h . '/', $header)) {
1979 // Put <base> if necesary
1980 if ($checkBaseTag) {
1981 // If content already has <base> tag, we do not need to do anything
1982 if (FALSE === stristr($content, '<base ')) {
1983 // Generate href for base tag
1984 $base = $url_parts['scheme'] . '://';
1985 if ($url_parts['user'] != '') {
1986 $base .= $url_parts['user'];
1987 if ($url_parts['pass'] != '') {
1988 $base .= ':' . $url_parts['pass'];
1992 $base .= $url_parts['host'];
1993 // Add path portion skipping possible file name
1994 $base .= preg_replace('/(.*\\/)[^\\/]*/', '${1}', $url_parts['path']);
1995 // Put it into content (generate also <head> if necessary)
1996 $replacement = LF
. '<base href="' . htmlentities($base) . '" />' . LF
;
1997 if (stristr($content, '<head>')) {
1998 $content = preg_replace('/(<head>)/i', '\\1' . $replacement, $content);
2000 $content = preg_replace('/(<html[^>]*>)/i', '\\1<head>' . $replacement . '</head>', $content);
2004 // Output the content
2008 $title = 'Page Not Found';
2009 $message = $reason ?
'Reason: ' . htmlspecialchars($reason) : 'Page cannot be found.';
2010 $messagePage = \TYPO3\CMS\Core\Utility\GeneralUtility
::makeInstance('TYPO3\\CMS\\Core\\Messaging\\ErrorpageMessage', $message, $title);
2011 $messagePage->output();
2017 * Fetches the integer page id for a page alias.
2018 * Looks if ->id is not an integer and if so it will search for a page alias and if found the page uid of that page is stored in $this->id
2022 * @todo Define visibility
2024 public function checkAndSetAlias() {
2025 if ($this->id
&& !\TYPO3\CMS\Core\Utility\MathUtility
::canBeInterpretedAsInteger($this->id
)) {
2026 $aid = $this->sys_page
->getPageIdFromAlias($this->id
);
2030 $this->pageNotFound
= 4;
2036 * Merging values into the global $_GET
2038 * @param array $GET_VARS Array of key/value pairs that will be merged into the current GET-vars. (Non-escaped values)
2040 * @todo Define visibility
2042 public function mergingWithGetVars($GET_VARS) {
2043 if (is_array($GET_VARS)) {
2044 // Getting $_GET var, unescaped.
2045 $realGet = \TYPO3\CMS\Core\Utility\GeneralUtility
::_GET();
2046 if (!is_array($realGet)) {
2049 // Merge new values on top:
2050 $realGet = \TYPO3\CMS\Core\Utility\GeneralUtility
::array_merge_recursive_overrule($realGet, $GET_VARS);
2051 // Write values back to $_GET:
2052 \TYPO3\CMS\Core\Utility\GeneralUtility
::_GETset($realGet);
2053 // Setting these specifically (like in the init-function):
2054 if (isset($GET_VARS['type'])) {
2055 $this->type
= intval($GET_VARS['type']);
2057 if (isset($GET_VARS['cHash'])) {
2058 $this->cHash
= $GET_VARS['cHash'];
2060 if (isset($GET_VARS['jumpurl'])) {
2061 $this->jumpurl
= $GET_VARS['jumpurl'];
2063 if (isset($GET_VARS['MP'])) {
2064 $this->MP
= $this->TYPO3_CONF_VARS
['FE']['enable_mount_pids'] ?
$GET_VARS['MP'] : '';
2066 if (isset($GET_VARS['no_cache']) && $GET_VARS['no_cache']) {
2067 $this->set_no_cache('no_cache is requested via GET parameter');
2072 /********************************************
2074 * Template and caching related functions.
2076 *******************************************/
2078 * Calculates a hash string based on additional parameters in the url.
2080 * Calculated hash is stored in $this->cHash_array.
2081 * This is used to cache pages with more parameters than just id and type.
2085 * @todo Define visibility
2087 public function makeCacheHash() {
2088 // No need to test anything if caching was already disabled.
2089 if ($this->no_cache
&& !$this->TYPO3_CONF_VARS
['FE']['pageNotFoundOnCHashError']) {
2092 $GET = \TYPO3\CMS\Core\Utility\GeneralUtility
::_GET();
2093 if ($this->cHash
&& is_array($GET)) {
2094 $this->cHash_array
= $this->cacheHash
->getRelevantParameters(\TYPO3\CMS\Core\Utility\GeneralUtility
::implodeArrayForUrl('', $GET));
2095 $cHash_calc = $this->cacheHash
->calculateCacheHash($this->cHash_array
);
2096 if ($cHash_calc != $this->cHash
) {
2097 if ($this->TYPO3_CONF_VARS
['FE']['pageNotFoundOnCHashError']) {
2098 $this->pageNotFoundAndExit('Request parameters could not be validated (&cHash comparison failed)');
2100 $this->disableCache();
2101 $GLOBALS['TT']->setTSlogMessage('The incoming cHash "' . $this->cHash
. '" and calculated cHash "' . $cHash_calc . '" did not match, so caching was disabled. The fieldlist used was "' . implode(',', array_keys($this->cHash_array
)) . '"', 2);
2104 } elseif (is_array($GET)) {
2105 // No cHash is set, check if that is correct
2106 if ($this->cacheHash
->doParametersRequireCacheHash(\TYPO3\CMS\Core\Utility\GeneralUtility
::implodeArrayForUrl('', $GET))) {
2113 * Will disable caching if the cHash value was not set.
2114 * This function should be called to check the _existence_ of "&cHash" whenever a plugin generating cachable output is using extra GET variables. If there _is_ a cHash value the validation of it automatically takes place in makeCacheHash() (see above)
2117 * @see makeCacheHash(), \TYPO3\CMS\Frontend\Plugin\AbstractPlugin::pi_cHashCheck()
2118 * @todo Define visibility
2120 public function reqCHash() {
2121 if (!$this->cHash
) {
2122 if ($this->TYPO3_CONF_VARS
['FE']['pageNotFoundOnCHashError']) {
2123 if ($this->tempContent
) {
2124 $this->clearPageCacheContent();
2126 $this->pageNotFoundAndExit('Request parameters could not be validated (&cHash empty)');
2128 $this->disableCache();
2129 $GLOBALS['TT']->setTSlogMessage('TSFE->reqCHash(): No &cHash parameter was sent for GET vars though required so caching is disabled', 2);
2135 * Initialize the TypoScript template parser
2138 * @todo Define visibility
2140 public function initTemplate() {
2141 $this->tmpl
= \TYPO3\CMS\Core\Utility\GeneralUtility
::makeInstance('TYPO3\\CMS\\Core\\TypoScript\\TemplateService');
2142 $this->tmpl
->init();
2143 $this->tmpl
->tt_track
= $this->beUserLogin ?
1 : 0;
2147 * See if page is in cache and get it if so
2148 * Stores the page content in $this->content if something is found.
2151 * @todo Define visibility
2153 public function getFromCache() {
2154 if (!$this->no_cache
) {
2155 $cc = $this->tmpl
->getCurrentPageData();
2156 if (!is_array($cc)) {
2157 $key = $this->id
. '::' . $this->MP
;
2158 // Returns TRUE if the lock is active now
2159 $isLocked = $this->acquirePageGenerationLock($this->pagesection_lockObj
, $key);
2161 // Lock is no longer active, the data in "cache_pagesection" is now ready
2162 $cc = $this->tmpl
->getCurrentPageData();
2163 if (is_array($cc)) {
2165 $this->releasePageGenerationLock($this->pagesection_lockObj
);
2169 if (is_array($cc)) {
2170 // BE CAREFUL to change the content of the cc-array. This array is serialized and an md5-hash based on this is used for caching the page.
2171 // If this hash is not the same in here in this section and after page-generation, then the page will not be properly cached!
2172 // 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.
2173 $cc = $this->tmpl
->matching($cc);
2179 // clearing the content-variable, which will hold the pagecontent
2180 $this->content
= '';
2181 // Unsetting the lowlevel config
2182 unset($this->config
);
2183 $this->cacheContentFlag
= 0;
2184 // Look for page in cache only if caching is not disabled and if a shift-reload is not sent to the server.
2185 if (!$this->no_cache
&& !$this->headerNoCache()) {
2186 $lockHash = $this->getLockHash();
2188 $this->newHash
= $this->getHash();
2189 $GLOBALS['TT']->push('Cache Row', '');
2190 $row = $this->getFromCache_queryRow();
2191 if (!is_array($row)) {
2192 $isLocked = $this->acquirePageGenerationLock($this->pages_lockObj
, $lockHash);
2194 // Lock is no longer active, the data in "cache_pages" is now ready
2195 $row = $this->getFromCache_queryRow();
2196 if (is_array($row)) {
2198 $this->releasePageGenerationLock($this->pages_lockObj
);
2202 if (is_array($row)) {
2203 // Release this lock
2204 $this->releasePageGenerationLock($this->pages_lockObj
);
2205 // Call hook when a page is retrieved from cache:
2206 if (is_array($this->TYPO3_CONF_VARS
['SC_OPTIONS']['tslib/class.tslib_fe.php']['pageLoadedFromCache'])) {
2207 $_params = array('pObj' => &$this, 'cache_pages_row' => &$row);
2208 foreach ($this->TYPO3_CONF_VARS
['SC_OPTIONS']['tslib/class.tslib_fe.php']['pageLoadedFromCache'] as $_funcRef) {
2209 \TYPO3\CMS\Core\Utility\GeneralUtility
::callUserFunction($_funcRef, $_params, $this);
2212 // Fetches the lowlevel config stored with the cached data
2213 $this->config
= (array) unserialize($row['cache_data']);
2214 // Getting the content
2215 $this->content
= $row['content'];
2216 // Flag for temp content
2217 $this->tempContent
= $row['temp_content'];
2218 // Setting flag, so we know, that some cached content has been loaded
2219 $this->cacheContentFlag
= 1;
2220 $this->cacheExpires
= $row['expires'];
2221 if ($this->TYPO3_CONF_VARS
['FE']['debug'] ||
isset($this->config
['config']['debug']) && $this->config
['config']['debug']) {
2222 $dateFormat = $GLOBALS['TYPO3_CONF_VARS']['SYS']['ddmmyy'];
2223 $timeFormat = $GLOBALS['TYPO3_CONF_VARS']['SYS']['hhmm'];
2224 $this->content
.= LF
. '<!-- Cached page generated ' . date(($dateFormat . ' ' . $timeFormat), $row['tstamp']) . '. Expires ' . Date(($dateFormat . ' ' . $timeFormat), $row['expires']) . ' -->';
2227 $GLOBALS['TT']->pull();
2229 $this->acquirePageGenerationLock($this->pages_lockObj
, $lockHash);
2235 * Returning the cached version of page with hash = newHash
2237 * @return array Cached row, if any. Otherwise void.
2238 * @todo Define visibility
2240 public function getFromCache_queryRow() {
2241 $GLOBALS['TT']->push('Cache Query', '');
2242 $row = $this->pageCache
->get($this->newHash
);
2243 $GLOBALS['TT']->pull();
2248 * Detecting if shift-reload has been clicked
2249 * Will not be called if re-generation of page happens by other reasons (for instance that the page is not in cache yet!)
2250 * Also, a backend user MUST be logged in for the shift-reload to be detected due to DoS-attack-security reasons.
2252 * @return boolean If shift-reload in client browser has been clicked, disable getting cached page (and regenerate it).
2253 * @todo Define visibility
2255 public function headerNoCache() {
2256 $disableAcquireCacheData = FALSE;
2257 if ($this->beUserLogin
) {
2258 if (strtolower($_SERVER['HTTP_CACHE_CONTROL']) === 'no-cache' ||
strtolower($_SERVER['HTTP_PRAGMA']) === 'no-cache') {
2259 $disableAcquireCacheData = TRUE;
2262 // Call hook for possible by-pass of requiring of page cache (for recaching purpose)
2263 if (is_array($this->TYPO3_CONF_VARS
['SC_OPTIONS']['tslib/class.tslib_fe.php']['headerNoCache'])) {
2264 $_params = array('pObj' => &$this, 'disableAcquireCacheData' => &$disableAcquireCacheData);
2265 foreach ($this->TYPO3_CONF_VARS
['SC_OPTIONS']['tslib/class.tslib_fe.php']['headerNoCache'] as $_funcRef) {
2266 \TYPO3\CMS\Core\Utility\GeneralUtility
::callUserFunction($_funcRef, $_params, $this);
2269 return $disableAcquireCacheData;
2273 * Calculates the cache-hash
2274 * This hash is unique to the template, the variables ->id, ->type, ->gr_list (list of groups), ->MP (Mount Points) and cHash array
2275 * Used to get and later store the cached data.
2277 * @return string MD5 hash of $this->hash_base which is a serialized version of there variables.
2279 * @see getFromCache(), getLockHash()
2280 * @todo Define visibility
2282 public function getHash() {
2283 $this->hash_base
= $this->createHashBase(FALSE);
2284 return md5($this->hash_base
);
2288 * Calculates the lock-hash
2289 * This hash is unique to the above hash, except that it doesn't contain the template information in $this->all.
2291 * @return string MD5 hash
2293 * @see getFromCache(), getHash()
2294 * @todo Define visibility
2296 public function getLockHash() {
2297 $lockHash = $this->createHashBase(TRUE);
2298 return md5($lockHash);
2302 * Calculates the cache-hash (or the lock-hash)
2303 * This hash is unique to the template,
2304 * the variables ->id, ->type, ->gr_list (list of groups),
2305 * ->MP (Mount Points) and cHash array
2306 * Used to get and later store the cached data.
2308 * @param boolean $createLockHashBase Whether to create the lock hash, which doesn't contain the "this->all" (the template information)
2309 * @return string the serialized hash base
2311 protected function createHashBase($createLockHashBase = FALSE) {
2312 $hashParameters = array(
2313 'id' => intval($this->id
),
2314 'type' => intval($this->type
),
2315 'gr_list' => (string) $this->gr_list
,
2316 'MP' => (string) $this->MP
,
2317 'cHash' => $this->cHash_array
,
2318 'domainStartPage' => $this->domainStartPage
2320 // Include the template information if we shouldn't create a lock hash
2321 if (!$createLockHashBase) {
2322 $hashParameters['all'] = $this->all
;
2324 // Call hook to influence the hash calculation
2325 if (is_array($this->TYPO3_CONF_VARS
['SC_OPTIONS']['tslib/class.tslib_fe.php']['createHashBase'])) {
2327 'hashParameters' => &$hashParameters,
2328 'createLockHashBase' => $createLockHashBase
2330 foreach ($this->TYPO3_CONF_VARS
['SC_OPTIONS']['tslib/class.tslib_fe.php']['createHashBase'] as $_funcRef) {
2331 \TYPO3\CMS\Core\Utility\GeneralUtility
::callUserFunction($_funcRef, $_params, $this);
2334 return serialize($hashParameters);
2338 * Checks if config-array exists already but if not, gets it
2341 * @todo Define visibility
2343 public function getConfigArray() {
2344 $setStatPageName = FALSE;
2345 // If config is not set by the cache (which would be a major mistake somewhere) OR if INTincScripts-include-scripts have been registered, then we must parse the template in order to get it
2346 if (!is_array($this->config
) ||
is_array($this->config
['INTincScript']) ||
$this->forceTemplateParsing
) {
2347 $GLOBALS['TT']->push('Parse template', '');
2348 // Force parsing, if set?:
2349 $this->tmpl
->forceTemplateParsing
= $this->forceTemplateParsing
;
2350 // Start parsing the TS template. Might return cached version.
2351 $this->tmpl
->start($this->rootLine
);
2352 $GLOBALS['TT']->pull();
2353 if ($this->tmpl
->loaded
) {
2354 $GLOBALS['TT']->push('Setting the config-array', '');
2355 // toplevel - objArrayName
2356 $this->sPre
= $this->tmpl
->setup
['types.'][$this->type
];
2357 $this->pSetup
= $this->tmpl
->setup
[$this->sPre
. '.'];
2358 if (!is_array($this->pSetup
)) {
2359 $message = 'The page is not configured! [type=' . $this->type
. '][' . $this->sPre
. '].';
2360 if ($this->checkPageUnavailableHandler()) {
2361 $this->pageUnavailableAndExit($message);
2363 $explanation = 'This means that there is no TypoScript object of type PAGE with typeNum=' . $this->type
. ' configured.';
2364 \TYPO3\CMS\Core\Utility\GeneralUtility
::sysLog($message, 'cms', \TYPO3\CMS\Core\Utility\GeneralUtility
::SYSLOG_SEVERITY_ERROR
);
2365 throw new \TYPO3\CMS\Core\Error\Http\
ServiceUnavailableException($message . ' ' . $explanation, 1294587217);
2368 $this->config
['config'] = array();
2369 // Filling the config-array, first with the main "config." part
2370 if (is_array($this->tmpl
->setup
['config.'])) {
2371 $this->config
['config'] = $this->tmpl
->setup
['config.'];
2373 // override it with the page/type-specific "config."
2374 if (is_array($this->pSetup
['config.'])) {
2375 $this->config
['config'] = \TYPO3\CMS\Core\Utility\GeneralUtility
::array_merge_recursive_overrule($this->config
['config'], $this->pSetup
['config.']);
2377 if ($this->config
['config']['typolinkEnableLinksAcrossDomains']) {
2378 $this->config
['config']['typolinkCheckRootline'] = TRUE;
2380 // Set default values for removeDefaultJS and inlineStyle2TempFile so CSS and JS are externalized if compatversion is higher than 4.0
2381 if (\TYPO3\CMS\Core\Utility\GeneralUtility
::compat_version('4.0')) {
2382 if (!isset($this->config
['config']['removeDefaultJS'])) {
2383 $this->config
['config']['removeDefaultJS'] = 'external';
2385 if (!isset($this->config
['config']['inlineStyle2TempFile'])) {
2386 $this->config
['config']['inlineStyle2TempFile'] = 1;
2389 if (!isset($this->config
['config']['compressJs'])) {
2390 $this->config
['config']['compressJs'] = 0;
2392 // Processing for the config_array:
2393 $this->config
['rootLine'] = $this->tmpl
->rootLine
;
2394 $this->config
['mainScript'] = trim($this->config
['config']['mainScript']) ?
trim($this->config
['config']['mainScript']) : 'index.php';
2395 // Class for render Header and Footer parts
2397 if ($this->pSetup
['pageHeaderFooterTemplateFile']) {
2398 $file = $this->tmpl
->getFileName($this->pSetup
['pageHeaderFooterTemplateFile']);
2400 $this->setTemplateFile($file);
2404 $GLOBALS['TT']->pull();
2406 if ($this->checkPageUnavailableHandler()) {
2407 $this->pageUnavailableAndExit('No TypoScript template found!');
2409 $message = 'No TypoScript template found!';
2410 \TYPO3\CMS\Core\Utility\GeneralUtility
::sysLog($message, 'cms', \TYPO3\CMS\Core\Utility\GeneralUtility
::SYSLOG_SEVERITY_ERROR
);
2411 throw new \TYPO3\CMS\Core\Error\Http\
ServiceUnavailableException($message, 1294587218);
2415 // Initialize charset settings etc.
2416 $this->initLLvars();
2418 // Set $this->no_cache TRUE if the config.no_cache value is set!
2419 if ($this->config
['config']['no_cache']) {
2420 $this->set_no_cache('config.no_cache is set');
2422 // Merge GET with defaultGetVars
2423 if (!empty($this->config
['config']['defaultGetVars.'])) {
2424 $modifiedGetVars = \TYPO3\CMS\Core\Utility\GeneralUtility
::array_merge_recursive_overrule(\TYPO3\CMS\Core\Utility\GeneralUtility
::removeDotsFromTS($this->config
['config']['defaultGetVars.']), \TYPO3\CMS\Core\Utility\GeneralUtility
::_GET());
2425 \TYPO3\CMS\Core\Utility\GeneralUtility
::_GETset($modifiedGetVars);
2427 // Hook for postProcessing the configuration array
2428 if (is_array($this->TYPO3_CONF_VARS
['SC_OPTIONS']['tslib/class.tslib_fe.php']['configArrayPostProc'])) {
2429 $params = array('config' => &$this->config
['config']);
2430 foreach ($this->TYPO3_CONF_VARS
['SC_OPTIONS']['tslib/class.tslib_fe.php']['configArrayPostProc'] as $funcRef) {
2431 \TYPO3\CMS\Core\Utility\GeneralUtility
::callUserFunction($funcRef, $params, $this);
2436 /********************************************
2438 * Further initialization and data processing
2439 * (jumpurl/submission of forms)
2441 *******************************************/
2444 * Get the compressed $GLOBALS['TCA'] array for use in the front-end
2445 * A compressed $GLOBALS['TCA'] array holds only the ctrl- and feInterface-part for each table.
2446 * But the column-definitions are omitted in order to save some memory and be more efficient.
2447 * Operates on the global variable, $TCA
2450 * @deprecated since 6,1, will be removed in two versions.
2452 public function getCompressedTCarray() {
2453 // Full TCA is always loaded during bootstrap in FE, this method is obsolete.
2454 \TYPO3\CMS\Core\Utility\GeneralUtility
::logDeprecatedFunction();
2458 * Includes TCA definitions from loaded extensions (ext_table.php files).
2459 * Normally in the frontend only a part of the global $TCA array is loaded,
2460 * namely the "ctrl" part. Thus it doesn't take up too much memory. To load
2461 * full TCA for the table, use \TYPO3\CMS\Core\Utility\GeneralUtility::loadTCA($tableName)
2462 * after calling this function.
2464 * @param integer $TCAloaded Probably, keep hands of this value. Just don't set it.
2466 * @see getCompressedTCarray()
2467 * @deprecated since 6.1, will be removed in two versions. Obsolete in regular frontend, eid scripts should use \TYPO3\CMS\Frontend\Utility\EidUtility::initTCA()
2469 public function includeTCA($TCAloaded = 1) {
2470 // Full TCA is always loaded during bootstrap in FE, this method is obsolete.
2471 \TYPO3\CMS\Core\Utility\GeneralUtility
::logDeprecatedFunction();
2473 // Compatibility layer:
2474 // The if below is NOT true in usual frontend (non eid) context, TCA is loaded by bootstrap.
2475 // If an eid script calls this method to load TCA, use
2476 // \TYPO3\CMS\Frontend\Utility\EidUtility::initTCA() instead.
2477 if (!isset($GLOBALS['TCA']['pages'])) {
2478 \TYPO3\CMS\Core\Core\Bootstrap
::getInstance()->loadCachedTca();
2483 * Setting the language key that will be used by the current page.
2484 * In this function it should be checked, 1) that this language exists, 2) that a page_overlay_record exists, .. and if not the default language, 0 (zero), should be set.
2488 * @todo Define visibility
2490 public function settingLanguage() {
2491 if (is_array($this->TYPO3_CONF_VARS
['SC_OPTIONS']['tslib/class.tslib_fe.php']['settingLanguage_preProcess'])) {
2493 foreach ($this->TYPO3_CONF_VARS
['SC_OPTIONS']['tslib/class.tslib_fe.php']['settingLanguage_preProcess'] as $_funcRef) {
2494 \TYPO3\CMS\Core\Utility\GeneralUtility
::callUserFunction($_funcRef, $_params, $this);
2497 // Get values from TypoScript:
2498 $this->sys_language_uid
= ($this->sys_language_content
= intval($this->config
['config']['sys_language_uid']));
2499 list($this->sys_language_mode
, $sys_language_content) = \TYPO3\CMS\Core\Utility\GeneralUtility
::trimExplode(';', $this->config
['config']['sys_language_mode']);
2500 $this->sys_language_contentOL
= $this->config
['config']['sys_language_overlay'];
2501 // If sys_language_uid is set to another language than default:
2502 if ($this->sys_language_uid
> 0) {
2503 // check whether a shortcut is overwritten by a translated page
2504 // we can only do this now, as this is the place where we get
2505 // to know about translations
2506 $this->checkTranslatedShortcut();
2507 // Request the overlay record for the sys_language_uid:
2508 $olRec = $this->sys_page
->getPageOverlay($this->id
, $this->sys_language_uid
);
2509 if (!count($olRec)) {
2510 // If no OL record exists and a foreign language is asked for...
2511 if ($this->sys_language_uid
) {
2512 // If requested translation is not available:
2513 if (\TYPO3\CMS\Core\Utility\GeneralUtility
::hideIfNotTranslated($this->page
['l18n_cfg'])) {
2514 $this->pageNotFoundAndExit('Page is not available in the requested language.');
2516 switch ((string) $this->sys_language_mode
) {
2518 $this->pageNotFoundAndExit('Page is not available in the requested language (strict).');
2520 case 'content_fallback':
2521 $fallBackOrder = \TYPO3\CMS\Core\Utility\GeneralUtility
::intExplode(',', $sys_language_content);
2522 foreach ($fallBackOrder as $orderValue) {
2523 if (!strcmp($orderValue, '0') ||
count($this->sys_page
->getPageOverlay($this->id
, $orderValue))) {
2524 $this->sys_language_content
= $orderValue;
2525 // Setting content uid (but leaving the sys_language_uid)
2531 $this->sys_language_content
= $this->sys_language_uid
;
2534 // Default is that everything defaults to the default language...
2535 $this->sys_language_uid
= ($this->sys_language_content
= 0);
2541 // Setting sys_language if an overlay record was found (which it is only if a language is used)
2542 $this->page
= $this->sys_page
->getPageOverlay($this->page
, $this->sys_language_uid
);
2545 // Setting sys_language_uid inside sys-page:
2546 $this->sys_page
->sys_language_uid
= $this->sys_language_uid
;
2547 // If default translation is not available:
2548 if ((!$this->sys_language_uid ||
!$this->sys_language_content
) && $this->page
['l18n_cfg'] & 1) {
2549 $message = 'Page is not available in default language.';
2550 \TYPO3\CMS\Core\Utility\GeneralUtility
::sysLog($message, 'cms', \TYPO3\CMS\Core\Utility\GeneralUtility
::SYSLOG_SEVERITY_ERROR
);
2551 $this->pageNotFoundAndExit($message);
2553 $this->updateRootLinesWithTranslations();
2554 // Finding the ISO code:
2555 if (\TYPO3\CMS\Core\Utility\ExtensionManagementUtility
::isLoaded('static_info_tables') && $this->sys_language_content
) {
2556 // using sys_language_content because the ISO code only (currently) affect content selection from FlexForms - which should follow "sys_language_content"
2557 $sys_language_row = $this->sys_page
->getRawRecord('sys_language', $this->sys_language_content
, 'static_lang_isocode');
2558 if (is_array($sys_language_row) && $sys_language_row['static_lang_isocode']) {
2559 $stLrow = $this->sys_page
->getRawRecord('static_languages', $sys_language_row['static_lang_isocode'], 'lg_iso_2');
2560 $this->sys_language_isocode
= $stLrow['lg_iso_2'];
2563 // Setting softMergeIfNotBlank:
2564 $table_fields = \TYPO3\CMS\Core\Utility\GeneralUtility
::trimExplode(',', $this->config
['config']['sys_language_softMergeIfNotBlank'], 1);
2565 foreach ($table_fields as $TF) {
2566 list($tN, $fN) = explode(':', $TF);
2567 $GLOBALS['TCA'][$tN]['columns'][$fN]['l10n_mode'] = 'mergeIfNotBlank';
2569 // Setting softExclude:
2570 $table_fields = \TYPO3\CMS\Core\Utility\GeneralUtility
::trimExplode(',', $this->config
['config']['sys_language_softExclude'], 1);
2571 foreach ($table_fields as $TF) {
2572 list($tN, $fN) = explode(':', $TF);
2573 $GLOBALS['TCA'][$tN]['columns'][$fN]['l10n_mode'] = 'exclude';
2575 if (is_array($this->TYPO3_CONF_VARS
['SC_OPTIONS']['tslib/class.tslib_fe.php']['settingLanguage_postProcess'])) {
2577 foreach ($this->TYPO3_CONF_VARS
['SC_OPTIONS']['tslib/class.tslib_fe.php']['settingLanguage_postProcess'] as $_funcRef) {
2578 \TYPO3\CMS\Core\Utility\GeneralUtility
::callUserFunction($_funcRef, $_params, $this);
2584 * Updating content of the two rootLines IF the language key is set!
2586 protected function updateRootLinesWithTranslations() {
2587 if ($this->sys_language_uid
) {
2588 $this->rootLine
= $this->sys_page
->getRootLine($this->id
, $this->MP
);
2589 $this->tmpl
->updateRootlineData($this->rootLine
);
2594 * Setting locale for frontend rendering
2597 * @todo Define visibility
2599 public function settingLocale() {
2601 if ($this->config
['config']['locale_all']) {
2602 // There's a problem that PHP parses float values in scripts wrong if the
2603 // locale LC_NUMERIC is set to something with a comma as decimal point
2604 // Do we set all except LC_NUMERIC
2605 $locale = setlocale(LC_COLLATE
, $this->config
['config']['locale_all']);
2607 // PHP fatals with uppercase I characters in method names with turkish locale LC_CTYPE
2608 // @see http://bugs.php.net/bug.php?id=35050
2609 if (substr($this->config
['config']['locale_all'], 0, 2) != 'tr') {
2610 setlocale(LC_CTYPE
, $this->config
['config']['locale_all']);
2612 setlocale(LC_MONETARY
, $this->config
['config']['locale_all']);
2613 setlocale(LC_TIME
, $this->config
['config']['locale_all']);
2614 $this->localeCharset
= $this->csConvObj
->get_locale_charset($this->config
['config']['locale_all']);
2616 $GLOBALS['TT']->setTSlogMessage('Locale "' . htmlspecialchars($this->config
['config']['locale_all']) . '" not found.', 3);
2622 * Checks whether a translated shortcut page has a different shortcut
2623 * target than the original language page.
2624 * If that is the case, things get corrected to follow that alternative
2628 * @author Ingo Renner <ingo@typo3.org>
2630 protected function checkTranslatedShortcut() {
2631 if (!is_null($this->originalShortcutPage
)) {
2632 $originalShortcutPageOverlay = $this->sys_page
->getPageOverlay($this->originalShortcutPage
['uid'], $this->sys_language_uid
);
2633 if (!empty($originalShortcutPageOverlay['shortcut']) && $originalShortcutPageOverlay['shortcut'] != $this->id
) {
2634 // the translation of the original shortcut page has a different shortcut target!
2635 // set the correct page and id
2636 $shortcut = $this->getPageShortcut($originalShortcutPageOverlay['shortcut'], $originalShortcutPageOverlay['shortcut_mode'], $originalShortcutPageOverlay['uid']);
2637 $this->id
= ($this->contentPid
= $shortcut['uid']);
2638 $this->page
= $this->sys_page
->getPage($this->id
);
2639 // Fix various effects on things like menus f.e.
2640 $this->fetch_the_id();
2641 $this->tmpl
->rootLine
= array_reverse($this->rootLine
);
2647 * Handle data submission
2651 public function handleDataSubmission() {
2652 // Check Submission of data.
2653 // This is done at this point, because we need the config values
2654 switch ($this->checkDataSubmission()) {
2656 $this->sendFormmail();
2662 * Checks if any email-submissions
2664 * @return string "email" if a formmail has been sent, "" if none.
2666 protected function checkDataSubmission() {
2668 $formtype_mail = isset($_POST['formtype_mail']) ||
isset($_POST['formtype_mail_x']);
2669 if ($formtype_mail) {
2670 $refInfo = parse_url(\TYPO3\CMS\Core\Utility\GeneralUtility
::getIndpEnv('HTTP_REFERER'));
2671 if (\TYPO3\CMS\Core\Utility\GeneralUtility
::getIndpEnv('TYPO3_HOST_ONLY') == $refInfo['host'] ||
$this->TYPO3_CONF_VARS
['SYS']['doNotCheckReferer']) {
2672 if ($this->locDataCheck($_POST['locationData'])) {
2673 if ($formtype_mail) {
2676 $GLOBALS['TT']->setTSlogMessage('"Check Data Submission": Return value: ' . $ret, 0);
2680 $GLOBALS['TT']->setTSlogMessage('"Check Data Submission": HTTP_HOST and REFERER HOST did not match when processing submitted formdata!', 3);
2683 // Hook for processing data submission to extensions:
2684 if (is_array($this->TYPO3_CONF_VARS
['SC_OPTIONS']['tslib/class.tslib_fe.php']['checkDataSubmission'])) {
2685 foreach ($this->TYPO3_CONF_VARS
['SC_OPTIONS']['tslib/class.tslib_fe.php']['checkDataSubmission'] as $_classRef) {
2686 $_procObj = \TYPO3\CMS\Core\Utility\GeneralUtility
::getUserObj($_classRef);
2687 $_procObj->checkDataSubmission($this);
2694 * Processes submitted user data (obsolete "Frontend TCE")
2698 * @deprecated since 6.0, will be removed two versions later
2699 * @todo Define visibility
2701 public function fe_tce() {
2702 \TYPO3\CMS\Core\Utility\GeneralUtility
::logDeprecatedFunction();
2706 * Checks if a formmail submission can be sent as email
2708 * @param string $locationData The input from $_POST['locationData']
2711 * @see checkDataSubmission()
2712 * @todo Define visibility
2714 public function locDataCheck($locationData) {
2715 $locData = explode(':', $locationData);
2716 if (!$locData[1] ||
$this->sys_page
->checkRecord($locData[1], $locData[2], 1)) {
2717 // $locData[1] -check means that a record is checked only if the locationData has a value for a record else than the page.
2718 if (count($this->sys_page
->getPage($locData[0]))) {
2721 $GLOBALS['TT']->setTSlogMessage('LocationData Error: The page pointed to by location data (' . $locationData . ') was not accessible.', 2);
2724 $GLOBALS['TT']->setTSlogMessage('LocationData Error: Location data (' . $locationData . ') record pointed to was not accessible.', 2);
2729 * Sends the emails from the formmail content object.
2732 * @see checkDataSubmission()
2734 protected function sendFormmail() {
2735 /** @var $formmail \TYPO3\CMS\Frontend\Controller\DataSubmissionController */
2736 $formmail = \TYPO3\CMS\Core\Utility\GeneralUtility
::makeInstance('TYPO3\\CMS\\Frontend\\Controller\\DataSubmissionController');
2737 $EMAIL_VARS = \TYPO3\CMS\Core\Utility\GeneralUtility
::_POST();
2738 $locationData = $EMAIL_VARS['locationData'];
2739 unset($EMAIL_VARS['locationData']);
2740 unset($EMAIL_VARS['formtype_mail'], $EMAIL_VARS['formtype_mail_x'], $EMAIL_VARS['formtype_mail_y']);
2741 $integrityCheck = $this->TYPO3_CONF_VARS
['FE']['strictFormmail'];
2742 if (!$this->TYPO3_CONF_VARS
['FE']['secureFormmail']) {
2743 // Check recipient field:
2744 // These two fields are the ones which contain recipient addresses that can be misused to send mail from foreign servers.
2745 $encodedFields = explode(',', 'recipient, recipient_copy');
2746 foreach ($encodedFields as $fieldKey) {
2747 if (strlen($EMAIL_VARS[$fieldKey])) {
2749 if ($res = $this->codeString($EMAIL_VARS[$fieldKey], TRUE)) {
2750 $EMAIL_VARS[$fieldKey] = $res;
2751 } elseif ($integrityCheck) {
2753 $GLOBALS['TT']->setTSlogMessage('"Formmail" discovered a field (' . $fieldKey . ') which could not be decoded to a valid string. Sending formmail aborted due to security reasons!', 3);
2756 $GLOBALS['TT']->setTSlogMessage('"Formmail" discovered a field (' . $fieldKey . ') which could not be decoded to a valid string. The security level accepts this, but you should consider a correct coding though!', 2);
2761 $locData = explode(':', $locationData);