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