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