[CLEANUP] MENU Content Object classes
[Packages/TYPO3.CMS.git] / typo3 / sysext / frontend / Classes / Controller / TypoScriptFrontendController.php
1 <?php
2 namespace TYPO3\CMS\Frontend\Controller;
3
4 /*
5 * This file is part of the TYPO3 CMS project.
6 *
7 * It is free software; you can redistribute it and/or modify it under
8 * the terms of the GNU General Public License, either version 2
9 * of the License, or any later version.
10 *
11 * For the full copyright and license information, please read the
12 * LICENSE.txt file that was distributed with this source code.
13 *
14 * The TYPO3 project - inspiring people to share!
15 */
16
17 use TYPO3\CMS\Core\Error\Http\PageNotFoundException;
18 use TYPO3\CMS\Core\Utility\GeneralUtility;
19 use TYPO3\CMS\Core\Utility\HttpUtility;
20 use TYPO3\CMS\Core\Utility\MathUtility;
21 use TYPO3\CMS\Frontend\Page\PageRepository;
22
23 /**
24 * Class for the built TypoScript based frontend. Instantiated in
25 * index_ts.php script as the global object TSFE.
26 *
27 * Main frontend class, instantiated in the index_ts.php script as the global
28 * object TSFE.
29 *
30 * This class has a lot of functions and internal variable which are used from
31 * index_ts.php.
32 *
33 * The class is instantiated as $GLOBALS['TSFE'] in index_ts.php.
34 *
35 * The use of this class should be inspired by the order of function calls as
36 * found in index_ts.php.
37 *
38 * @author Kasper Skårhøj <kasperYYYY@typo3.com>
39 */
40 class TypoScriptFrontendController {
41
42 /**
43 * The page id (int)
44 * @var string
45 */
46 public $id = '';
47
48 /**
49 * The type (read-only)
50 * @var int
51 */
52 public $type = '';
53
54 /**
55 * The submitted cHash
56 * @var string
57 */
58 public $cHash = '';
59
60 /**
61 * Page will not be cached. Write only TRUE. Never clear value (some other
62 * code might have reasons to set it TRUE).
63 * @var bool
64 */
65 public $no_cache = FALSE;
66
67 /**
68 * The rootLine (all the way to tree root, not only the current site!)
69 * @var array
70 */
71 public $rootLine = '';
72
73 /**
74 * The pagerecord
75 * @var array
76 */
77 public $page = '';
78
79 /**
80 * This will normally point to the same value as id, but can be changed to
81 * point to another page from which content will then be displayed instead.
82 * @var int
83 */
84 public $contentPid = 0;
85
86 /**
87 * Gets set when we are processing a page of type mounpoint with enabled overlay in getPageAndRootline()
88 * Used later in checkPageForMountpointRedirect() to determine the final target URL where the user
89 * should be redirected to.
90 *
91 * @var array|NULL
92 */
93 protected $originalMountPointPage = NULL;
94
95 /**
96 * Gets set when we are processing a page of type shortcut in the early stages
97 * opf init.php when we do not know about languages yet, used later in init.php
98 * to determine the correct shortcut in case a translation changes the shortcut
99 * target
100 * @var array|NULL
101 */
102 protected $originalShortcutPage = NULL;
103
104 /**
105 * sys_page-object, pagefunctions
106 *
107 * @var PageRepository
108 */
109 public $sys_page = '';
110
111 /**
112 * @var string
113 */
114 public $jumpurl = '';
115
116 /**
117 * Is set to 1 if a pageNotFound handler could have been called.
118 * @var int
119 */
120 public $pageNotFound = 0;
121
122 /**
123 * Domain start page
124 * @var int
125 */
126 public $domainStartPage = 0;
127
128 /**
129 * Array containing a history of why a requested page was not accessible.
130 * @var array
131 */
132 public $pageAccessFailureHistory = array();
133
134 /**
135 * @var string
136 */
137 public $MP = '';
138
139 /**
140 * @var string
141 */
142 public $RDCT = '';
143
144 /**
145 * This can be set from applications as a way to tag cached versions of a page
146 * and later perform some external cache management, like clearing only a part
147 * of the cache of a page...
148 * @var int
149 */
150 public $page_cache_reg1 = 0;
151
152 /**
153 * Contains the value of the current script path that activated the frontend.
154 * Typically "index.php" but by rewrite rules it could be something else! Used
155 * for Speaking Urls / Simulate Static Documents.
156 * @var string
157 */
158 public $siteScript = '';
159
160 /**
161 * The frontend user
162 *
163 * @var \TYPO3\CMS\Frontend\Authentication\FrontendUserAuthentication
164 */
165 public $fe_user = '';
166
167 /**
168 * Global flag indicating that a frontend user is logged in. This is set only if
169 * a user really IS logged in. The group-list may show other groups (like added
170 * by IP filter or so) even though there is no user.
171 * @var bool
172 */
173 public $loginUser = FALSE;
174
175 /**
176 * (RO=readonly) The group list, sorted numerically. Group '0,-1' is the default
177 * group, but other groups may be added by other means than a user being logged
178 * in though...
179 * @var string
180 */
181 public $gr_list = '';
182
183 /**
184 * Flag that indicates if a backend user is logged in!
185 * @var bool
186 */
187 public $beUserLogin = FALSE;
188
189 /**
190 * Integer, that indicates which workspace is being previewed.
191 * @var int
192 */
193 public $workspacePreview = 0;
194
195 /**
196 * Shows whether logins are allowed in branch
197 * @var bool
198 */
199 public $loginAllowedInBranch = TRUE;
200
201 /**
202 * Shows specific mode (all or groups)
203 * @var string
204 */
205 public $loginAllowedInBranch_mode = '';
206
207 /**
208 * Set to backend user ID to initialize when keyword-based preview is used
209 * @var int
210 */
211 public $ADMCMD_preview_BEUSER_uid = 0;
212
213 /**
214 * Flag indication that preview is active. This is based on the login of a
215 * backend user and whether the backend user has read access to the current
216 * page. A value of 1 means ordinary preview, 2 means preview of a non-live
217 * workspace
218 * @var int
219 */
220 public $fePreview = 0;
221
222 /**
223 * Flag indicating that hidden pages should be shown, selected and so on. This
224 * goes for almost all selection of pages!
225 * @var bool
226 */
227 public $showHiddenPage = FALSE;
228
229 /**
230 * Flag indicating that hidden records should be shown. This includes
231 * sys_template, pages_language_overlay and even fe_groups in addition to all
232 * other regular content. So in effect, this includes everything except pages.
233 * @var bool
234 */
235 public $showHiddenRecords = FALSE;
236
237 /**
238 * Value that contains the simulated usergroup if any
239 * @var int
240 */
241 public $simUserGroup = 0;
242
243 /**
244 * Copy of $GLOBALS['TYPO3_CONF_VARS']
245 *
246 * @var array
247 */
248 public $TYPO3_CONF_VARS = array();
249
250 /**
251 * "CONFIG" object from TypoScript. Array generated based on the TypoScript
252 * configuration of the current page. Saved with the cached pages.
253 * @var array
254 */
255 public $config = '';
256
257 /**
258 * The TypoScript template object. Used to parse the TypoScript template
259 *
260 * @var \TYPO3\CMS\Core\TypoScript\TemplateService
261 */
262 public $tmpl = NULL;
263
264 /**
265 * Is set to the time-to-live time of cached pages. If FALSE, default is
266 * 60*60*24, which is 24 hours.
267 * @var bool|int
268 */
269 public $cacheTimeOutDefault = FALSE;
270
271 /**
272 * Set internally if cached content is fetched from the database
273 * @var bool
274 * @internal
275 */
276 public $cacheContentFlag = FALSE;
277
278 /**
279 * Set to the expire time of cached content
280 * @var int
281 */
282 public $cacheExpires = 0;
283
284 /**
285 * Set if cache headers allowing caching are sent.
286 * @var bool
287 */
288 public $isClientCachable = FALSE;
289
290 /**
291 * Used by template fetching system. This array is an identification of
292 * the template. If $this->all is empty it's because the template-data is not
293 * cached, which it must be.
294 * @var array
295 */
296 public $all = array();
297
298 /**
299 * Toplevel - objArrayName, eg 'page'
300 * @var string
301 */
302 public $sPre = '';
303
304 /**
305 * TypoScript configuration of the page-object pointed to by sPre.
306 * $this->tmpl->setup[$this->sPre.'.']
307 * @var array
308 */
309 public $pSetup = '';
310
311 /**
312 * This hash is unique to the template, the $this->id and $this->type vars and
313 * the gr_list (list of groups). Used to get and later store the cached data
314 * @var string
315 */
316 public $newHash = '';
317
318 /**
319 * If config.ftu (Frontend Track User) is set in TypoScript for the current
320 * page, the string value of this var is substituted in the rendered source-code
321 * with the string, '&ftu=[token...]' which enables GET-method usertracking as
322 * opposed to cookie based
323 * @var string
324 */
325 public $getMethodUrlIdToken = '';
326
327 /**
328 * This flag is set before inclusion of pagegen.php IF no_cache is set. If this
329 * flag is set after the inclusion of pagegen.php, no_cache is forced to be set.
330 * This is done in order to make sure that php-code from pagegen does not falsely
331 * clear the no_cache flag.
332 * @var bool
333 */
334 public $no_cacheBeforePageGen = FALSE;
335
336 /**
337 * This flag indicates if temporary content went into the cache during
338 * page-generation.
339 * @var mixed
340 */
341 public $tempContent = FALSE;
342
343 /**
344 * Passed to TypoScript template class and tells it to force template rendering
345 * @var bool
346 */
347 public $forceTemplateParsing = FALSE;
348
349 /**
350 * The array which cHash_calc is based on, see ->makeCacheHash().
351 * @var array
352 */
353 public $cHash_array = array();
354
355 /**
356 * May be set to the pagesTSconfig
357 * @var array
358 */
359 public $pagesTSconfig = '';
360
361 /**
362 * Eg. insert JS-functions in this array ($additionalHeaderData) to include them
363 * once. Use associative keys.
364 *
365 * Keys in use:
366 *
367 * JSFormValidate: <script type="text/javascript" src="'.$GLOBALS["TSFE"]->absRefPrefix.'typo3/sysext/frontend/Resources/Public/JavaScript/jsfunc.validateform.js"></script>
368 * JSMenuCode, JSMenuCode_menu: JavaScript for the JavaScript menu
369 * JSCode: reserved
370 *
371 * used to accumulate additional HTML-code for the header-section,
372 * <head>...</head>. Insert either associative keys (like
373 * additionalHeaderData['myStyleSheet'], see reserved keys above) or num-keys
374 * (like additionalHeaderData[] = '...')
375 *
376 * @var array
377 */
378 public $additionalHeaderData = array();
379
380 /**
381 * Used to accumulate additional HTML-code for the footer-section of the template
382 * @var array
383 */
384 public $additionalFooterData = array();
385
386 /**
387 * Used to accumulate additional JavaScript-code. Works like
388 * additionalHeaderData. Reserved keys at 'openPic' and 'mouseOver'
389 *
390 * @var array
391 */
392 public $additionalJavaScript = array();
393
394 /**
395 * Used to accumulate additional Style code. Works like additionalHeaderData.
396 *
397 * @var array
398 */
399 public $additionalCSS = array();
400
401 /**
402 * You can add JavaScript functions to each entry in these arrays. Please see
403 * how this is done in the GMENU_LAYERS script. The point is that many
404 * applications on a page can set handlers for onload, onmouseover and onmouseup
405 *
406 * @var array
407 * @deprecated since TYPO3 CMS 7, will be removed in TYPO3 CMS 8
408 */
409 public $JSeventFuncCalls = array(
410 'onmousemove' => array(),
411 'onmouseup' => array(),
412 'onkeydown' => array(),
413 'onkeyup' => array(),
414 'onkeypress' => array(),
415 'onload' => array(),
416 'onunload' => array()
417 );
418
419 /**
420 * Used to accumulate DHTML-layers.
421 * @var string
422 */
423 public $divSection = '';
424
425 /**
426 * Default bodytag, if nothing else is set. This can be overridden by
427 * applications like TemplaVoila.
428 * @var string
429 */
430 public $defaultBodyTag = '<body>';
431
432 /**
433 * Debug flag, may output special debug html-code.
434 * @var string
435 */
436 public $debug = '';
437
438 /**
439 * Default internal target
440 * @var string
441 */
442 public $intTarget = '';
443
444 /**
445 * Default external target
446 * @var string
447 */
448 public $extTarget = '';
449
450 /**
451 * Default file link target
452 * @var string
453 */
454 public $fileTarget = '';
455
456 /**
457 * Keys are page ids and values are default &MP (mount point) values to set
458 * when using the linking features...)
459 * @var array
460 */
461 public $MP_defaults = array();
462
463 /**
464 * If set, typolink() function encrypts email addresses. Is set in pagegen-class.
465 * @var string|int
466 */
467 public $spamProtectEmailAddresses = 0;
468
469 /**
470 * Absolute Reference prefix
471 * @var string
472 */
473 public $absRefPrefix = '';
474
475 /**
476 * Factor for form-field widths compensation
477 * @var string
478 */
479 public $compensateFieldWidth = '';
480
481 /**
482 * Lock file path
483 * @var string
484 */
485 public $lockFilePath = '';
486
487 /**
488 * <A>-tag parameters
489 * @var string
490 */
491 public $ATagParams = '';
492
493 /**
494 * Search word regex, calculated if there has been search-words send. This is
495 * used to mark up the found search words on a page when jumped to from a link
496 * in a search-result.
497 * @var string
498 */
499 public $sWordRegEx = '';
500
501 /**
502 * Is set to the incoming array sword_list in case of a page-view jumped to from
503 * a search-result.
504 * @var string
505 */
506 public $sWordList = '';
507
508 /**
509 * A string prepared for insertion in all links on the page as url-parameters.
510 * Based on configuration in TypoScript where you defined which GET_VARS you
511 * would like to pass on.
512 * @var string
513 */
514 public $linkVars = '';
515
516 /**
517 * A string set with a comma list of additional GET vars which should NOT be
518 * included in the cHash calculation. These vars should otherwise be detected
519 * and involved in caching, eg. through a condition in TypoScript.
520 * @var string
521 */
522 public $excludeCHashVars = '';
523
524 /**
525 * If set, edit icons are rendered aside content records. Must be set only if
526 * the ->beUserLogin flag is set and set_no_cache() must be called as well.
527 * @var string
528 */
529 public $displayEditIcons = '';
530
531 /**
532 * If set, edit icons are rendered aside individual fields of content. Must be
533 * set only if the ->beUserLogin flag is set and set_no_cache() must be called as
534 * well.
535 * @var string
536 */
537 public $displayFieldEditIcons = '';
538
539 /**
540 * Site language, 0 (zero) is default, int+ is uid pointing to a sys_language
541 * record. Should reflect which language menus, templates etc is displayed in
542 * (master language) - but not necessarily the content which could be falling
543 * back to default (see sys_language_content)
544 * @var int
545 */
546 public $sys_language_uid = 0;
547
548 /**
549 * Site language mode for content fall back.
550 * @var string
551 */
552 public $sys_language_mode = '';
553
554 /**
555 * Site content selection uid (can be different from sys_language_uid if content
556 * is to be selected from a fall-back language. Depends on sys_language_mode)
557 * @var int
558 */
559 public $sys_language_content = 0;
560
561 /**
562 * Site content overlay flag; If set - and sys_language_content is > 0 - ,
563 * records selected will try to look for a translation pointing to their uid. (If
564 * configured in [ctrl][languageField] / [ctrl][transOrigP...]
565 * @var int
566 */
567 public $sys_language_contentOL = 0;
568
569 /**
570 * Is set to the iso code of the sys_language_content if that is properly defined
571 * by the sys_language record representing the sys_language_uid.
572 * @var string
573 */
574 public $sys_language_isocode = '';
575
576 /**
577 * 'Global' Storage for various applications. Keys should be 'tx_'.extKey for
578 * extensions.
579 * @var array
580 */
581 public $applicationData = array();
582
583 /**
584 * @var array
585 */
586 public $register = array();
587
588 /**
589 * Stack used for storing array and retrieving register arrays (see
590 * LOAD_REGISTER and RESTORE_REGISTER)
591 * @var array
592 */
593 public $registerStack = array();
594
595 /**
596 * Checking that the function is not called eternally. This is done by
597 * interrupting at a depth of 50
598 * @var int
599 */
600 public $cObjectDepthCounter = 50;
601
602 /**
603 * Used by RecordContentObject and ContentContentObject to ensure the a records is NOT
604 * rendered twice through it!
605 * @var array
606 */
607 public $recordRegister = array();
608
609 /**
610 * This is set to the [table]:[uid] of the latest record rendered. Note that
611 * class ContentObjectRenderer has an equal value, but that is pointing to the
612 * record delivered in the $data-array of the ContentObjectRenderer instance, if
613 * the cObjects CONTENT or RECORD created that instance
614 * @var string
615 */
616 public $currentRecord = '';
617
618 /**
619 * Used by class \TYPO3\CMS\Frontend\ContentObject\Menu\AbstractMenuContentObject
620 * to keep track of access-keys.
621 * @var array
622 */
623 public $accessKey = array();
624
625 /**
626 * Numerical array where image filenames are added if they are referenced in the
627 * rendered document. This includes only TYPO3 generated/inserted images.
628 * @var array
629 */
630 public $imagesOnPage = array();
631
632 /**
633 * Is set in ContentObjectRenderer->cImage() function to the info-array of the
634 * most recent rendered image. The information is used in ImageTextContentObject
635 * @var array
636 */
637 public $lastImageInfo = array();
638
639 /**
640 * Used to generate page-unique keys. Point is that uniqid() functions is very
641 * slow, so a unikey key is made based on this, see function uniqueHash()
642 * @var int
643 */
644 public $uniqueCounter = 0;
645
646 /**
647 * @var string
648 */
649 public $uniqueString = '';
650
651 /**
652 * This value will be used as the title for the page in the indexer (if
653 * indexing happens)
654 * @var string
655 */
656 public $indexedDocTitle = '';
657
658 /**
659 * Alternative page title (normally the title of the page record). Can be set
660 * from applications you make.
661 * @var string
662 */
663 public $altPageTitle = '';
664
665 /**
666 * The base URL set for the page header.
667 * @var string
668 */
669 public $baseUrl = '';
670
671 /**
672 * The proper anchor prefix needed when using speaking urls. (only set if
673 * baseUrl is set)
674 * @var string
675 */
676 public $anchorPrefix = '';
677
678 /**
679 * IDs we already rendered for this page (to make sure they are unique)
680 * @var array
681 */
682 private $usedUniqueIds = array();
683
684 /**
685 * Page content render object
686 *
687 * @var \TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer
688 */
689 public $cObj = '';
690
691 /**
692 * All page content is accumulated in this variable. See pagegen.php
693 * @var string
694 */
695 public $content = '';
696
697 /**
698 * Set to the browser: net / msie if 4+ browsers
699 * @var string
700 */
701 public $clientInfo = '';
702
703 /**
704 * @var int
705 */
706 public $scriptParseTime = 0;
707
708 /**
709 * Character set (charset) conversion object:
710 * charset conversion class. May be used by any application.
711 *
712 * @var \TYPO3\CMS\Core\Charset\CharsetConverter
713 */
714 public $csConvObj;
715
716 /**
717 * The default charset used in the frontend if nothing else is set.
718 * @var string
719 */
720 public $defaultCharSet = 'utf-8';
721
722 /**
723 * Internal charset of the frontend during rendering. (Default: UTF-8)
724 * @var string
725 */
726 public $renderCharset = 'utf-8';
727
728 /**
729 * Output charset of the websites content. This is the charset found in the
730 * header, meta tag etc. If different from $renderCharset a conversion
731 * happens before output to browser. Defaults to ->renderCharset if not set.
732 * @var string
733 */
734 public $metaCharset = 'utf-8';
735
736 /**
737 * Assumed charset of locale strings.
738 * @var string
739 */
740 public $localeCharset = '';
741
742 /**
743 * Set to the system language key (used on the site)
744 * @var string
745 */
746 public $lang = '';
747
748 /**
749 * @var array
750 */
751 public $LL_labels_cache = array();
752
753 /**
754 * @var array
755 */
756 public $LL_files_cache = array();
757
758 /**
759 * List of language dependencies for actual language. This is used for local
760 * variants of a language that depend on their "main" language, like Brazilian,
761 * Portuguese or Canadian French.
762 *
763 * @var array
764 */
765 protected $languageDependencies = array();
766
767 /**
768 * Locking object for accessing "cache_pagesection"
769 *
770 * @var \TYPO3\CMS\Core\Locking\Locker
771 */
772 public $pagesection_lockObj;
773
774 /**
775 * Locking object for accessing "cache_pages"
776 *
777 * @var \TYPO3\CMS\Core\Locking\Locker
778 */
779 public $pages_lockObj;
780
781 /**
782 * @var \TYPO3\CMS\Core\Page\PageRenderer
783 */
784 protected $pageRenderer;
785
786 /**
787 * The page cache object, use this to save pages to the cache and to
788 * retrieve them again
789 *
790 * @var \TYPO3\CMS\Core\Cache\Backend\AbstractBackend
791 */
792 protected $pageCache;
793
794 /**
795 * @var array
796 */
797 protected $pageCacheTags = array();
798
799 /**
800 * @var \TYPO3\CMS\Frontend\Page\CacheHashCalculator The cHash Service class used for cHash related functionality
801 */
802 protected $cacheHash;
803
804 /**
805 * Runtime cache of domains per processed page ids.
806 *
807 * @var array
808 */
809 protected $domainDataCache = array();
810
811 /**
812 * Content type HTTP header being sent in the request.
813 * @todo Ticket: #63642 Should be refactored to a request/response model later
814 * @internal Should only be used by TYPO3 core for now
815 *
816 * @var string
817 */
818 protected $contentType = 'text/html';
819
820 /**
821 * Doctype to use
822 *
823 * Currently set via PageGenerator
824 *
825 * @var string
826 */
827 public $xhtmlDoctype = '';
828
829 /**
830 * Class constructor
831 * Takes a number of GET/POST input variable as arguments and stores them internally.
832 * The processing of these variables goes on later in this class.
833 * Also sets internal clientInfo array (browser information) and a unique string (->uniqueString) for this script instance; A md5 hash of the microtime()
834 *
835 * @param array $TYPO3_CONF_VARS The global $TYPO3_CONF_VARS array. Will be set internally in ->TYPO3_CONF_VARS
836 * @param mixed $id The value of GeneralUtility::_GP('id')
837 * @param int $type The value of GeneralUtility::_GP('type')
838 * @param bool|string $no_cache The value of GeneralUtility::_GP('no_cache'), evaluated to 1/0
839 * @param string $cHash The value of GeneralUtility::_GP('cHash')
840 * @param string $jumpurl The value of GeneralUtility::_GP('jumpurl')
841 * @param string $MP The value of GeneralUtility::_GP('MP')
842 * @param string $RDCT The value of GeneralUtility::_GP('RDCT')
843 * @see index_ts.php
844 */
845 public function __construct($TYPO3_CONF_VARS, $id, $type, $no_cache = '', $cHash = '', $jumpurl = '', $MP = '', $RDCT = '') {
846 // Setting some variables:
847 $this->TYPO3_CONF_VARS = $TYPO3_CONF_VARS;
848 $this->id = $id;
849 $this->type = $type;
850 if ($no_cache) {
851 if ($this->TYPO3_CONF_VARS['FE']['disableNoCacheParameter']) {
852 $warning = '&no_cache=1 has been ignored because $TYPO3_CONF_VARS[\'FE\'][\'disableNoCacheParameter\'] is set!';
853 $GLOBALS['TT']->setTSlogMessage($warning, 2);
854 } else {
855 $warning = '&no_cache=1 has been supplied, so caching is disabled! URL: "' . GeneralUtility::getIndpEnv('TYPO3_REQUEST_URL') . '"';
856 $this->disableCache();
857 }
858 GeneralUtility::sysLog($warning, 'cms', GeneralUtility::SYSLOG_SEVERITY_WARNING);
859 }
860 $this->cHash = $cHash;
861 $this->jumpurl = $jumpurl;
862 $this->MP = $this->TYPO3_CONF_VARS['FE']['enable_mount_pids'] ? (string)$MP : '';
863 $this->RDCT = $RDCT;
864 $this->clientInfo = GeneralUtility::clientInfo();
865 $this->uniqueString = md5(microtime());
866 $this->csConvObj = GeneralUtility::makeInstance(\TYPO3\CMS\Core\Charset\CharsetConverter::class);
867 // Call post processing function for constructor:
868 if (is_array($this->TYPO3_CONF_VARS['SC_OPTIONS']['tslib/class.tslib_fe.php']['tslib_fe-PostProc'])) {
869 $_params = array('pObj' => &$this);
870 foreach ($this->TYPO3_CONF_VARS['SC_OPTIONS']['tslib/class.tslib_fe.php']['tslib_fe-PostProc'] as $_funcRef) {
871 GeneralUtility::callUserFunction($_funcRef, $_params, $this);
872 }
873 }
874 $this->cacheHash = GeneralUtility::makeInstance(\TYPO3\CMS\Frontend\Page\CacheHashCalculator::class);
875 $this->initCaches();
876 }
877
878 /**
879 * @param string $contentType
880 * @internal Should only be used by TYPO3 core for now
881 */
882 public function setContentType($contentType) {
883 $this->contentType = $contentType;
884 }
885
886 /**
887 * Connect to SQL database. May exit after outputting an error message
888 * or some JavaScript redirecting to the install tool.
889 *
890 * @throws \RuntimeException
891 * @throws \TYPO3\CMS\Core\Error\Http\ServiceUnavailableException
892 * @return void
893 */
894 public function connectToDB() {
895 try {
896 $GLOBALS['TYPO3_DB']->connectDB();
897 } catch (\RuntimeException $exception) {
898 switch ($exception->getCode()) {
899 case 1270853883:
900 // Cannot connect to current database
901 $message = 'Cannot connect to the configured database "' . TYPO3_db . '"';
902 if ($this->checkPageUnavailableHandler()) {
903 $this->pageUnavailableAndExit($message);
904 } else {
905 GeneralUtility::sysLog($message, 'cms', GeneralUtility::SYSLOG_SEVERITY_ERROR);
906 throw new \TYPO3\CMS\Core\Error\Http\ServiceUnavailableException($message, 1301648782);
907 }
908 break;
909 case 1270853884:
910 // Username / password not accepted
911 $message = 'The current username, password or host was not accepted when' . ' the connection to the database was attempted to be established!';
912 if ($this->checkPageUnavailableHandler()) {
913 $this->pageUnavailableAndExit($message);
914 } else {
915 GeneralUtility::sysLog($message, 'cms', GeneralUtility::SYSLOG_SEVERITY_ERROR);
916 throw new \TYPO3\CMS\Core\Error\Http\ServiceUnavailableException('Database Error: ' . $message, 1301648945);
917 }
918 break;
919 default:
920 throw $exception;
921 }
922 }
923 // Call post processing function for DB connection:
924 if (is_array($this->TYPO3_CONF_VARS['SC_OPTIONS']['tslib/class.tslib_fe.php']['connectToDB'])) {
925 $_params = array('pObj' => &$this);
926 foreach ($this->TYPO3_CONF_VARS['SC_OPTIONS']['tslib/class.tslib_fe.php']['connectToDB'] as $_funcRef) {
927 GeneralUtility::callUserFunction($_funcRef, $_params, $this);
928 }
929 }
930 }
931
932 /**
933 * Looks up the value of $this->RDCT in the database and if it is
934 * found to be associated with a redirect URL then the redirection
935 * is carried out with a 'Location:' header
936 * May exit after sending a location-header.
937 *
938 * @return void
939 */
940 public function sendRedirect() {
941 if ($this->RDCT) {
942 $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery('params', 'cache_md5params', 'md5hash=' . $GLOBALS['TYPO3_DB']->fullQuoteStr($this->RDCT, 'cache_md5params'));
943 if ($row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res)) {
944 $this->updateMD5paramsRecord($this->RDCT);
945 header('Location: ' . $row['params']);
946 die;
947 }
948 }
949 }
950
951 /**
952 * Gets instance of PageRenderer
953 *
954 * @return \TYPO3\CMS\Core\Page\PageRenderer
955 */
956 public function getPageRenderer() {
957 if (!isset($this->pageRenderer)) {
958 $this->pageRenderer = GeneralUtility::makeInstance(\TYPO3\CMS\Core\Page\PageRenderer::class);
959 $this->pageRenderer->setTemplateFile('EXT:frontend/Resources/Private/Templates/MainPage.html');
960 $this->pageRenderer->setBackPath(TYPO3_mainDir);
961 }
962 return $this->pageRenderer;
963 }
964
965 /**
966 * This is needed for USER_INT processing
967 *
968 * @param \TYPO3\CMS\Core\Page\PageRenderer $pageRenderer
969 */
970 protected function setPageRenderer(\TYPO3\CMS\Core\Page\PageRenderer $pageRenderer) {
971 $this->pageRenderer = $pageRenderer;
972 }
973
974 /********************************************
975 *
976 * Initializing, resolving page id
977 *
978 ********************************************/
979 /**
980 * Initializes the caching system.
981 *
982 * @return void
983 */
984 protected function initCaches() {
985 $this->pageCache = GeneralUtility::makeInstance(\TYPO3\CMS\Core\Cache\CacheManager::class)->getCache('cache_pages');
986 }
987
988 /**
989 * Initializes the front-end login user.
990 *
991 * @return void
992 */
993 public function initFEuser() {
994 $this->fe_user = GeneralUtility::makeInstance(\TYPO3\CMS\Frontend\Authentication\FrontendUserAuthentication::class);
995 $this->fe_user->lockIP = $this->TYPO3_CONF_VARS['FE']['lockIP'];
996 $this->fe_user->checkPid = $this->TYPO3_CONF_VARS['FE']['checkFeUserPid'];
997 $this->fe_user->lifetime = (int)$this->TYPO3_CONF_VARS['FE']['lifetime'];
998 // List of pid's acceptable
999 $pid = GeneralUtility::_GP('pid');
1000 $this->fe_user->checkPid_value = $pid ? $GLOBALS['TYPO3_DB']->cleanIntList($pid) : 0;
1001 // Check if a session is transferred:
1002 if (GeneralUtility::_GP('FE_SESSION_KEY')) {
1003 $fe_sParts = explode('-', GeneralUtility::_GP('FE_SESSION_KEY'));
1004 // If the session key hash check is OK:
1005 if (md5(($fe_sParts[0] . '/' . $this->TYPO3_CONF_VARS['SYS']['encryptionKey'])) === (string)$fe_sParts[1]) {
1006 $cookieName = \TYPO3\CMS\Frontend\Authentication\FrontendUserAuthentication::getCookieName();
1007 $_COOKIE[$cookieName] = $fe_sParts[0];
1008 if (isset($_SERVER['HTTP_COOKIE'])) {
1009 // See http://forge.typo3.org/issues/27740
1010 $_SERVER['HTTP_COOKIE'] .= ';' . $cookieName . '=' . $fe_sParts[0];
1011 }
1012 $this->fe_user->forceSetCookie = 1;
1013 unset($cookieName);
1014 }
1015 }
1016 $this->fe_user->start();
1017 $this->fe_user->unpack_uc('');
1018 // Gets session data
1019 $this->fe_user->fetchSessionData();
1020 $recs = GeneralUtility::_GP('recs');
1021 // If any record registration is submitted, register the record.
1022 if (is_array($recs)) {
1023 $this->fe_user->record_registration($recs, $this->TYPO3_CONF_VARS['FE']['maxSessionDataSize']);
1024 }
1025 // Call hook for possible manipulation of frontend user object
1026 if (is_array($this->TYPO3_CONF_VARS['SC_OPTIONS']['tslib/class.tslib_fe.php']['initFEuser'])) {
1027 $_params = array('pObj' => &$this);
1028 foreach ($this->TYPO3_CONF_VARS['SC_OPTIONS']['tslib/class.tslib_fe.php']['initFEuser'] as $_funcRef) {
1029 GeneralUtility::callUserFunction($_funcRef, $_params, $this);
1030 }
1031 }
1032 // For every 60 seconds the is_online timestamp is updated.
1033 if (is_array($this->fe_user->user) && $this->fe_user->user['uid'] && $this->fe_user->user['is_online'] < $GLOBALS['EXEC_TIME'] - 60) {
1034 $GLOBALS['TYPO3_DB']->exec_UPDATEquery('fe_users', 'uid=' . (int)$this->fe_user->user['uid'], array('is_online' => $GLOBALS['EXEC_TIME']));
1035 }
1036 }
1037
1038 /**
1039 * Initializes the front-end user groups.
1040 * Sets ->loginUser and ->gr_list based on front-end user status.
1041 *
1042 * @return void
1043 */
1044 public function initUserGroups() {
1045 // This affects the hidden-flag selecting the fe_groups for the user!
1046 $this->fe_user->showHiddenRecords = $this->showHiddenRecords;
1047 // no matter if we have an active user we try to fetch matching groups which can be set without an user (simulation for instance!)
1048 $this->fe_user->fetchGroupData();
1049 if (is_array($this->fe_user->user) && count($this->fe_user->groupData['uid'])) {
1050 // global flag!
1051 $this->loginUser = TRUE;
1052 // 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!
1053 $this->gr_list = '0,-2';
1054 $gr_array = $this->fe_user->groupData['uid'];
1055 } else {
1056 $this->loginUser = FALSE;
1057 // 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!
1058 $this->gr_list = '0,-1';
1059 if ($this->loginAllowedInBranch) {
1060 // 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.
1061 $gr_array = $this->fe_user->groupData['uid'];
1062 } else {
1063 // Set to blank since we will NOT risk any groups being set when no logins are allowed!
1064 $gr_array = array();
1065 }
1066 }
1067 // Clean up.
1068 // Make unique...
1069 $gr_array = array_unique($gr_array);
1070 // sort
1071 sort($gr_array);
1072 if (count($gr_array) && !$this->loginAllowedInBranch_mode) {
1073 $this->gr_list .= ',' . implode(',', $gr_array);
1074 }
1075 if ($this->fe_user->writeDevLog) {
1076 GeneralUtility::devLog('Valid usergroups for TSFE: ' . $this->gr_list, __CLASS__);
1077 }
1078 }
1079
1080 /**
1081 * Checking if a user is logged in or a group constellation different from "0,-1"
1082 *
1083 * @return bool 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!)
1084 */
1085 public function isUserOrGroupSet() {
1086 return is_array($this->fe_user->user) || $this->gr_list !== '0,-1';
1087 }
1088
1089 /**
1090 * Provides ways to bypass the '?id=[xxx]&type=[xx]' format, using either PATH_INFO or virtual HTML-documents (using Apache mod_rewrite)
1091 *
1092 * Two options:
1093 * 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)
1094 * 2) Using hook which enables features like those provided from "realurl" extension (AKA "Speaking URLs")
1095 *
1096 * @return void
1097 */
1098 public function checkAlternativeIdMethods() {
1099 $this->siteScript = GeneralUtility::getIndpEnv('TYPO3_SITE_SCRIPT');
1100 // Call post processing function for custom URL methods.
1101 if (is_array($this->TYPO3_CONF_VARS['SC_OPTIONS']['tslib/class.tslib_fe.php']['checkAlternativeIdMethods-PostProc'])) {
1102 $_params = array('pObj' => &$this);
1103 foreach ($this->TYPO3_CONF_VARS['SC_OPTIONS']['tslib/class.tslib_fe.php']['checkAlternativeIdMethods-PostProc'] as $_funcRef) {
1104 GeneralUtility::callUserFunction($_funcRef, $_params, $this);
1105 }
1106 }
1107 }
1108
1109 /**
1110 * Clears the preview-flags, sets sim_exec_time to current time.
1111 * Hidden pages must be hidden as default, $GLOBALS['SIM_EXEC_TIME'] is set to $GLOBALS['EXEC_TIME']
1112 * in bootstrap initializeGlobalTimeVariables(). Alter it by adding or subtracting seconds.
1113 *
1114 * @return void
1115 */
1116 public function clear_preview() {
1117 $this->showHiddenPage = FALSE;
1118 $this->showHiddenRecords = FALSE;
1119 $GLOBALS['SIM_EXEC_TIME'] = $GLOBALS['EXEC_TIME'];
1120 $GLOBALS['SIM_ACCESS_TIME'] = $GLOBALS['ACCESS_TIME'];
1121 $this->fePreview = 0;
1122 }
1123
1124 /**
1125 * Checks if a backend user is logged in
1126 *
1127 * @return bool whether a backend user is logged in
1128 */
1129 public function isBackendUserLoggedIn() {
1130 return (bool)$this->beUserLogin;
1131 }
1132
1133 /**
1134 * Creates the backend user object and returns it.
1135 *
1136 * @return \TYPO3\CMS\Backend\FrontendBackendUserAuthentication the backend user object
1137 */
1138 public function initializeBackendUser() {
1139 // PRE BE_USER HOOK
1140 if (is_array($this->TYPO3_CONF_VARS['SC_OPTIONS']['tslib/index_ts.php']['preBeUser'])) {
1141 foreach ($this->TYPO3_CONF_VARS['SC_OPTIONS']['tslib/index_ts.php']['preBeUser'] as $_funcRef) {
1142 $_params = array();
1143 GeneralUtility::callUserFunction($_funcRef, $_params, $this);
1144 }
1145 }
1146 /** @var $BE_USER \TYPO3\CMS\Backend\FrontendBackendUserAuthentication */
1147 $BE_USER = NULL;
1148 // If the backend cookie is set,
1149 // we proceed and check if a backend user is logged in.
1150 if ($_COOKIE[\TYPO3\CMS\Core\Authentication\BackendUserAuthentication::getCookieName()]) {
1151 $GLOBALS['TYPO3_MISC']['microtime_BE_USER_start'] = microtime(TRUE);
1152 $GLOBALS['TT']->push('Back End user initialized', '');
1153 // @todo validate the comment below: is this necessary? if so,
1154 // formfield_status should be set to "" in \TYPO3\CMS\Backend\FrontendBackendUserAuthentication
1155 // which is a subclass of \TYPO3\CMS\Core\Authentication\BackendUserAuthentication
1156 // ----
1157 // the value this->formfield_status is set to empty in order to
1158 // disable login-attempts to the backend account through this script
1159 // New backend user object
1160 $BE_USER = GeneralUtility::makeInstance(\TYPO3\CMS\Backend\FrontendBackendUserAuthentication::class);
1161 $BE_USER->OS = TYPO3_OS;
1162 $BE_USER->lockIP = $this->TYPO3_CONF_VARS['BE']['lockIP'];
1163 // Object is initialized
1164 $BE_USER->start();
1165 $BE_USER->unpack_uc('');
1166 if (!empty($BE_USER->user['uid'])) {
1167 $BE_USER->fetchGroupData();
1168 $this->beUserLogin = TRUE;
1169 }
1170 // Unset the user initialization.
1171 if (!$BE_USER->checkLockToIP() || !$BE_USER->checkBackendAccessSettingsFromInitPhp() || empty($BE_USER->user['uid'])) {
1172 $BE_USER = NULL;
1173 $this->beUserLogin = FALSE;
1174 $_SESSION['TYPO3-TT-start'] = FALSE;
1175 }
1176 $GLOBALS['TT']->pull();
1177 $GLOBALS['TYPO3_MISC']['microtime_BE_USER_end'] = microtime(TRUE);
1178 }
1179 // POST BE_USER HOOK
1180 if (is_array($this->TYPO3_CONF_VARS['SC_OPTIONS']['tslib/index_ts.php']['postBeUser'])) {
1181 $_params = array(
1182 'BE_USER' => &$BE_USER
1183 );
1184 foreach ($this->TYPO3_CONF_VARS['SC_OPTIONS']['tslib/index_ts.php']['postBeUser'] as $_funcRef) {
1185 GeneralUtility::callUserFunction($_funcRef, $_params, $this);
1186 }
1187 }
1188 return $BE_USER;
1189 }
1190
1191 /**
1192 * Determines the id and evaluates any preview settings
1193 * 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.
1194 *
1195 * @return void
1196 */
1197 public function determineId() {
1198 // Call pre processing function for id determination
1199 if (is_array($this->TYPO3_CONF_VARS['SC_OPTIONS']['tslib/class.tslib_fe.php']['determineId-PreProcessing'])) {
1200 foreach ($this->TYPO3_CONF_VARS['SC_OPTIONS']['tslib/class.tslib_fe.php']['determineId-PreProcessing'] as $functionReference) {
1201 $parameters = array('parentObject' => $this);
1202 GeneralUtility::callUserFunction($functionReference, $parameters, $this);
1203 }
1204 }
1205 // Getting ARG-v values if some
1206 $this->setIDfromArgV();
1207 // If there is a Backend login we are going to check for any preview settings:
1208 $GLOBALS['TT']->push('beUserLogin', '');
1209 $originalFrontendUser = NULL;
1210 if ($this->beUserLogin || $this->doWorkspacePreview()) {
1211 // Backend user preview features:
1212 if ($this->beUserLogin && $GLOBALS['BE_USER']->adminPanel instanceof \TYPO3\CMS\Frontend\View\AdminPanelView) {
1213 $this->fePreview = (bool)$GLOBALS['BE_USER']->adminPanel->extGetFeAdminValue('preview');
1214 // If admin panel preview is enabled...
1215 if ($this->fePreview) {
1216 if ($this->fe_user->user) {
1217 $originalFrontendUser = $this->fe_user->user;
1218 }
1219 $this->showHiddenPage = (bool)$GLOBALS['BE_USER']->adminPanel->extGetFeAdminValue('preview', 'showHiddenPages');
1220 $this->showHiddenRecords = (bool)$GLOBALS['BE_USER']->adminPanel->extGetFeAdminValue('preview', 'showHiddenRecords');
1221 // Simulate date
1222 $simTime = $GLOBALS['BE_USER']->adminPanel->extGetFeAdminValue('preview', 'simulateDate');
1223 if ($simTime) {
1224 $GLOBALS['SIM_EXEC_TIME'] = $simTime;
1225 $GLOBALS['SIM_ACCESS_TIME'] = $simTime - $simTime % 60;
1226 }
1227 // simulate user
1228 $simUserGroup = $GLOBALS['BE_USER']->adminPanel->extGetFeAdminValue('preview', 'simulateUserGroup');
1229 $this->simUserGroup = $simUserGroup;
1230 if ($simUserGroup) {
1231 if ($this->fe_user->user) {
1232 $this->fe_user->user[$this->fe_user->usergroup_column] = $simUserGroup;
1233 } else {
1234 $this->fe_user->user = array(
1235 $this->fe_user->usergroup_column => $simUserGroup
1236 );
1237 }
1238 }
1239 if (!$simUserGroup && !$simTime && !$this->showHiddenPage && !$this->showHiddenRecords) {
1240 $this->fePreview = 0;
1241 }
1242 }
1243 }
1244 if ($this->id) {
1245 if ($this->determineIdIsHiddenPage()) {
1246 // The preview flag is set only if the current page turns out to actually be hidden!
1247 $this->fePreview = 1;
1248 $this->showHiddenPage = TRUE;
1249 }
1250 // For Live workspace: Check root line for proper connection to tree root (done because of possible preview of page / branch versions)
1251 if (!$this->fePreview && $this->whichWorkspace() === 0) {
1252 // Initialize the page-select functions to check rootline:
1253 $temp_sys_page = GeneralUtility::makeInstance(PageRepository::class);
1254 $temp_sys_page->init($this->showHiddenPage);
1255 // If root line contained NO records and ->error_getRootLine_failPid tells us that it was because of a pid=-1 (indicating a "version" record)...:
1256 if (!count($temp_sys_page->getRootLine($this->id, $this->MP)) && $temp_sys_page->error_getRootLine_failPid == -1) {
1257 // Setting versioningPreview flag and try again:
1258 $temp_sys_page->versioningPreview = TRUE;
1259 if (count($temp_sys_page->getRootLine($this->id, $this->MP))) {
1260 // 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.
1261 $this->fePreview = 1;
1262 }
1263 }
1264 }
1265 }
1266 // The preview flag will be set if a backend user is in an offline workspace
1267 if (($GLOBALS['BE_USER']->user['workspace_preview'] || GeneralUtility::_GP('ADMCMD_view') || $this->doWorkspacePreview()) && ($this->whichWorkspace() === -1 || $this->whichWorkspace() > 0)) {
1268 // Will show special preview message.
1269 $this->fePreview = 2;
1270 }
1271 // If the front-end is showing a preview, caching MUST be disabled.
1272 if ($this->fePreview) {
1273 $this->disableCache();
1274 }
1275 }
1276 $GLOBALS['TT']->pull();
1277 // Now, get the id, validate access etc:
1278 $this->fetch_the_id();
1279 // Check if backend user has read access to this page. If not, recalculate the id.
1280 if ($this->beUserLogin && $this->fePreview) {
1281 if (!$GLOBALS['BE_USER']->doesUserHaveAccess($this->page, 1)) {
1282 // Resetting
1283 $this->clear_preview();
1284 $this->fe_user->user = $originalFrontendUser;
1285 // Fetching the id again, now with the preview settings reset.
1286 $this->fetch_the_id();
1287 }
1288 }
1289 // Checks if user logins are blocked for a certain branch and if so, will unset user login and re-fetch ID.
1290 $this->loginAllowedInBranch = $this->checkIfLoginAllowedInBranch();
1291 // Logins are not allowed:
1292 if (!$this->loginAllowedInBranch) {
1293 // Only if there is a login will we run this...
1294 if ($this->isUserOrGroupSet()) {
1295 if ($this->loginAllowedInBranch_mode == 'all') {
1296 // Clear out user and group:
1297 unset($this->fe_user->user);
1298 $this->gr_list = '0,-1';
1299 } else {
1300 $this->gr_list = '0,-2';
1301 }
1302 // Fetching the id again, now with the preview settings reset.
1303 $this->fetch_the_id();
1304 }
1305 }
1306 // Final cleaning.
1307 // Make sure it's an integer
1308 $this->id = ($this->contentPid = (int)$this->id);
1309 // Make sure it's an integer
1310 $this->type = (int)$this->type;
1311 // Call post processing function for id determination:
1312 if (is_array($this->TYPO3_CONF_VARS['SC_OPTIONS']['tslib/class.tslib_fe.php']['determineId-PostProc'])) {
1313 $_params = array('pObj' => &$this);
1314 foreach ($this->TYPO3_CONF_VARS['SC_OPTIONS']['tslib/class.tslib_fe.php']['determineId-PostProc'] as $_funcRef) {
1315 GeneralUtility::callUserFunction($_funcRef, $_params, $this);
1316 }
1317 }
1318 }
1319
1320 /**
1321 * Checks if the page is hidden in the active workspace.
1322 * If it is hidden, preview flags will be set.
1323 *
1324 * @return bool
1325 */
1326 protected function determineIdIsHiddenPage() {
1327 $field = MathUtility::canBeInterpretedAsInteger($this->id) ? 'uid' : 'alias';
1328 $pageSelectCondition = $field . '=' . $GLOBALS['TYPO3_DB']->fullQuoteStr($this->id, 'pages');
1329 $page = $GLOBALS['TYPO3_DB']->exec_SELECTgetSingleRow('uid,hidden,starttime,endtime', 'pages', $pageSelectCondition . ' AND pid>=0 AND deleted=0');
1330 $workspace = $this->whichWorkspace();
1331 if ($workspace !== 0 && $workspace !== FALSE) {
1332 // Fetch overlay of page if in workspace and check if it is hidden
1333 $pageSelectObject = GeneralUtility::makeInstance(PageRepository::class);
1334 $pageSelectObject->versioningPreview = TRUE;
1335 $pageSelectObject->init(FALSE);
1336 $targetPage = $pageSelectObject->getWorkspaceVersionOfRecord($this->whichWorkspace(), 'pages', $page['uid']);
1337 $result = $targetPage === -1 || $targetPage === -2;
1338 } else {
1339 $result = is_array($page) && ($page['hidden'] || $page['starttime'] > $GLOBALS['SIM_EXEC_TIME'] || $page['endtime'] != 0 && $page['endtime'] <= $GLOBALS['SIM_EXEC_TIME']);
1340 }
1341 return $result;
1342 }
1343
1344 /**
1345 * Get The Page ID
1346 * This gets the id of the page, checks if the page is in the domain and if the page is accessible
1347 * Sets variables such as $this->sys_page, $this->loginUser, $this->gr_list, $this->id, $this->type, $this->domainStartPage
1348 *
1349 * @throws \TYPO3\CMS\Core\Error\Http\ServiceUnavailableException
1350 * @return void
1351 * @access private
1352 */
1353 public function fetch_the_id() {
1354 $GLOBALS['TT']->push('fetch_the_id initialize/', '');
1355 // Initialize the page-select functions.
1356 $this->sys_page = GeneralUtility::makeInstance(PageRepository::class);
1357 $this->sys_page->versioningPreview = $this->fePreview === 2 || (int)$this->workspacePreview || (bool)GeneralUtility::_GP('ADMCMD_view');
1358 $this->sys_page->versioningWorkspaceId = $this->whichWorkspace();
1359 $this->sys_page->init($this->showHiddenPage);
1360 // Set the valid usergroups for FE
1361 $this->initUserGroups();
1362 // Sets sys_page where-clause
1363 $this->setSysPageWhereClause();
1364 // Splitting $this->id by a period (.).
1365 // First part is 'id' and second part (if exists) will overrule the &type param
1366 $idParts = explode('.', $this->id, 2);
1367 $this->id = $idParts[0];
1368 if (isset($idParts[1])) {
1369 $this->type = $idParts[1];
1370 }
1371
1372 // If $this->id is a string, it's an alias
1373 $this->checkAndSetAlias();
1374 // The id and type is set to the integer-value - just to be sure...
1375 $this->id = (int)$this->id;
1376 $this->type = (int)$this->type;
1377 $GLOBALS['TT']->pull();
1378 // We find the first page belonging to the current domain
1379 $GLOBALS['TT']->push('fetch_the_id domain/', '');
1380 // The page_id of the current domain
1381 $this->domainStartPage = $this->findDomainRecord($this->TYPO3_CONF_VARS['SYS']['recursiveDomainSearch']);
1382 if (!$this->id) {
1383 if ($this->domainStartPage) {
1384 // If the id was not previously set, set it to the id of the domain.
1385 $this->id = $this->domainStartPage;
1386 } else {
1387 // Find the first 'visible' page in that domain
1388 $theFirstPage = $this->sys_page->getFirstWebPage($this->id);
1389 if ($theFirstPage) {
1390 $this->id = $theFirstPage['uid'];
1391 } else {
1392 $message = 'No pages are found on the rootlevel!';
1393 if ($this->checkPageUnavailableHandler()) {
1394 $this->pageUnavailableAndExit($message);
1395 } else {
1396 GeneralUtility::sysLog($message, 'cms', GeneralUtility::SYSLOG_SEVERITY_ERROR);
1397 throw new \TYPO3\CMS\Core\Error\Http\ServiceUnavailableException($message, 1301648975);
1398 }
1399 }
1400 }
1401 }
1402 $GLOBALS['TT']->pull();
1403 $GLOBALS['TT']->push('fetch_the_id rootLine/', '');
1404 // We store the originally requested id
1405 $requestedId = $this->id;
1406 $this->getPageAndRootlineWithDomain($this->domainStartPage);
1407 $GLOBALS['TT']->pull();
1408 if ($this->pageNotFound && $this->TYPO3_CONF_VARS['FE']['pageNotFound_handling']) {
1409 $pNotFoundMsg = array(
1410 1 => 'ID was not an accessible page',
1411 2 => 'Subsection was found and not accessible',
1412 3 => 'ID was outside the domain',
1413 4 => 'The requested page alias does not exist'
1414 );
1415 $this->pageNotFoundAndExit($pNotFoundMsg[$this->pageNotFound]);
1416 }
1417 if ($this->page['url_scheme'] > 0) {
1418 $newUrl = '';
1419 $requestUrlScheme = parse_url(GeneralUtility::getIndpEnv('TYPO3_REQUEST_URL'), PHP_URL_SCHEME);
1420 if ((int)$this->page['url_scheme'] === HttpUtility::SCHEME_HTTP && $requestUrlScheme == 'https') {
1421 $newUrl = 'http://' . substr(GeneralUtility::getIndpEnv('TYPO3_REQUEST_URL'), 8);
1422 } elseif ((int)$this->page['url_scheme'] === HttpUtility::SCHEME_HTTPS && $requestUrlScheme == 'http') {
1423 $newUrl = 'https://' . substr(GeneralUtility::getIndpEnv('TYPO3_REQUEST_URL'), 7);
1424 }
1425 if ($newUrl !== '') {
1426 if ($_SERVER['REQUEST_METHOD'] === 'POST') {
1427 $headerCode = HttpUtility::HTTP_STATUS_303;
1428 } else {
1429 $headerCode = HttpUtility::HTTP_STATUS_301;
1430 }
1431 HttpUtility::redirect($newUrl, $headerCode);
1432 }
1433 }
1434 // Set no_cache if set
1435 if ($this->page['no_cache']) {
1436 $this->set_no_cache('no_cache is set in page properties');
1437 }
1438 // Init SYS_LASTCHANGED
1439 $this->register['SYS_LASTCHANGED'] = (int)$this->page['tstamp'];
1440 if ($this->register['SYS_LASTCHANGED'] < (int)$this->page['SYS_LASTCHANGED']) {
1441 $this->register['SYS_LASTCHANGED'] = (int)$this->page['SYS_LASTCHANGED'];
1442 }
1443 if (is_array($this->TYPO3_CONF_VARS['SC_OPTIONS']['tslib/class.tslib_fe.php']['fetchPageId-PostProcessing'])) {
1444 foreach ($this->TYPO3_CONF_VARS['SC_OPTIONS']['tslib/class.tslib_fe.php']['fetchPageId-PostProcessing'] as $functionReference) {
1445 $parameters = array('parentObject' => $this);
1446 GeneralUtility::callUserFunction($functionReference, $parameters, $this);
1447 }
1448 }
1449 }
1450
1451 /**
1452 * Gets the page and rootline arrays based on the id, $this->id
1453 *
1454 * If the id does not correspond to a proper page, the 'previous' valid page in the rootline is found
1455 * If the page is a shortcut (doktype=4), the ->id is loaded with that id
1456 *
1457 * 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.
1458 *
1459 * Sets or manipulates internal variables such as: $this->id, $this->page, $this->rootLine, $this->MP, $this->pageNotFound
1460 *
1461 * @throws \TYPO3\CMS\Core\Error\Http\ServiceUnavailableException
1462 * @throws PageNotFoundException
1463 * @return void
1464 * @access private
1465 */
1466 public function getPageAndRootline() {
1467 $this->page = $this->sys_page->getPage($this->id);
1468 if (!count($this->page)) {
1469 // If no page, we try to find the page before in the rootLine.
1470 // Page is 'not found' in case the id itself was not an accessible page. code 1
1471 $this->pageNotFound = 1;
1472 $this->rootLine = $this->sys_page->getRootLine($this->id, $this->MP);
1473 if (count($this->rootLine)) {
1474 $c = count($this->rootLine) - 1;
1475 while ($c > 0) {
1476 // Add to page access failure history:
1477 $this->pageAccessFailureHistory['direct_access'][] = $this->rootLine[$c];
1478 // Decrease to next page in rootline and check the access to that, if OK, set as page record and ID value.
1479 $c--;
1480 $this->id = $this->rootLine[$c]['uid'];
1481 $this->page = $this->sys_page->getPage($this->id);
1482 if (count($this->page)) {
1483 break;
1484 }
1485 }
1486 }
1487 // If still no page...
1488 if (!count($this->page)) {
1489 $message = 'The requested page does not exist!';
1490 if ($this->TYPO3_CONF_VARS['FE']['pageNotFound_handling']) {
1491 $this->pageNotFoundAndExit($message);
1492 } else {
1493 GeneralUtility::sysLog($message, 'cms', GeneralUtility::SYSLOG_SEVERITY_ERROR);
1494 throw new PageNotFoundException($message, 1301648780);
1495 }
1496 }
1497 }
1498 // Spacer is not accessible in frontend
1499 if ($this->page['doktype'] == PageRepository::DOKTYPE_SPACER) {
1500 $message = 'The requested page does not exist!';
1501 if ($this->TYPO3_CONF_VARS['FE']['pageNotFound_handling']) {
1502 $this->pageNotFoundAndExit($message);
1503 } else {
1504 GeneralUtility::sysLog($message, 'cms', GeneralUtility::SYSLOG_SEVERITY_ERROR);
1505 throw new PageNotFoundException($message, 1301648781);
1506 }
1507 }
1508 // Is the ID a link to another page??
1509 if ($this->page['doktype'] == PageRepository::DOKTYPE_SHORTCUT) {
1510 // 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.
1511 $this->MP = '';
1512 // saving the page so that we can check later - when we know
1513 // about languages - whether we took the correct shortcut or
1514 // whether a translation of the page overwrites the shortcut
1515 // target and we need to follow the new target
1516 $this->originalShortcutPage = $this->page;
1517 $this->page = $this->getPageShortcut($this->page['shortcut'], $this->page['shortcut_mode'], $this->page['uid']);
1518 $this->id = $this->page['uid'];
1519 }
1520 // If the page is a mountpoint which should be overlaid with the contents of the mounted page,
1521 // it must never be accessible directly, but only in the mountpoint context. Therefore we change
1522 // the current ID and the user is redirected by checkPageForMountpointRedirect().
1523 if ($this->page['doktype'] == PageRepository::DOKTYPE_MOUNTPOINT && $this->page['mount_pid_ol']) {
1524 $this->originalMountPointPage = $this->page;
1525 $this->page = $this->sys_page->getPage($this->page['mount_pid']);
1526 if (empty($this->page)) {
1527 $message = 'This page (ID ' . $this->originalMountPointPage['uid'] . ') is of type "Mount point" and '
1528 . 'mounts a page which is not accessible (ID ' . $this->originalMountPointPage['mount_pid'] . ').';
1529 throw new PageNotFoundException($message, 1402043263);
1530 }
1531 $this->MP = $this->page['uid'] . '-' . $this->originalMountPointPage['uid'];
1532 $this->id = $this->page['uid'];
1533 }
1534 // Gets the rootLine
1535 $this->rootLine = $this->sys_page->getRootLine($this->id, $this->MP);
1536 // If not rootline we're off...
1537 if (!count($this->rootLine)) {
1538 $ws = $this->whichWorkspace();
1539 if ($this->sys_page->error_getRootLine_failPid == -1 && $ws) {
1540 $this->sys_page->versioningPreview = TRUE;
1541 $this->versioningWorkspaceId = $ws;
1542 $this->rootLine = $this->sys_page->getRootLine($this->id, $this->MP);
1543 }
1544 if (!count($this->rootLine)) {
1545 $message = 'The requested page didn\'t have a proper connection to the tree-root!';
1546 if ($this->checkPageUnavailableHandler()) {
1547 $this->pageUnavailableAndExit($message);
1548 } else {
1549 $rootline = '(' . $this->sys_page->error_getRootLine . ')';
1550 GeneralUtility::sysLog($message, 'cms', GeneralUtility::SYSLOG_SEVERITY_ERROR);
1551 throw new \TYPO3\CMS\Core\Error\Http\ServiceUnavailableException($message . '<br /><br />' . $rootline, 1301648167);
1552 }
1553 }
1554 $this->fePreview = 1;
1555 }
1556 // Checking for include section regarding the hidden/starttime/endtime/fe_user (that is access control of a whole subbranch!)
1557 if ($this->checkRootlineForIncludeSection()) {
1558 if (!count($this->rootLine)) {
1559 $message = 'The requested page was not accessible!';
1560 if ($this->checkPageUnavailableHandler()) {
1561 $this->pageUnavailableAndExit($message);
1562 } else {
1563 GeneralUtility::sysLog($message, 'cms', GeneralUtility::SYSLOG_SEVERITY_ERROR);
1564 throw new \TYPO3\CMS\Core\Error\Http\ServiceUnavailableException($message, 1301648234);
1565 }
1566 } else {
1567 $el = reset($this->rootLine);
1568 $this->id = $el['uid'];
1569 $this->page = $this->sys_page->getPage($this->id);
1570 $this->rootLine = $this->sys_page->getRootLine($this->id, $this->MP);
1571 }
1572 }
1573 }
1574
1575 /**
1576 * Get page shortcut; Finds the records pointed to by input value $SC (the shortcut value)
1577 *
1578 * @param int $SC The value of the "shortcut" field from the pages record
1579 * @param int $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
1580 * @param int $thisUid The current page UID of the page which is a shortcut
1581 * @param int $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...)
1582 * @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.
1583 * @param bool $disableGroupCheck If true, the group check is disabled when fetching the target page (needed e.g. for menu generation)
1584 * @throws \RuntimeException
1585 * @throws PageNotFoundException
1586 * @return mixed Returns the page record of the page that the shortcut pointed to.
1587 * @access private
1588 * @see getPageAndRootline()
1589 */
1590 public function getPageShortcut($SC, $mode, $thisUid, $itera = 20, $pageLog = array(), $disableGroupCheck = FALSE) {
1591 $idArray = GeneralUtility::intExplode(',', $SC);
1592 // Find $page record depending on shortcut mode:
1593 switch ($mode) {
1594 case PageRepository::SHORTCUT_MODE_FIRST_SUBPAGE:
1595
1596 case PageRepository::SHORTCUT_MODE_RANDOM_SUBPAGE:
1597 $pageArray = $this->sys_page->getMenu($idArray[0] ? $idArray[0] : $thisUid, '*', 'sorting', 'AND pages.doktype<199 AND pages.doktype!=' . PageRepository::DOKTYPE_BE_USER_SECTION);
1598 $pO = 0;
1599 if ($mode == PageRepository::SHORTCUT_MODE_RANDOM_SUBPAGE && count($pageArray)) {
1600 $randval = (int)rand(0, count($pageArray) - 1);
1601 $pO = $randval;
1602 }
1603 $c = 0;
1604 foreach ($pageArray as $pV) {
1605 if ($c == $pO) {
1606 $page = $pV;
1607 break;
1608 }
1609 $c++;
1610 }
1611 if (count($page) == 0) {
1612 $message = 'This page (ID ' . $thisUid . ') is of type "Shortcut" and configured to redirect to a subpage. ' . 'However, this page has no accessible subpages.';
1613 throw new PageNotFoundException($message, 1301648328);
1614 }
1615 break;
1616 case PageRepository::SHORTCUT_MODE_PARENT_PAGE:
1617 $parent = $this->sys_page->getPage($idArray[0] ? $idArray[0] : $thisUid, $disableGroupCheck);
1618 $page = $this->sys_page->getPage($parent['pid'], $disableGroupCheck);
1619 if (count($page) == 0) {
1620 $message = 'This page (ID ' . $thisUid . ') is of type "Shortcut" and configured to redirect to its parent page. ' . 'However, the parent page is not accessible.';
1621 throw new PageNotFoundException($message, 1301648358);
1622 }
1623 break;
1624 default:
1625 $page = $this->sys_page->getPage($idArray[0], $disableGroupCheck);
1626 if (count($page) == 0) {
1627 $message = 'This page (ID ' . $thisUid . ') is of type "Shortcut" and configured to redirect to a page, which is not accessible (ID ' . $idArray[0] . ').';
1628 throw new PageNotFoundException($message, 1301648404);
1629 }
1630 }
1631 // Check if short cut page was a shortcut itself, if so look up recursively:
1632 if ($page['doktype'] == PageRepository::DOKTYPE_SHORTCUT) {
1633 if (!in_array($page['uid'], $pageLog) && $itera > 0) {
1634 $pageLog[] = $page['uid'];
1635 $page = $this->getPageShortcut($page['shortcut'], $page['shortcut_mode'], $page['uid'], $itera - 1, $pageLog, $disableGroupCheck);
1636 } else {
1637 $pageLog[] = $page['uid'];
1638 $message = 'Page shortcuts were looping in uids ' . implode(',', $pageLog) . '...!';
1639 GeneralUtility::sysLog($message, 'cms', GeneralUtility::SYSLOG_SEVERITY_ERROR);
1640 throw new \RuntimeException($message, 1294587212);
1641 }
1642 }
1643 // Return resulting page:
1644 return $page;
1645 }
1646
1647 /**
1648 * Checks the current rootline for defined sections.
1649 *
1650 * @return bool
1651 * @access private
1652 */
1653 public function checkRootlineForIncludeSection() {
1654 $c = count($this->rootLine);
1655 $removeTheRestFlag = 0;
1656 for ($a = 0; $a < $c; $a++) {
1657 if (!$this->checkPagerecordForIncludeSection($this->rootLine[$a])) {
1658 // Add to page access failure history:
1659 $this->pageAccessFailureHistory['sub_section'][] = $this->rootLine[$a];
1660 $removeTheRestFlag = 1;
1661 }
1662 if ($this->rootLine[$a]['doktype'] == PageRepository::DOKTYPE_BE_USER_SECTION) {
1663 // If there is a backend user logged in, check if he has read access to the page:
1664 if ($this->beUserLogin) {
1665 $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery('uid', 'pages', 'uid=' . (int)$this->id . ' AND ' . $GLOBALS['BE_USER']->getPagePermsClause(1));
1666 // versionOL()?
1667 list($isPage) = $GLOBALS['TYPO3_DB']->sql_fetch_row($res);
1668 if (!$isPage) {
1669 // 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...
1670 $removeTheRestFlag = 1;
1671 }
1672 } else {
1673 // Dont go here, if there is no backend user logged in.
1674 $removeTheRestFlag = 1;
1675 }
1676 }
1677 if ($removeTheRestFlag) {
1678 // Page is 'not found' in case a subsection was found and not accessible, code 2
1679 $this->pageNotFound = 2;
1680 unset($this->rootLine[$a]);
1681 }
1682 }
1683 return $removeTheRestFlag;
1684 }
1685
1686 /**
1687 * Checks page record for enableFields
1688 * Returns TRUE if enableFields does not disable the page record.
1689 * Takes notice of the ->showHiddenPage flag and uses SIM_ACCESS_TIME for start/endtime evaluation
1690 *
1691 * @param array $row The page record to evaluate (needs fields: hidden, starttime, endtime, fe_group)
1692 * @param bool $bypassGroupCheck Bypass group-check
1693 * @return bool TRUE, if record is viewable.
1694 * @see TYPO3\\CMS\\Frontend\\ContentObject\\ContentObjectRenderer::getTreeList(), checkPagerecordForIncludeSection()
1695 */
1696 public function checkEnableFields($row, $bypassGroupCheck = FALSE) {
1697 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'])) {
1698 $_params = array('pObj' => $this, 'row' => &$row, 'bypassGroupCheck' => &$bypassGroupCheck);
1699 foreach ($this->TYPO3_CONF_VARS['SC_OPTIONS']['tslib/class.tslib_fe.php']['hook_checkEnableFields'] as $_funcRef) {
1700 // Call hooks: If one returns FALSE, method execution is aborted with result "This record is not available"
1701 $return = GeneralUtility::callUserFunction($_funcRef, $_params, $this);
1702 if ($return === FALSE) {
1703 return FALSE;
1704 }
1705 }
1706 }
1707 if ((!$row['hidden'] || $this->showHiddenPage) && $row['starttime'] <= $GLOBALS['SIM_ACCESS_TIME'] && ($row['endtime'] == 0 || $row['endtime'] > $GLOBALS['SIM_ACCESS_TIME']) && ($bypassGroupCheck || $this->checkPageGroupAccess($row))) {
1708 return TRUE;
1709 }
1710 }
1711
1712 /**
1713 * Check group access against a page record
1714 *
1715 * @param array $row The page record to evaluate (needs field: fe_group)
1716 * @param mixed $groupList List of group id's (comma list or array). Default is $this->gr_list
1717 * @return bool TRUE, if group access is granted.
1718 * @access private
1719 */
1720 public function checkPageGroupAccess($row, $groupList = NULL) {
1721 if (is_null($groupList)) {
1722 $groupList = $this->gr_list;
1723 }
1724 if (!is_array($groupList)) {
1725 $groupList = explode(',', $groupList);
1726 }
1727 $pageGroupList = explode(',', $row['fe_group'] ?: 0);
1728 return count(array_intersect($groupList, $pageGroupList)) > 0;
1729 }
1730
1731 /**
1732 * Checks page record for include section
1733 *
1734 * @param array $row The page record to evaluate (needs fields: extendToSubpages + hidden, starttime, endtime, fe_group)
1735 * @return bool Returns TRUE if either extendToSubpages is not checked or if the enableFields does not disable the page record.
1736 * @access private
1737 * @see checkEnableFields(), TYPO3\\CMS\\Frontend\\ContentObject\\ContentObjectRenderer::getTreeList(), checkRootlineForIncludeSection()
1738 */
1739 public function checkPagerecordForIncludeSection($row) {
1740 return !$row['extendToSubpages'] || $this->checkEnableFields($row) ? 1 : 0;
1741 }
1742
1743 /**
1744 * 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!)
1745 *
1746 * @return bool returns TRUE if logins are OK, otherwise FALSE (and then the login user must be unset!)
1747 */
1748 public function checkIfLoginAllowedInBranch() {
1749 // Initialize:
1750 $c = count($this->rootLine);
1751 $disable = FALSE;
1752 // Traverse root line from root and outwards:
1753 for ($a = 0; $a < $c; $a++) {
1754 // If a value is set for login state:
1755 if ($this->rootLine[$a]['fe_login_mode'] > 0) {
1756 // Determine state from value:
1757 if ((int)$this->rootLine[$a]['fe_login_mode'] === 1) {
1758 $disable = TRUE;
1759 $this->loginAllowedInBranch_mode = 'all';
1760 } elseif ((int)$this->rootLine[$a]['fe_login_mode'] === 3) {
1761 $disable = TRUE;
1762 $this->loginAllowedInBranch_mode = 'groups';
1763 } else {
1764 $disable = FALSE;
1765 }
1766 }
1767 }
1768 return !$disable;
1769 }
1770
1771 /**
1772 * 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
1773 *
1774 * @return array Summary of why page access was not allowed.
1775 */
1776 public function getPageAccessFailureReasons() {
1777 $output = array();
1778 $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());
1779 if (count($combinedRecords)) {
1780 foreach ($combinedRecords as $k => $pagerec) {
1781 // 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
1782 // 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!
1783 if (!$k || $pagerec['extendToSubpages']) {
1784 if ($pagerec['hidden']) {
1785 $output['hidden'][$pagerec['uid']] = TRUE;
1786 }
1787 if ($pagerec['starttime'] > $GLOBALS['SIM_ACCESS_TIME']) {
1788 $output['starttime'][$pagerec['uid']] = $pagerec['starttime'];
1789 }
1790 if ($pagerec['endtime'] != 0 && $pagerec['endtime'] <= $GLOBALS['SIM_ACCESS_TIME']) {
1791 $output['endtime'][$pagerec['uid']] = $pagerec['endtime'];
1792 }
1793 if (!$this->checkPageGroupAccess($pagerec)) {
1794 $output['fe_group'][$pagerec['uid']] = $pagerec['fe_group'];
1795 }
1796 }
1797 }
1798 }
1799 return $output;
1800 }
1801
1802 /**
1803 * This checks if there are ARGV-parameters in the QUERY_STRING and if so, those are used for the id
1804 * $this->id must be 'FALSE' in order for any processing to happen in here
1805 * If an id/alias value is extracted from the QUERY_STRING it is set in $this->id
1806 *
1807 * @return void
1808 * @access private
1809 */
1810 public function setIDfromArgV() {
1811 if (!$this->id) {
1812 list($theAlias) = explode('&', GeneralUtility::getIndpEnv('QUERY_STRING'));
1813 $theAlias = trim($theAlias);
1814 $this->id = $theAlias != '' && strpos($theAlias, '=') === FALSE ? $theAlias : 0;
1815 }
1816 }
1817
1818 /**
1819 * Gets ->page and ->rootline information based on ->id. ->id may change during this operation.
1820 * If not inside domain, then default to first page in domain.
1821 *
1822 * @param int $domainStartPage Page uid of the page where the found domain record is (pid of the domain record)
1823 * @return void
1824 * @access private
1825 */
1826 public function getPageAndRootlineWithDomain($domainStartPage) {
1827 $this->getPageAndRootline();
1828 // 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.
1829 if ($domainStartPage && is_array($this->rootLine)) {
1830 $idFound = 0;
1831 foreach ($this->rootLine as $key => $val) {
1832 if ($val['uid'] == $domainStartPage) {
1833 $idFound = 1;
1834 break;
1835 }
1836 }
1837 if (!$idFound) {
1838 // Page is 'not found' in case the id was outside the domain, code 3
1839 $this->pageNotFound = 3;
1840 $this->id = $domainStartPage;
1841 // re-get the page and rootline if the id was not found.
1842 $this->getPageAndRootline();
1843 }
1844 }
1845 }
1846
1847 /**
1848 * Sets sys_page where-clause
1849 *
1850 * @return void
1851 * @access private
1852 */
1853 public function setSysPageWhereClause() {
1854 $this->sys_page->where_hid_del .= ' AND pages.doktype<200';
1855 $this->sys_page->where_groupAccess = $this->sys_page->getMultipleGroupsWhereClause('pages.fe_group', 'pages');
1856 }
1857
1858 /**
1859 * Looking up a domain record based on HTTP_HOST
1860 *
1861 * @param bool $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.
1862 * @return int Returns the page id of the page where the domain record was found.
1863 * @access private
1864 */
1865 public function findDomainRecord($recursive = FALSE) {
1866 if ($recursive) {
1867 $host = explode('.', GeneralUtility::getIndpEnv('HTTP_HOST'));
1868 while (count($host)) {
1869 $pageUid = $this->sys_page->getDomainStartPage(implode('.', $host), GeneralUtility::getIndpEnv('SCRIPT_NAME'), GeneralUtility::getIndpEnv('REQUEST_URI'));
1870 if ($pageUid) {
1871 return $pageUid;
1872 } else {
1873 array_shift($host);
1874 }
1875 }
1876 return $pageUid;
1877 } else {
1878 return $this->sys_page->getDomainStartPage(GeneralUtility::getIndpEnv('HTTP_HOST'), GeneralUtility::getIndpEnv('SCRIPT_NAME'), GeneralUtility::getIndpEnv('REQUEST_URI'));
1879 }
1880 }
1881
1882 /**
1883 * Page unavailable handler for use in frontend plugins from extensions.
1884 *
1885 * @param string $reason Reason text
1886 * @param string $header HTTP header to send
1887 * @return void Function exits.
1888 */
1889 public function pageUnavailableAndExit($reason = '', $header = '') {
1890 $header = $header ?: $this->TYPO3_CONF_VARS['FE']['pageUnavailable_handling_statheader'];
1891 $this->pageUnavailableHandler($this->TYPO3_CONF_VARS['FE']['pageUnavailable_handling'], $header, $reason);
1892 die;
1893 }
1894
1895 /**
1896 * Page-not-found handler for use in frontend plugins from extensions.
1897 *
1898 * @param string $reason Reason text
1899 * @param string $header HTTP header to send
1900 * @return void Function exits.
1901 */
1902 public function pageNotFoundAndExit($reason = '', $header = '') {
1903 $header = $header ?: $this->TYPO3_CONF_VARS['FE']['pageNotFound_handling_statheader'];
1904 $this->pageNotFoundHandler($this->TYPO3_CONF_VARS['FE']['pageNotFound_handling'], $header, $reason);
1905 die;
1906 }
1907
1908 /**
1909 * Checks whether the pageUnavailableHandler should be used. To be used, pageUnavailable_handling must be set
1910 * and devIPMask must not match the current visitor's IP address.
1911 *
1912 * @return bool TRUE/FALSE whether the pageUnavailable_handler should be used.
1913 */
1914 public function checkPageUnavailableHandler() {
1915 if (
1916 $this->TYPO3_CONF_VARS['FE']['pageUnavailable_handling']
1917 && !GeneralUtility::cmpIP(
1918 GeneralUtility::getIndpEnv('REMOTE_ADDR'),
1919 $this->TYPO3_CONF_VARS['SYS']['devIPmask']
1920 )
1921 ) {
1922 $checkPageUnavailableHandler = TRUE;
1923 } else {
1924 $checkPageUnavailableHandler = FALSE;
1925 }
1926 return $checkPageUnavailableHandler;
1927 }
1928
1929 /**
1930 * Page unavailable handler. Acts a wrapper for the pageErrorHandler method.
1931 *
1932 * @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.
1933 * @param string $header If set, this is passed directly to the PHP function, header()
1934 * @param string $reason If set, error messages will also mention this as the reason for the page-not-found.
1935 * @return void (The function exits!)
1936 */
1937 public function pageUnavailableHandler($code, $header, $reason) {
1938 $this->pageErrorHandler($code, $header, $reason);
1939 }
1940
1941 /**
1942 * Page not found handler. Acts a wrapper for the pageErrorHandler method.
1943 *
1944 * @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.
1945 * @param string $header If set, this is passed directly to the PHP function, header()
1946 * @param string $reason If set, error messages will also mention this as the reason for the page-not-found.
1947 * @return void (The function exits!)
1948 */
1949 public function pageNotFoundHandler($code, $header = '', $reason = '') {
1950 $this->pageErrorHandler($code, $header, $reason);
1951 }
1952
1953 /**
1954 * Generic error page handler.
1955 * Exits.
1956 *
1957 * @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.
1958 * @param string $header If set, this is passed directly to the PHP function, header()
1959 * @param string $reason If set, error messages will also mention this as the reason for the page-not-found.
1960 * @throws \RuntimeException
1961 * @return void (The function exits!)
1962 */
1963 public function pageErrorHandler($code, $header = '', $reason = '') {
1964 // Issue header in any case:
1965 if ($header) {
1966 $headerArr = preg_split('/\\r|\\n/', $header, -1, PREG_SPLIT_NO_EMPTY);
1967 foreach ($headerArr as $header) {
1968 header($header);
1969 }
1970 }
1971 // Create response:
1972 // Simply boolean; Just shows TYPO3 error page with reason:
1973 if (gettype($code) == 'boolean' || (string)$code === '1') {
1974 $title = 'Page Not Found';
1975 $message = 'The page did not exist or was inaccessible.' . ($reason ? ' Reason: ' . htmlspecialchars($reason) : '');
1976 $messagePage = GeneralUtility::makeInstance(\TYPO3\CMS\Core\Messaging\ErrorpageMessage::class, $message, $title);
1977 $messagePage->output();
1978 die;
1979 } elseif (GeneralUtility::isFirstPartOfStr($code, 'USER_FUNCTION:')) {
1980 $funcRef = trim(substr($code, 14));
1981 $params = array(
1982 'currentUrl' => GeneralUtility::getIndpEnv('REQUEST_URI'),
1983 'reasonText' => $reason,
1984 'pageAccessFailureReasons' => $this->getPageAccessFailureReasons()
1985 );
1986 echo GeneralUtility::callUserFunction($funcRef, $params, $this);
1987 } elseif (GeneralUtility::isFirstPartOfStr($code, 'READFILE:')) {
1988 $readFile = GeneralUtility::getFileAbsFileName(trim(substr($code, 9)));
1989 if (@is_file($readFile)) {
1990 echo str_replace(
1991 array(
1992 '###CURRENT_URL###',
1993 '###REASON###'
1994 ),
1995 array(
1996 GeneralUtility::getIndpEnv('REQUEST_URI'),
1997 htmlspecialchars($reason)
1998 ),
1999 GeneralUtility::getUrl($readFile)
2000 );
2001 } else {
2002 throw new \RuntimeException('Configuration Error: 404 page "' . $readFile . '" could not be found.', 1294587214);
2003 }
2004 } elseif (GeneralUtility::isFirstPartOfStr($code, 'REDIRECT:')) {
2005 HttpUtility::redirect(substr($code, 9));
2006 } elseif ($code !== '') {
2007 // Check if URL is relative
2008 $url_parts = parse_url($code);
2009 if ($url_parts['host'] == '') {
2010 $url_parts['host'] = GeneralUtility::getIndpEnv('HTTP_HOST');
2011 if ($code[0] === '/') {
2012 $code = GeneralUtility::getIndpEnv('TYPO3_REQUEST_HOST') . $code;
2013 } else {
2014 $code = GeneralUtility::getIndpEnv('TYPO3_REQUEST_DIR') . $code;
2015 }
2016 $checkBaseTag = FALSE;
2017 } else {
2018 $checkBaseTag = TRUE;
2019 }
2020 // Check recursion
2021 if ($code == GeneralUtility::getIndpEnv('TYPO3_REQUEST_URL')) {
2022 if ($reason == '') {
2023 $reason = 'Page cannot be found.';
2024 }
2025 $reason .= LF . LF . 'Additionally, ' . $code . ' was not found while trying to retrieve the error document.';
2026 throw new \RuntimeException(nl2br(htmlspecialchars($reason)), 1294587215);
2027 }
2028 // Prepare headers
2029 $headerArr = array(
2030 'User-agent: ' . GeneralUtility::getIndpEnv('HTTP_USER_AGENT'),
2031 'Referer: ' . GeneralUtility::getIndpEnv('TYPO3_REQUEST_URL')
2032 );
2033 $res = GeneralUtility::getUrl($code, 1, $headerArr);
2034 // Header and content are separated by an empty line
2035 list($header, $content) = explode(CRLF . CRLF, $res, 2);
2036 $content .= CRLF;
2037 if (FALSE === $res) {
2038 // Last chance -- redirect
2039 HttpUtility::redirect($code);
2040 } else {
2041 // Forward these response headers to the client
2042 $forwardHeaders = array(
2043 'Content-Type:'
2044 );
2045 $headerArr = preg_split('/\\r|\\n/', $header, -1, PREG_SPLIT_NO_EMPTY);
2046 foreach ($headerArr as $header) {
2047 foreach ($forwardHeaders as $h) {
2048 if (preg_match('/^' . $h . '/', $header)) {
2049 header($header);
2050 }
2051 }
2052 }
2053 // Put <base> if necesary
2054 if ($checkBaseTag) {
2055 // If content already has <base> tag, we do not need to do anything
2056 if (FALSE === stristr($content, '<base ')) {
2057 // Generate href for base tag
2058 $base = $url_parts['scheme'] . '://';
2059 if ($url_parts['user'] != '') {
2060 $base .= $url_parts['user'];
2061 if ($url_parts['pass'] != '') {
2062 $base .= ':' . $url_parts['pass'];
2063 }
2064 $base .= '@';
2065 }
2066 $base .= $url_parts['host'];
2067 // Add path portion skipping possible file name
2068 $base .= preg_replace('/(.*\\/)[^\\/]*/', '${1}', $url_parts['path']);
2069 // Put it into content (generate also <head> if necessary)
2070 $replacement = LF . '<base href="' . htmlentities($base) . '" />' . LF;
2071 if (stristr($content, '<head>')) {
2072 $content = preg_replace('/(<head>)/i', '\\1' . $replacement, $content);
2073 } else {
2074 $content = preg_replace('/(<html[^>]*>)/i', '\\1<head>' . $replacement . '</head>', $content);
2075 }
2076 }
2077 }
2078 // Output the content
2079 echo $content;
2080 }
2081 } else {
2082 $title = 'Page Not Found';
2083 $message = $reason ? 'Reason: ' . htmlspecialchars($reason) : 'Page cannot be found.';
2084 $messagePage = GeneralUtility::makeInstance(\TYPO3\CMS\Core\Messaging\ErrorpageMessage::class, $message, $title);
2085 $messagePage->output();
2086 }
2087 die;
2088 }
2089
2090 /**
2091 * Fetches the integer page id for a page alias.
2092 * 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
2093 *
2094 * @return void
2095 * @access private
2096 */
2097 public function checkAndSetAlias() {
2098 if ($this->id && !MathUtility::canBeInterpretedAsInteger($this->id)) {
2099 $aid = $this->sys_page->getPageIdFromAlias($this->id);
2100 if ($aid) {
2101 $this->id = $aid;
2102 } else {
2103 $this->pageNotFound = 4;
2104 }
2105 }
2106 }
2107
2108 /**
2109 * Merging values into the global $_GET
2110 *
2111 * @param array $GET_VARS Array of key/value pairs that will be merged into the current GET-vars. (Non-escaped values)
2112 * @return void
2113 */
2114 public function mergingWithGetVars($GET_VARS) {
2115 if (is_array($GET_VARS)) {
2116 // Getting $_GET var, unescaped.
2117 $realGet = GeneralUtility::_GET();
2118 if (!is_array($realGet)) {
2119 $realGet = array();
2120 }
2121 // Merge new values on top:
2122 \TYPO3\CMS\Core\Utility\ArrayUtility::mergeRecursiveWithOverrule($realGet, $GET_VARS);
2123 // Write values back to $_GET:
2124 GeneralUtility::_GETset($realGet);
2125 // Setting these specifically (like in the init-function):
2126 if (isset($GET_VARS['type'])) {
2127 $this->type = (int)$GET_VARS['type'];
2128 }
2129 if (isset($GET_VARS['cHash'])) {
2130 $this->cHash = $GET_VARS['cHash'];
2131 }
2132 if (isset($GET_VARS['jumpurl'])) {
2133 $this->jumpurl = $GET_VARS['jumpurl'];
2134 }
2135 if (isset($GET_VARS['MP'])) {
2136 $this->MP = $this->TYPO3_CONF_VARS['FE']['enable_mount_pids'] ? $GET_VARS['MP'] : '';
2137 }
2138 if (isset($GET_VARS['no_cache']) && $GET_VARS['no_cache']) {
2139 $this->set_no_cache('no_cache is requested via GET parameter');
2140 }
2141 }
2142 }
2143
2144 /********************************************
2145 *
2146 * Template and caching related functions.
2147 *
2148 *******************************************/
2149 /**
2150 * Calculates a hash string based on additional parameters in the url.
2151 *
2152 * Calculated hash is stored in $this->cHash_array.
2153 * This is used to cache pages with more parameters than just id and type.
2154 *
2155 * @return void
2156 * @see reqCHash()
2157 */
2158 public function makeCacheHash() {
2159 // No need to test anything if caching was already disabled.
2160 if ($this->no_cache && !$this->TYPO3_CONF_VARS['FE']['pageNotFoundOnCHashError']) {
2161 return;
2162 }
2163 $GET = GeneralUtility::_GET();
2164 if ($this->cHash && is_array($GET)) {
2165 $this->cHash_array = $this->cacheHash->getRelevantParameters(GeneralUtility::implodeArrayForUrl('', $GET));
2166 $cHash_calc = $this->cacheHash->calculateCacheHash($this->cHash_array);
2167 if ($cHash_calc != $this->cHash) {
2168 if ($this->TYPO3_CONF_VARS['FE']['pageNotFoundOnCHashError']) {
2169 $this->pageNotFoundAndExit('Request parameters could not be validated (&cHash comparison failed)');
2170 } else {
2171 $this->disableCache();
2172 $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);
2173 }
2174 }
2175 } elseif (is_array($GET)) {
2176 // No cHash is set, check if that is correct
2177 if ($this->cacheHash->doParametersRequireCacheHash(GeneralUtility::implodeArrayForUrl('', $GET))) {
2178 $this->reqCHash();
2179 }
2180 }
2181 }
2182
2183 /**
2184 * Will disable caching if the cHash value was not set.
2185 * This function should be called to check the _existence_ of "&cHash" whenever a plugin generating cacheable output is using extra GET variables. If there _is_ a cHash value the validation of it automatically takes place in makeCacheHash() (see above)
2186 *
2187 * @return void
2188 * @see makeCacheHash(), \TYPO3\CMS\Frontend\Plugin\AbstractPlugin::pi_cHashCheck()
2189 */
2190 public function reqCHash() {
2191 if (!$this->cHash) {
2192 if ($this->TYPO3_CONF_VARS['FE']['pageNotFoundOnCHashError']) {
2193 if ($this->tempContent) {
2194 $this->clearPageCacheContent();
2195 }
2196 $this->pageNotFoundAndExit('Request parameters could not be validated (&cHash empty)');
2197 } else {
2198 $this->disableCache();
2199 $GLOBALS['TT']->setTSlogMessage('TSFE->reqCHash(): No &cHash parameter was sent for GET vars though required so caching is disabled', 2);
2200 }
2201 }
2202 }
2203
2204 /**
2205 * Initialize the TypoScript template parser
2206 *
2207 * @return void
2208 */
2209 public function initTemplate() {
2210 $this->tmpl = GeneralUtility::makeInstance(\TYPO3\CMS\Core\TypoScript\TemplateService::class);
2211 $this->tmpl->setVerbose((bool)$this->beUserLogin);
2212 $this->tmpl->init();
2213 $this->tmpl->tt_track = (bool)$this->beUserLogin;
2214 }
2215
2216 /**
2217 * See if page is in cache and get it if so
2218 * Stores the page content in $this->content if something is found.
2219 *
2220 * @return void
2221 */
2222 public function getFromCache() {
2223 if (!$this->no_cache) {
2224 $cc = $this->tmpl->getCurrentPageData();
2225 if (!is_array($cc)) {
2226 $key = $this->id . '::' . $this->MP;
2227 // Returns TRUE if the lock is active now
2228 $isLocked = $this->acquirePageGenerationLock($this->pagesection_lockObj, $key);
2229 if (!$isLocked) {
2230 // Lock is no longer active, the data in "cache_pagesection" is now ready
2231 $cc = $this->tmpl->getCurrentPageData();
2232 if (is_array($cc)) {
2233 // Release the lock
2234 $this->releasePageGenerationLock($this->pagesection_lockObj);
2235 }
2236 }
2237 }
2238 if (is_array($cc)) {
2239 // 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.
2240 // If this hash is not the same in here in this section and after page-generation, then the page will not be properly cached!
2241 // 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.
2242 $cc = $this->tmpl->matching($cc);
2243 ksort($cc);
2244 $this->all = $cc;
2245 }
2246 unset($cc);
2247 }
2248 // clearing the content-variable, which will hold the pagecontent
2249 $this->content = '';
2250 // Unsetting the lowlevel config
2251 unset($this->config);
2252 $this->cacheContentFlag = FALSE;
2253 // Look for page in cache only if caching is not disabled and if a shift-reload is not sent to the server.
2254 if (!$this->no_cache && !$this->headerNoCache()) {
2255 $lockHash = $this->getLockHash();
2256 if ($this->all) {
2257 $this->newHash = $this->getHash();
2258 $GLOBALS['TT']->push('Cache Row', '');
2259 $row = $this->getFromCache_queryRow();
2260 if (!is_array($row)) {
2261 $isLocked = $this->acquirePageGenerationLock($this->pages_lockObj, $lockHash);
2262 if (!$isLocked) {
2263 // Lock is no longer active, the data in "cache_pages" is now ready
2264 $row = $this->getFromCache_queryRow();
2265 if (is_array($row)) {
2266 // Release the lock
2267 $this->releasePageGenerationLock($this->pages_lockObj);
2268 }
2269 }
2270 }
2271 if (is_array($row)) {
2272 // Release this lock
2273 $this->releasePageGenerationLock($this->pages_lockObj);
2274 // Call hook when a page is retrieved from cache:
2275 if (is_array($this->TYPO3_CONF_VARS['SC_OPTIONS']['tslib/class.tslib_fe.php']['pageLoadedFromCache'])) {
2276 $_params = array('pObj' => &$this, 'cache_pages_row' => &$row);
2277 foreach ($this->TYPO3_CONF_VARS['SC_OPTIONS']['tslib/class.tslib_fe.php']['pageLoadedFromCache'] as $_funcRef) {
2278 GeneralUtility::callUserFunction($_funcRef, $_params, $this);
2279 }
2280 }
2281 // Fetches the lowlevel config stored with the cached data
2282 $this->config = $row['cache_data'];
2283 // Getting the content
2284 $this->content = $row['content'];
2285 // Flag for temp content
2286 $this->tempContent = $row['temp_content'];
2287 // Setting flag, so we know, that some cached content has been loaded
2288 $this->cacheContentFlag = TRUE;
2289 $this->cacheExpires = $row['expires'];
2290
2291 if (isset($this->config['config']['debug'])) {
2292 $debugCacheTime = (bool)$this->config['config']['debug'];
2293 } else {
2294 $debugCacheTime = !empty($this->TYPO3_CONF_VARS['FE']['debug']);
2295 }
2296 if ($debugCacheTime) {
2297 $dateFormat = $GLOBALS['TYPO3_CONF_VARS']['SYS']['ddmmyy'];
2298 $timeFormat = $GLOBALS['TYPO3_CONF_VARS']['SYS']['hhmm'];
2299 $this->content .= LF . '<!-- Cached page generated ' . date(($dateFormat . ' ' . $timeFormat), $row['tstamp']) . '. Expires ' . Date(($dateFormat . ' ' . $timeFormat), $row['expires']) . ' -->';
2300 }
2301 }
2302 $GLOBALS['TT']->pull();
2303 } else {
2304 $this->acquirePageGenerationLock($this->pages_lockObj, $lockHash);
2305 }
2306 }
2307 }
2308
2309 /**
2310 * Returning the cached version of page with hash = newHash
2311 *
2312 * @return array Cached row, if any. Otherwise void.
2313 */
2314 public function getFromCache_queryRow() {
2315 $GLOBALS['TT']->push('Cache Query', '');
2316 $row = $this->pageCache->get($this->newHash);
2317 $GLOBALS['TT']->pull();
2318 return $row;
2319 }
2320
2321 /**
2322 * Detecting if shift-reload has been clicked
2323 * Will not be called if re-generation of page happens by other reasons (for instance that the page is not in cache yet!)
2324 * Also, a backend user MUST be logged in for the shift-reload to be detected due to DoS-attack-security reasons.
2325 *
2326 * @return bool If shift-reload in client browser has been clicked, disable getting cached page (and regenerate it).
2327 */
2328 public function headerNoCache() {
2329 $disableAcquireCacheData = FALSE;
2330 if ($this->beUserLogin) {
2331 if (strtolower($_SERVER['HTTP_CACHE_CONTROL']) === 'no-cache' || strtolower($_SERVER['HTTP_PRAGMA']) === 'no-cache') {
2332 $disableAcquireCacheData = TRUE;
2333 }
2334 }
2335 // Call hook for possible by-pass of requiring of page cache (for recaching purpose)
2336 if (is_array($this->TYPO3_CONF_VARS['SC_OPTIONS']['tslib/class.tslib_fe.php']['headerNoCache'])) {
2337 $_params = array('pObj' => &$this, 'disableAcquireCacheData' => &$disableAcquireCacheData);
2338 foreach ($this->TYPO3_CONF_VARS['SC_OPTIONS']['tslib/class.tslib_fe.php']['headerNoCache'] as $_funcRef) {
2339 GeneralUtility::callUserFunction($_funcRef, $_params, $this);
2340 }
2341 }
2342 return $disableAcquireCacheData;
2343 }
2344
2345 /**
2346 * Calculates the cache-hash
2347 * This hash is unique to the template, the variables ->id, ->type, ->gr_list (list of groups), ->MP (Mount Points) and cHash array
2348 * Used to get and later store the cached data.
2349 *
2350 * @return string MD5 hash of serialized hash base from createHashBase()
2351 * @access private
2352 * @see getFromCache(), getLockHash()
2353 */
2354 public function getHash() {
2355 return md5($this->createHashBase(FALSE));
2356 }
2357
2358 /**
2359 * Calculates the lock-hash
2360 * This hash is unique to the above hash, except that it doesn't contain the template information in $this->all.
2361 *
2362 * @return string MD5 hash
2363 * @access private
2364 * @see getFromCache(), getHash()
2365 */
2366 public function getLockHash() {
2367 $lockHash = $this->createHashBase(TRUE);
2368 return md5($lockHash);
2369 }
2370
2371 /**
2372 * Calculates the cache-hash (or the lock-hash)
2373 * This hash is unique to the template,
2374 * the variables ->id, ->type, ->gr_list (list of groups),
2375 * ->MP (Mount Points) and cHash array
2376 * Used to get and later store the cached data.
2377 *
2378 * @param bool $createLockHashBase Whether to create the lock hash, which doesn't contain the "this->all" (the template information)
2379 * @return string the serialized hash base
2380 */
2381 protected function createHashBase($createLockHashBase = FALSE) {
2382 $hashParameters = array(
2383 'id' => (int)$this->id,
2384 'type' => (int)$this->type,
2385 'gr_list' => (string)$this->gr_list,
2386 'MP' => (string)$this->MP,
2387 'cHash' => $this->cHash_array,
2388 'domainStartPage' => $this->domainStartPage
2389 );
2390 // Include the template information if we shouldn't create a lock hash
2391 if (!$createLockHashBase) {
2392 $hashParameters['all'] = $this->all;
2393 }
2394 // Call hook to influence the hash calculation
2395 if (is_array($this->TYPO3_CONF_VARS['SC_OPTIONS']['tslib/class.tslib_fe.php']['createHashBase'])) {
2396 $_params = array(
2397 'hashParameters' => &$hashParameters,
2398 'createLockHashBase' => $createLockHashBase
2399 );
2400 foreach ($this->TYPO3_CONF_VARS['SC_OPTIONS']['tslib/class.tslib_fe.php']['createHashBase'] as $_funcRef) {
2401 GeneralUtility::callUserFunction($_funcRef, $_params, $this);
2402 }
2403 }
2404 return serialize($hashParameters);
2405 }
2406
2407 /**
2408 * Checks if config-array exists already but if not, gets it
2409 *
2410 * @throws \TYPO3\CMS\Core\Error\Http\ServiceUnavailableException
2411 * @return void
2412 */
2413 public function getConfigArray() {
2414 $setStatPageName = FALSE;
2415 // 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
2416 if (!is_array($this->config) || is_array($this->config['INTincScript']) || $this->forceTemplateParsing) {
2417 $GLOBALS['TT']->push('Parse template', '');
2418 // Force parsing, if set?:
2419 $this->tmpl->forceTemplateParsing = $this->forceTemplateParsing;
2420 // Start parsing the TS template. Might return cached version.
2421 $this->tmpl->start($this->rootLine);
2422 $GLOBALS['TT']->pull();
2423 if ($this->tmpl->loaded) {
2424 $GLOBALS['TT']->push('Setting the config-array', '');
2425 // toplevel - objArrayName
2426 $this->sPre = $this->tmpl->setup['types.'][$this->type];
2427 $this->pSetup = $this->tmpl->setup[$this->sPre . '.'];
2428 if (!is_array($this->pSetup)) {
2429 $message = 'The page is not configured! [type=' . $this->type . '][' . $this->sPre . '].';
2430 if ($this->checkPageUnavailableHandler()) {
2431 $this->pageUnavailableAndExit($message);
2432 } else {
2433 $explanation = 'This means that there is no TypoScript object of type PAGE with typeNum=' . $this->type . ' configured.';
2434 GeneralUtility::sysLog($message, 'cms', GeneralUtility::SYSLOG_SEVERITY_ERROR);
2435 throw new \TYPO3\CMS\Core\Error\Http\ServiceUnavailableException($message . ' ' . $explanation, 1294587217);
2436 }
2437 } else {
2438 $this->config['config'] = array();
2439 // Filling the config-array, first with the main "config." part
2440 if (is_array($this->tmpl->setup['config.'])) {
2441 $this->config['config'] = $this->tmpl->setup['config.'];
2442 }
2443 // override it with the page/type-specific "config."
2444 if (is_array($this->pSetup['config.'])) {
2445 \TYPO3\CMS\Core\Utility\ArrayUtility::mergeRecursiveWithOverrule($this->config['config'], $this->pSetup['config.']);
2446 }
2447 if ($this->config['config']['typolinkEnableLinksAcrossDomains']) {
2448 $this->config['config']['typolinkCheckRootline'] = TRUE;
2449 }
2450 // Set default values for removeDefaultJS and inlineStyle2TempFile so CSS and JS are externalized if compatversion is higher than 4.0
2451 if (!isset($this->config['config']['removeDefaultJS'])) {
2452 $this->config['config']['removeDefaultJS'] = 'external';
2453 }
2454 if (!isset($this->config['config']['inlineStyle2TempFile'])) {
2455 $this->config['config']['inlineStyle2TempFile'] = 1;
2456 }
2457
2458 if (!isset($this->config['config']['compressJs'])) {
2459 $this->config['config']['compressJs'] = 0;
2460 }
2461 // Processing for the config_array:
2462 $this->config['rootLine'] = $this->tmpl->rootLine;
2463 $this->config['mainScript'] = trim($this->config['config']['mainScript']) ?: 'index.php';
2464 // Class for render Header and Footer parts
2465 $template = '';
2466 if ($this->pSetup['pageHeaderFooterTemplateFile']) {
2467 $file = $this->tmpl->getFileName($this->pSetup['pageHeaderFooterTemplateFile']);
2468 if ($file) {
2469 $this->getPageRenderer()->setTemplateFile($file);
2470 }
2471 }
2472 }
2473 $GLOBALS['TT']->pull();
2474 } else {
2475 if ($this->checkPageUnavailableHandler()) {
2476 $this->pageUnavailableAndExit('No TypoScript template found!');
2477 } else {
2478 $message = 'No TypoScript template found!';
2479 GeneralUtility::sysLog($message, 'cms', GeneralUtility::SYSLOG_SEVERITY_ERROR);
2480 throw new \TYPO3\CMS\Core\Error\Http\ServiceUnavailableException($message, 1294587218);
2481 }
2482 }
2483 }
2484
2485 // No cache
2486 // Set $this->no_cache TRUE if the config.no_cache value is set!
2487 if ($this->config['config']['no_cache']) {
2488 $this->set_no_cache('config.no_cache is set');
2489 }
2490 // Merge GET with defaultGetVars
2491 if (!empty($this->config['config']['defaultGetVars.'])) {
2492 $modifiedGetVars = GeneralUtility::removeDotsFromTS($this->config['config']['defaultGetVars.']);
2493 \TYPO3\CMS\Core\Utility\ArrayUtility::mergeRecursiveWithOverrule($modifiedGetVars, GeneralUtility::_GET());
2494 GeneralUtility::_GETset($modifiedGetVars);
2495 }
2496 // Hook for postProcessing the configuration array
2497 if (is_array($this->TYPO3_CONF_VARS['SC_OPTIONS']['tslib/class.tslib_fe.php']['configArrayPostProc'])) {
2498 $params = array('config' => &$this->config['config']);
2499 foreach ($this->TYPO3_CONF_VARS['SC_OPTIONS']['tslib/class.tslib_fe.php']['configArrayPostProc'] as $funcRef) {
2500 GeneralUtility::callUserFunction($funcRef, $params, $this);
2501 }
2502 }
2503 }
2504
2505 /********************************************
2506 *
2507 * Further initialization and data processing
2508 * (jumpurl/submission of forms)
2509 *
2510 *******************************************/
2511
2512 /**
2513 * Setting the language key that will be used by the current page.
2514 * 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.
2515 *
2516 * @return void
2517 * @access private
2518 */
2519 public function settingLanguage() {
2520 if (is_array($this->TYPO3_CONF_VARS['SC_OPTIONS']['tslib/class.tslib_fe.php']['settingLanguage_preProcess'])) {
2521 $_params = array();
2522 foreach ($this->TYPO3_CONF_VARS['SC_OPTIONS']['tslib/class.tslib_fe.php']['settingLanguage_preProcess'] as $_funcRef) {
2523 GeneralUtility::callUserFunction($_funcRef, $_params, $this);
2524 }
2525 }
2526
2527 // Initialize charset settings etc.
2528 $this->initLLvars();
2529
2530 // Get values from TypoScript:
2531 $this->sys_language_uid = ($this->sys_language_content = (int)$this->config['config']['sys_language_uid']);
2532 list($this->sys_language_mode, $sys_language_content) = GeneralUtility::trimExplode(';', $this->config['config']['sys_language_mode']);
2533 $this->sys_language_contentOL = $this->config['config']['sys_language_overlay'];
2534 // If sys_language_uid is set to another language than default:
2535 if ($this->sys_language_uid > 0) {
2536 // check whether a shortcut is overwritten by a translated page
2537 // we can only do this now, as this is the place where we get
2538 // to know about translations
2539 $this->checkTranslatedShortcut();
2540 // Request the overlay record for the sys_language_uid:
2541 $olRec = $this->sys_page->getPageOverlay($this->id, $this->sys_language_uid);
2542 if (!count($olRec)) {
2543 // If no OL record exists and a foreign language is asked for...
2544 if ($this->sys_language_uid) {
2545 // If requested translation is not available:
2546 if (GeneralUtility::hideIfNotTranslated($this->page['l18n_cfg'])) {
2547 $this->pageNotFoundAndExit('Page is not available in the requested language.');
2548 } else {
2549 switch ((string)$this->sys_language_mode) {
2550 case 'strict':
2551 $this->pageNotFoundAndExit('Page is not available in the requested language (strict).');
2552 break;
2553 case 'content_fallback':
2554 $fallBackOrder = GeneralUtility::intExplode(',', $sys_language_content);
2555 foreach ($fallBackOrder as $orderValue) {
2556 if ((string)$orderValue === '0' || count($this->sys_page->getPageOverlay($this->id, $orderValue))) {
2557 $this->sys_language_content = $orderValue;
2558 // Setting content uid (but leaving the sys_language_uid)
2559 break;
2560 }
2561 }
2562 break;
2563 case 'ignore':
2564 $this->sys_language_content = $this->sys_language_uid;
2565 break;
2566 default:
2567 // Default is that everything defaults to the default language...
2568 $this->sys_language_uid = ($this->sys_language_content = 0);
2569 }
2570 }
2571 }
2572 } else {
2573 // Setting sys_language if an overlay record was found (which it is only if a language is used)
2574 $this->page = $this->sys_page->getPageOverlay($this->page, $this->sys_language_uid);
2575 }
2576 }
2577 // Setting sys_language_uid inside sys-page:
2578 $this->sys_page->sys_language_uid = $this->sys_language_uid;
2579 // If default translation is not available:
2580 if ((!$this->sys_language_uid || !$this->sys_language_content) && $this->page['l18n_cfg'] & 1) {
2581 $message = 'Page is not available in default language.';
2582 GeneralUtility::sysLog($message, 'cms', GeneralUtility::SYSLOG_SEVERITY_ERROR);
2583 $this->pageNotFoundAndExit($message);
2584 }
2585 $this->updateRootLinesWithTranslations();
2586
2587 // Finding the ISO code for the currently selected language
2588 // fetched by the sys_language record when not fetching content from the default language
2589 if ($this->sys_language_content > 0) {
2590 // using sys_language_content because the ISO code only (currently) affect content selection from FlexForms - which should follow "sys_language_content"
2591 // Set the fourth parameter to TRUE in the next two getRawRecord() calls to
2592 // avoid versioning overlay to be applied as it generates an SQL error
2593 $sys_language_row = $this->sys_page->getRawRecord('sys_language', $this->sys_language_content, 'language_isocode,static_lang_isocode', TRUE);
2594 if (is_array($sys_language_row)) {
2595 if (!empty($sys_language_row['language_isocode'])) {
2596 $this->sys_language_isocode = $sys_language_row['language_isocode'];
2597 } elseif ($sys_language_row['static_lang_isocode'] && \TYPO3\CMS\Core\Utility\ExtensionManagementUtility::isLoaded('static_info_tables')) {
2598 GeneralUtility::deprecationLog('Usage of the field "static_lang_isocode" is discouraged, and will stop working with CMS 8. Use the built-in language field "language_isocode" in your sys_language records.');
2599 $stLrow = $this->sys_page->getRawRecord('static_languages', $sys_language_row['static_lang_isocode'], 'lg_iso_2', TRUE);
2600 $this->sys_language_isocode = $stLrow['lg_iso_2'];
2601 }
2602 }
2603 // the DB value is overriden by TypoScript
2604 if (!empty($this->config['config']['sys_language_isocode'])) {
2605 $this->sys_language_isocode = $this->config['config']['sys_language_isocode'];
2606 }
2607 } else {
2608 // fallback to the TypoScript option when rendering with sys_language_uid=0
2609 // also: use "en" by default
2610 if (!empty($this->config['config']['sys_language_isocode_default'])) {
2611 $this->sys_language_isocode = $this->config['config']['sys_language_isocode_default'];
2612 } else {
2613 $this->sys_language_isocode = $this->lang != 'default' ? $this->lang : 'en';
2614 }
2615 }
2616
2617
2618 // Setting softMergeIfNotBlank:
2619 $table_fields = GeneralUtility::trimExplode(',', $this->config['config']['sys_language_softMergeIfNotBlank'], TRUE);
2620 foreach ($table_fields as $TF) {
2621 list($tN, $fN) = explode(':', $TF);
2622 $GLOBALS['TCA'][$tN]['columns'][$fN]['l10n_mode'] = 'mergeIfNotBlank';
2623 }
2624 // Setting softExclude:
2625 $table_fields = GeneralUtility::trimExplode(',', $this->config['config']['sys_language_softExclude'], TRUE);
2626 foreach ($table_fields as $TF) {
2627 list($tN, $fN) = explode(':', $TF);
2628 $GLOBALS['TCA'][$tN]['columns'][$fN]['l10n_mode'] = 'exclude';
2629 }
2630 if (is_array($this->TYPO3_CONF_VARS['SC_OPTIONS']['tslib/class.tslib_fe.php']['settingLanguage_postProcess'])) {
2631 $_params = array();
2632 foreach ($this->TYPO3_CONF_VARS['SC_OPTIONS']['tslib/class.tslib_fe.php']['settingLanguage_postProcess'] as $_funcRef) {
2633 GeneralUtility::callUserFunction($_funcRef, $_params, $this);
2634 }
2635 }
2636 }
2637
2638 /**
2639 * Updating content of the two rootLines IF the language key is set!
2640 */
2641 protected function updateRootLinesWithTranslations() {
2642 if ($this->sys_language_uid) {
2643 $this->rootLine = $this->sys_page->getRootLine($this->id, $this->MP);
2644 $this->tmpl->updateRootlineData($this->rootLine);
2645 }
2646 }
2647
2648 /**
2649 * Setting locale for frontend rendering
2650 *
2651 * @return void
2652 */
2653 public function settingLocale() {
2654 // Setting locale
2655 if ($this->config['config']['locale_all']) {
2656 // There's a problem that PHP parses float values in scripts wrong if the
2657 // locale LC_NUMERIC is set to something with a comma as decimal point
2658 // Do we set all except LC_NUMERIC
2659 $locale = setlocale(LC_COLLATE, $this->config['config']['locale_all']);
2660 if ($locale) {
2661 setlocale(LC_CTYPE, $this->config['config']['locale_all']);
2662 setlocale(LC_MONETARY, $this->config['config']['locale_all']);
2663 setlocale(LC_TIME, $this->config['config']['locale_all']);
2664 $this->localeCharset = $this->csConvObj->get_locale_charset($this->config['config']['locale_all']);
2665 } else {
2666 $GLOBALS['TT']->setTSlogMessage('Locale "' . htmlspecialchars($this->config['config']['locale_all']) . '" not found.', 3);
2667 }
2668 }
2669 }
2670
2671 /**
2672 * Checks whether a translated shortcut page has a different shortcut
2673 * target than the original language page.
2674 * If that is the case, things get corrected to follow that alternative
2675 * shortcut
2676 *
2677 * @return void
2678 * @author Ingo Renner <ingo@typo3.org>
2679 */
2680 protected function checkTranslatedShortcut() {
2681 if (!is_null($this->originalShortcutPage)) {
2682 $originalShortcutPageOverlay = $this->sys_page->getPageOverlay($this->originalShortcutPage['uid'], $this->sys_language_uid);
2683 if (!empty($originalShortcutPageOverlay['shortcut']) && $originalShortcutPageOverlay['shortcut'] != $this->id) {
2684 // the translation of the original shortcut page has a different shortcut target!
2685 // set the correct page and id
2686 $shortcut = $this->getPageShortcut($originalShortcutPageOverlay['shortcut'], $originalShortcutPageOverlay['shortcut_mode'], $originalShortcutPageOverlay['uid']);
2687 $this->id = ($this->contentPid = $shortcut['uid']);
2688 $this->page = $this->sys_page->getPage($this->id);
2689 // Fix various effects on things like menus f.e.
2690 $this->fetch_the_id();
2691 $this->tmpl->rootLine = array_reverse($this->rootLine);
2692 }
2693 }
2694 }
2695
2696 /**
2697 * Handle data submission
2698 * This is done at this point, because we need the config values
2699 *
2700 * @return void
2701 */
2702 public function handleDataSubmission() {
2703 // Hook for processing data submission to extensions
2704 if (is_array($this->TYPO3_CONF_VARS['SC_OPTIONS']['tslib/class.tslib_fe.php']['checkDataSubmission'])) {
2705 foreach ($this->TYPO3_CONF_VARS['SC_OPTIONS']['tslib/class.tslib_fe.php']['checkDataSubmission'] as $_classRef) {
2706 $_procObj = GeneralUtility::getUserObj($_classRef);
2707 $_procObj->checkDataSubmission($this);
2708 }
2709 }
2710 }
2711
2712 /**
2713 * Checks if a formmail submission can be sent as email, also used for JumpURLs
2714 * should be removed once JumpURL is handled outside TypoScriptFrontendController
2715 *
2716 * @param string $locationData The input from $_POST['locationData']
2717 * @return void|int
2718 */
2719 protected function locDataCheck($locationData) {
2720 $locData = explode(':', $locationData);
2721 if (!$locData[1] || $this->sys_page->checkRecord($locData[1], $locData[2], 1)) {
2722 // $locData[1] -check means that a record is checked only if the locationData has a value for a record else than the page.
2723 if (count($this->sys_page->getPage($locData[0]))) {
2724 return 1;
2725 } else {
2726 $GLOBALS['TT']->setTSlogMessage('LocationData Error: The page pointed to by location data (' . $locationData . ') was not accessible.', 2);
2727 }
2728 } else {
2729 $GLOBALS['TT']->setTSlogMessage('LocationData Error: Location data (' . $locationData . ') record pointed to was not accessible.', 2);
2730 }
2731 }
2732
2733 /**
2734 * Sets the jumpurl for page type "External URL"
2735 *
2736 * @return void
2737 */
2738 public function setExternalJumpUrl() {
2739 if ($extUrl = $this->sys_page->getExtURL($this->page, $this->config['config']['disablePageExternalUrl'])) {
2740 $this->jumpurl = $extUrl;
2741 GeneralUtility::_GETset(GeneralUtility::hmac($this->jumpurl, 'jumpurl'), 'juHash');
2742 }
2743 }
2744
2745 /**
2746 * Check the jumpUrl referer if required
2747 *
2748 * @return void
2749 */
2750 public function checkJumpUrlReferer() {
2751 if ($this->jumpurl !== '' && !$this->TYPO3_CONF_VARS['SYS']['doNotCheckReferer']) {
2752 $referer = parse_url(GeneralUtility::getIndpEnv('HTTP_REFERER'));
2753 if (isset($referer['host']) && !($referer['host'] == GeneralUtility::getIndpEnv('TYPO3_HOST_ONLY'))) {
2754 unset($this->jumpurl);
2755 }
2756 }
2757 }
2758
2759 /**
2760 * Sends a header "Location" to jumpUrl, if jumpurl is set.
2761 * Will exit if a location header is sent (for instance if jumpUrl was triggered)
2762 *
2763 * "jumpUrl" is a concept where external links are redirected from the index_ts.php script, which first logs the URL.
2764 *
2765 * @throws \Exception
2766 * @return void
2767 */
2768 public function jumpUrl() {
2769 if ($this->jumpurl) {
2770 if (GeneralUtility::_GP('juSecure')) {
2771 $locationData = (string)GeneralUtility::_GP('locationData');
2772 // Need a type cast here because mimeType is optional!
2773 $mimeType = (string)GeneralUtility::_GP('mimeType');
2774 $hArr = array(
2775 $this->jumpurl,
2776 $locationData,
2777 $mimeType
2778 );
2779 $calcJuHash = GeneralUtility::hmac(serialize($hArr));
2780 $juHash = (string)GeneralUtility::_GP('juHash');
2781 if ($juHash === $calcJuHash) {
2782 if ($this->locDataCheck($locationData)) {
2783 // 211002 - goes with cObj->filelink() rawurlencode() of filenames so spaces can be allowed.
2784 $this->jumpurl = rawurldecode($this->jumpurl);
2785 // Deny access to files that match TYPO3_CONF_VARS[SYS][fileDenyPattern] and whose parent directory is typo3conf/ (there could be a backup file in typo3conf/ which does not match against the fileDenyPattern)
2786 $absoluteFileName = GeneralUtility::getFileAbsFileName(GeneralUtility::resolveBackPath($this->jumpurl), FALSE);
2787 if (GeneralUtility::isAllowedAbsPath($absoluteFileName) && GeneralUtility::verifyFilenameAgainstDenyPattern($absoluteFileName) && !GeneralUtility::isFirstPartOfStr($absoluteFileName, (PATH_site . 'typo3conf'))) {
2788 if (@is_file($absoluteFileName)) {
2789 $mimeType = $mimeType ?: 'application/octet-stream';
2790 header('Cache-Control: must-revalidate, post-check=0, pre-check=0');
2791 header('Content-Type: ' . $mimeType);
2792 header('Content-Disposition: attachment; filename="' . basename($absoluteFileName) . '"');
2793 header('Content-Length: ' . filesize($absoluteFileName));
2794 GeneralUtility::flushOutputBuffers();
2795 readfile($absoluteFileName);
2796 die;
2797 } else {
2798 throw new \Exception('jumpurl Secure: "' . $this->jumpurl . '" was not a valid file!', 1294585193);
2799 }
2800 } else {
2801 throw new \Exception('jumpurl Secure: The requested file was not allowed to be accessed through jumpUrl (path or file not allowed)!', 1294585194);
2802 }
2803 } else {
2804 throw new \Exception('jumpurl Secure: locationData, ' . $locationData . ', was not accessible.', 1294585195);
2805 }
2806 } else {
2807 throw new \Exception('jumpurl Secure: Calculated juHash did not match the submitted juHash.', 1294585196);
2808 }
2809 } else {
2810 $allowRedirect = FALSE;
2811 if (GeneralUtility::hmac($this->jumpurl, 'jumpurl') === (string)GeneralUtility::_GP('juHash')) {
2812 $allowRedirect = TRUE;
2813 } elseif (is_array($this->TYPO3_CONF_VARS['SC_OPTIONS']['tslib/class.tslib_fe.php']['jumpurlRedirectHandler'])) {
2814 foreach ($this->TYPO3_CONF_VARS['SC_OPTIONS']['tslib/class.tslib_fe.php']['jumpurlRedirectHandler'] as $classReference) {
2815 $hookObject = GeneralUtility::getUserObj($classReference);
2816 $allowRedirectFromHook = FALSE;
2817