[TASK] Simplify frontend page generation code
[Packages/TYPO3.CMS.git] / typo3 / sysext / frontend / Classes / Http / RequestHandler.php
1 <?php
2 namespace TYPO3\CMS\Frontend\Http;
3
4 /*
5 * This file is part of the TYPO3 CMS project.
6 *
7 * It is free software; you can redistribute it and/or modify it under
8 * the terms of the GNU General Public License, either version 2
9 * of the License, or any later version.
10 *
11 * For the full copyright and license information, please read the
12 * LICENSE.txt file that was distributed with this source code.
13 *
14 * The TYPO3 project - inspiring people to share!
15 */
16
17 use TYPO3\CMS\Backend\FrontendBackendUserAuthentication;
18 use TYPO3\CMS\Core\Core\Bootstrap;
19 use TYPO3\CMS\Core\FrontendEditing\FrontendEditingController;
20 use TYPO3\CMS\Core\Http\RequestHandlerInterface;
21 use TYPO3\CMS\Core\TimeTracker\TimeTracker;
22 use TYPO3\CMS\Core\Utility\GeneralUtility;
23 use TYPO3\CMS\Core\Utility\MathUtility;
24 use TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController;
25 use TYPO3\CMS\Frontend\Page\PageGenerator;
26 use TYPO3\CMS\Frontend\Utility\CompressionUtility;
27 use TYPO3\CMS\Frontend\View\AdminPanelView;
28
29 /**
30 * This is the main entry point of the TypoScript driven standard front-end
31 *
32 * Basically put, this is the script which all requests for TYPO3 delivered pages goes to in the
33 * frontend (the website). The script instantiates a $TSFE object, includes libraries and does a little logic here
34 * and there in order to instantiate the right classes to create the webpage.
35 * Previously, this was called index_ts.php and also included the logic for the lightweight "eID" concept,
36 * which is now handled in a separate request handler (EidRequestHandler).
37 */
38 class RequestHandler implements RequestHandlerInterface
39 {
40 /**
41 * Instance of the current TYPO3 bootstrap
42 * @var Bootstrap
43 */
44 protected $bootstrap;
45
46 /**
47 * Instance of the timetracker
48 * @var TimeTracker
49 */
50 protected $timeTracker;
51
52 /**
53 * Instance of the TSFE object
54 * @var TypoScriptFrontendController
55 */
56 protected $controller;
57
58 /**
59 * The request handed over
60 * @var \Psr\Http\Message\ServerRequestInterface
61 */
62 protected $request;
63
64 /**
65 * Constructor handing over the bootstrap and the original request
66 *
67 * @param Bootstrap $bootstrap
68 */
69 public function __construct(Bootstrap $bootstrap)
70 {
71 $this->bootstrap = $bootstrap;
72 }
73
74 /**
75 * Handles a frontend request
76 *
77 * @param \Psr\Http\Message\ServerRequestInterface $request
78 * @return \Psr\Http\Message\ResponseInterface|null
79 */
80 public function handleRequest(\Psr\Http\Message\ServerRequestInterface $request)
81 {
82 $response = null;
83 $this->request = $request;
84 $this->initializeTimeTracker();
85
86 // Hook to preprocess the current request:
87 if (is_array($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['tslib/index_ts.php']['preprocessRequest'])) {
88 foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['tslib/index_ts.php']['preprocessRequest'] as $hookFunction) {
89 $hookParameters = [];
90 GeneralUtility::callUserFunction($hookFunction, $hookParameters, $hookParameters);
91 }
92 unset($hookFunction);
93 unset($hookParameters);
94 }
95
96 $this->initializeController();
97
98 if ($GLOBALS['TYPO3_CONF_VARS']['FE']['pageUnavailable_force']
99 && !GeneralUtility::cmpIP(
100 GeneralUtility::getIndpEnv('REMOTE_ADDR'),
101 $GLOBALS['TYPO3_CONF_VARS']['SYS']['devIPmask']
102 )
103 ) {
104 $this->controller->pageUnavailableAndExit('This page is temporarily unavailable.');
105 }
106
107 $this->controller->connectToDB();
108 $this->controller->sendRedirect();
109
110 // Output compression
111 // Remove any output produced until now
112 $this->bootstrap->endOutputBufferingAndCleanPreviousOutput();
113 $this->initializeOutputCompression();
114
115 $this->bootstrap->loadBaseTca();
116
117 // Initializing the Frontend User
118 $this->timeTracker->push('Front End user initialized', '');
119 $this->controller->initFEuser();
120 $this->timeTracker->pull();
121
122 // Initializing a possible logged-in Backend User
123 /** @var $GLOBALS['BE_USER'] \TYPO3\CMS\Backend\FrontendBackendUserAuthentication */
124 $GLOBALS['BE_USER'] = $this->controller->initializeBackendUser();
125
126 // Process the ID, type and other parameters.
127 // After this point we have an array, $page in TSFE, which is the page-record
128 // of the current page, $id.
129 $this->timeTracker->push('Process ID', '');
130 // Initialize admin panel since simulation settings are required here:
131 if ($this->controller->isBackendUserLoggedIn()) {
132 $GLOBALS['BE_USER']->initializeAdminPanel();
133 $this->bootstrap
134 ->initializeBackendRouter()
135 ->loadExtTables();
136 }
137 $this->controller->checkAlternativeIdMethods();
138 $this->controller->clear_preview();
139 $this->controller->determineId();
140
141 // Now, if there is a backend user logged in and he has NO access to this page,
142 // then re-evaluate the id shown! _GP('ADMCMD_noBeUser') is placed here because
143 // \TYPO3\CMS\Version\Hook\PreviewHook might need to know if a backend user is logged in.
144 if (
145 $this->controller->isBackendUserLoggedIn()
146 && (!$GLOBALS['BE_USER']->extPageReadAccess($this->controller->page) || GeneralUtility::_GP('ADMCMD_noBeUser'))
147 ) {
148 // Remove user
149 unset($GLOBALS['BE_USER']);
150 $this->controller->beUserLogin = false;
151 // Re-evaluate the page-id.
152 $this->controller->checkAlternativeIdMethods();
153 $this->controller->clear_preview();
154 $this->controller->determineId();
155 }
156
157 $this->controller->makeCacheHash();
158 $this->timeTracker->pull();
159
160 // Admin Panel & Frontend editing
161 if ($this->controller->isBackendUserLoggedIn()) {
162 $GLOBALS['BE_USER']->initializeFrontendEdit();
163 if ($GLOBALS['BE_USER']->adminPanel instanceof AdminPanelView) {
164 $this->bootstrap->initializeLanguageObject();
165 }
166 if ($GLOBALS['BE_USER']->frontendEdit instanceof FrontendEditingController) {
167 $GLOBALS['BE_USER']->frontendEdit->initConfigOptions();
168 }
169 }
170
171 // Starts the template
172 $this->timeTracker->push('Start Template', '');
173 $this->controller->initTemplate();
174 $this->timeTracker->pull();
175 // Get from cache
176 $this->timeTracker->push('Get Page from cache', '');
177 // Locks may be acquired here
178 $this->controller->getFromCache();
179 $this->timeTracker->pull();
180 // Get config if not already gotten
181 // After this, we should have a valid config-array ready
182 $this->controller->getConfigArray();
183 // Setting language and locale
184 $this->timeTracker->push('Setting language and locale', '');
185 $this->controller->settingLanguage();
186 $this->controller->settingLocale();
187 $this->timeTracker->pull();
188
189 // Convert POST data to utf-8 for internal processing if metaCharset is different
190 $this->controller->convPOSTCharset();
191
192 $this->controller->initializeRedirectUrlHandlers();
193
194 $this->controller->handleDataSubmission();
195
196 // Check for shortcut page and redirect
197 $this->controller->checkPageForShortcutRedirect();
198 $this->controller->checkPageForMountpointRedirect();
199
200 // Generate page
201 $this->controller->setUrlIdToken();
202 if ($this->controller->isGeneratePage()) {
203 $this->timeTracker->push('Page generation');
204 $this->controller->generatePage_preProcessing();
205 $temp_theScript = $this->controller->generatePage_whichScript();
206 if ($temp_theScript) {
207 include $temp_theScript;
208 } else {
209 $this->controller->preparePageContentGeneration();
210 // Content generation
211 PageGenerator::renderContent();
212 $this->controller->setAbsRefPrefix();
213 }
214 $this->controller->generatePage_postProcessing();
215 $this->timeTracker->pull();
216 }
217 $this->controller->releaseLocks();
218
219 // Render non-cached page parts by replacing placeholders which are taken from cache or added during page generation
220 if ($this->controller->isINTincScript()) {
221 if (!$this->controller->isGeneratePage()) {
222 // When page was generated, this was already called. Avoid calling this twice.
223 $this->controller->preparePageContentGeneration();
224 }
225 $this->timeTracker->push('Non-cached objects');
226 $this->controller->INTincScript();
227 $this->timeTracker->pull();
228 }
229
230 // Output content
231 $sendTSFEContent = false;
232 if ($this->controller->isOutputting()) {
233 $this->timeTracker->push('Print Content', '');
234 $this->controller->processOutput();
235 $sendTSFEContent = true;
236 $this->timeTracker->pull();
237 }
238 // Store session data for fe_users
239 $this->controller->storeSessionData();
240 // Statistics
241 $GLOBALS['TYPO3_MISC']['microtime_end'] = microtime(true);
242 if ($this->controller->isOutputting()) {
243 if (isset($this->controller->config['config']['debug'])) {
244 $debugParseTime = (bool)$this->controller->config['config']['debug'];
245 } else {
246 $debugParseTime = !empty($GLOBALS['TYPO3_CONF_VARS']['FE']['debug']);
247 }
248 if ($debugParseTime) {
249 $this->controller->content .= LF . '<!-- Parsetime: ' . $this->timeTracker->getParseTime() . 'ms -->';
250 }
251 }
252 $this->controller->redirectToExternalUrl();
253 // Preview info
254 $this->controller->previewInfo();
255 // Hook for end-of-frontend
256 $this->controller->hook_eofe();
257 // Finish timetracking
258 $this->timeTracker->pull();
259
260 // Admin panel
261 if ($this->controller->isBackendUserLoggedIn() && $GLOBALS['BE_USER'] instanceof FrontendBackendUserAuthentication) {
262 if ($GLOBALS['BE_USER']->isAdminPanelVisible()) {
263 $this->controller->content = str_ireplace('</body>', $GLOBALS['BE_USER']->displayAdminPanel() . '</body>', $this->controller->content);
264 }
265 }
266
267 if ($sendTSFEContent) {
268 /** @var \TYPO3\CMS\Core\Http\Response $response */
269 $response = GeneralUtility::makeInstance(\TYPO3\CMS\Core\Http\Response::class);
270 // Send content-length header.
271 // Notice that all HTML content outside the length of the content-length header will be cut off!
272 // Therefore content of unknown length from included PHP-scripts and if admin users are logged
273 // in (admin panel might show...) or if debug mode is turned on, we disable it!
274 if (
275 (!isset($this->controller->config['config']['enableContentLengthHeader']) || $this->controller->config['config']['enableContentLengthHeader'])
276 && !$this->controller->beUserLogin && !$GLOBALS['TYPO3_CONF_VARS']['FE']['debug']
277 && !$this->controller->config['config']['debug'] && !$this->controller->doWorkspacePreview()
278 ) {
279 header('Content-Length: ' . strlen($this->controller->content));
280 }
281 $response->getBody()->write($this->controller->content);
282 }
283 // Debugging Output
284 if (isset($GLOBALS['error']) && is_object($GLOBALS['error']) && @is_callable([$GLOBALS['error'], 'debugOutput'])) {
285 $GLOBALS['error']->debugOutput();
286 }
287 GeneralUtility::devLog('END of FRONTEND session', 'cms', 0, ['_FLUSH' => true]);
288 return $response;
289 }
290
291 /**
292 * This request handler can handle any frontend request.
293 *
294 * @param \Psr\Http\Message\ServerRequestInterface $request
295 * @return bool If the request is not an eID request, TRUE otherwise FALSE
296 */
297 public function canHandleRequest(\Psr\Http\Message\ServerRequestInterface $request)
298 {
299 return $request->getQueryParams()['eID'] || $request->getParsedBody()['eID'] ? false : true;
300 }
301
302 /**
303 * Returns the priority - how eager the handler is to actually handle the
304 * request.
305 *
306 * @return int The priority of the request handler.
307 */
308 public function getPriority()
309 {
310 return 50;
311 }
312
313 /**
314 * Initializes output compression when enabled, could be split up and put into Bootstrap
315 * at a later point
316 */
317 protected function initializeOutputCompression()
318 {
319 if ($GLOBALS['TYPO3_CONF_VARS']['FE']['compressionLevel'] && extension_loaded('zlib')) {
320 if (MathUtility::canBeInterpretedAsInteger($GLOBALS['TYPO3_CONF_VARS']['FE']['compressionLevel'])) {
321 @ini_set('zlib.output_compression_level', $GLOBALS['TYPO3_CONF_VARS']['FE']['compressionLevel']);
322 }
323 ob_start([GeneralUtility::makeInstance(CompressionUtility::class), 'compressionOutputHandler']);
324 }
325 }
326
327 /**
328 * Timetracking started depending if a Backend User is logged in
329 */
330 protected function initializeTimeTracker()
331 {
332 $configuredCookieName = trim($GLOBALS['TYPO3_CONF_VARS']['BE']['cookieName']) ?: 'be_typo_user';
333
334 /** @var TimeTracker timeTracker */
335 $this->timeTracker = GeneralUtility::makeInstance(TimeTracker::class, ($this->request->getCookieParams()[$configuredCookieName] ? true : false));
336 $this->timeTracker->start();
337 }
338
339 /**
340 * Creates an instance of TSFE and sets it as a global variable
341 */
342 protected function initializeController()
343 {
344 $this->controller = GeneralUtility::makeInstance(
345 TypoScriptFrontendController::class,
346 null,
347 GeneralUtility::_GP('id'),
348 GeneralUtility::_GP('type'),
349 GeneralUtility::_GP('no_cache'),
350 GeneralUtility::_GP('cHash'),
351 null,
352 GeneralUtility::_GP('MP'),
353 GeneralUtility::_GP('RDCT')
354 );
355 // setting the global variable for the controller
356 // We have to define this as reference here, because there is code around
357 // which exchanges the TSFE object in the global variable. The reference ensures
358 // that the $controller member always works on the same object as the global variable.
359 // This is a dirty workaround and bypasses the protected access modifier of the controller member.
360 $GLOBALS['TSFE'] = &$this->controller;
361 }
362 }