[CLEANUP] The correct case must be used for standard PHP types in phpdoc
[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 null|\Psr\Http\Message\ResponseInterface
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 $this->controller->getFromCache();
178 $this->timeTracker->pull();
179 // Get config if not already gotten
180 // After this, we should have a valid config-array ready
181 $this->controller->getConfigArray();
182 // Setting language and locale
183 $this->timeTracker->push('Setting language and locale', '');
184 $this->controller->settingLanguage();
185 $this->controller->settingLocale();
186 $this->timeTracker->pull();
187
188 // Convert POST data to utf-8 for internal processing if metaCharset is different
189 $this->controller->convPOSTCharset();
190
191 $this->controller->initializeRedirectUrlHandlers();
192
193 $this->controller->handleDataSubmission();
194
195 // Check for shortcut page and redirect
196 $this->controller->checkPageForShortcutRedirect();
197 $this->controller->checkPageForMountpointRedirect();
198
199 // Generate page
200 $this->controller->setUrlIdToken();
201 $this->timeTracker->push('Page generation', '');
202 if ($this->controller->isGeneratePage()) {
203 $this->controller->generatePage_preProcessing();
204 $temp_theScript = $this->controller->generatePage_whichScript();
205 if ($temp_theScript) {
206 include $temp_theScript;
207 } else {
208 $this->controller->preparePageContentGeneration();
209 // Content generation
210 if (!$this->controller->isINTincScript()) {
211 PageGenerator::renderContent();
212 $this->controller->setAbsRefPrefix();
213 }
214 }
215 $this->controller->generatePage_postProcessing();
216 } elseif ($this->controller->isINTincScript()) {
217 $this->controller->preparePageContentGeneration();
218 }
219 $this->controller->releaseLocks();
220 $this->timeTracker->pull();
221
222 // Render non-cached parts
223 if ($this->controller->isINTincScript()) {
224 $this->timeTracker->push('Non-cached objects', '');
225 $this->controller->INTincScript();
226 $this->timeTracker->pull();
227 }
228
229 // Output content
230 $sendTSFEContent = false;
231 if ($this->controller->isOutputting()) {
232 $this->timeTracker->push('Print Content', '');
233 $this->controller->processOutput();
234 $sendTSFEContent = true;
235 $this->timeTracker->pull();
236 }
237 // Store session data for fe_users
238 $this->controller->storeSessionData();
239 // Statistics
240 $GLOBALS['TYPO3_MISC']['microtime_end'] = microtime(true);
241 if ($this->controller->isOutputting()) {
242 if (isset($this->controller->config['config']['debug'])) {
243 $debugParseTime = (bool)$this->controller->config['config']['debug'];
244 } else {
245 $debugParseTime = !empty($GLOBALS['TYPO3_CONF_VARS']['FE']['debug']);
246 }
247 if ($debugParseTime) {
248 $this->controller->content .= LF . '<!-- Parsetime: ' . $this->timeTracker->getParseTime() . 'ms -->';
249 }
250 }
251 $this->controller->redirectToExternalUrl();
252 // Preview info
253 $this->controller->previewInfo();
254 // Hook for end-of-frontend
255 $this->controller->hook_eofe();
256 // Finish timetracking
257 $this->timeTracker->pull();
258
259 // Admin panel
260 if ($this->controller->isBackendUserLoggedIn() && $GLOBALS['BE_USER'] instanceof FrontendBackendUserAuthentication) {
261 if ($GLOBALS['BE_USER']->isAdminPanelVisible()) {
262 $this->controller->content = str_ireplace('</body>', $GLOBALS['BE_USER']->displayAdminPanel() . '</body>', $this->controller->content);
263 }
264 }
265
266 if ($sendTSFEContent) {
267 /** @var \TYPO3\CMS\Core\Http\Response $response */
268 $response = GeneralUtility::makeInstance(\TYPO3\CMS\Core\Http\Response::class);
269 // Send content-length header.
270 // Notice that all HTML content outside the length of the content-length header will be cut off!
271 // Therefore content of unknown length from included PHP-scripts and if admin users are logged
272 // in (admin panel might show...) or if debug mode is turned on, we disable it!
273 if (
274 (!isset($this->controller->config['config']['enableContentLengthHeader']) || $this->controller->config['config']['enableContentLengthHeader'])
275 && !$this->controller->beUserLogin && !$GLOBALS['TYPO3_CONF_VARS']['FE']['debug']
276 && !$this->controller->config['config']['debug'] && !$this->controller->doWorkspacePreview()
277 ) {
278 header('Content-Length: ' . strlen($this->controller->content));
279 }
280 $response->getBody()->write($this->controller->content);
281 }
282 // Debugging Output
283 if (isset($GLOBALS['error']) && is_object($GLOBALS['error']) && @is_callable([$GLOBALS['error'], 'debugOutput'])) {
284 $GLOBALS['error']->debugOutput();
285 }
286 GeneralUtility::devLog('END of FRONTEND session', 'cms', 0, ['_FLUSH' => true]);
287 return $response;
288 }
289
290 /**
291 * This request handler can handle any frontend request.
292 *
293 * @param \Psr\Http\Message\ServerRequestInterface $request
294 * @return bool If the request is not an eID request, TRUE otherwise FALSE
295 */
296 public function canHandleRequest(\Psr\Http\Message\ServerRequestInterface $request)
297 {
298 return $request->getQueryParams()['eID'] || $request->getParsedBody()['eID'] ? false : true;
299 }
300
301 /**
302 * Returns the priority - how eager the handler is to actually handle the
303 * request.
304 *
305 * @return int The priority of the request handler.
306 */
307 public function getPriority()
308 {
309 return 50;
310 }
311
312 /**
313 * Initializes output compression when enabled, could be split up and put into Bootstrap
314 * at a later point
315 */
316 protected function initializeOutputCompression()
317 {
318 if ($GLOBALS['TYPO3_CONF_VARS']['FE']['compressionLevel'] && extension_loaded('zlib')) {
319 if (MathUtility::canBeInterpretedAsInteger($GLOBALS['TYPO3_CONF_VARS']['FE']['compressionLevel'])) {
320 @ini_set('zlib.output_compression_level', $GLOBALS['TYPO3_CONF_VARS']['FE']['compressionLevel']);
321 }
322 ob_start([GeneralUtility::makeInstance(CompressionUtility::class), 'compressionOutputHandler']);
323 }
324 }
325
326 /**
327 * Timetracking started depending if a Backend User is logged in
328 */
329 protected function initializeTimeTracker()
330 {
331 $configuredCookieName = trim($GLOBALS['TYPO3_CONF_VARS']['BE']['cookieName']) ?: 'be_typo_user';
332
333 /** @var TimeTracker timeTracker */
334 $this->timeTracker = GeneralUtility::makeInstance(TimeTracker::class, ($this->request->getCookieParams()[$configuredCookieName] ? true : false));
335 $this->timeTracker->start();
336 }
337
338 /**
339 * Creates an instance of TSFE and sets it as a global variable
340 */
341 protected function initializeController()
342 {
343 $this->controller = GeneralUtility::makeInstance(
344 TypoScriptFrontendController::class,
345 null,
346 GeneralUtility::_GP('id'),
347 GeneralUtility::_GP('type'),
348 GeneralUtility::_GP('no_cache'),
349 GeneralUtility::_GP('cHash'),
350 null,
351 GeneralUtility::_GP('MP'),
352 GeneralUtility::_GP('RDCT')
353 );
354 // setting the global variable for the controller
355 // We have to define this as reference here, because there is code around
356 // which exchanges the TSFE object in the global variable. The reference ensures
357 // that the $controller member always works on the same object as the global variable.
358 // This is a dirty workaround and bypasses the protected access modifier of the controller member.
359 $GLOBALS['TSFE'] = &$this->controller;
360 }
361 }