-
-
Notifications
You must be signed in to change notification settings - Fork 159
/
Frontend.php
672 lines (557 loc) · 17.7 KB
/
Frontend.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
<?php
/*
* This file is part of Contao.
*
* (c) Leo Feyer
*
* @license LGPL-3.0-or-later
*/
namespace Contao;
use Contao\CoreBundle\Exception\LegacyRoutingException;
use Contao\CoreBundle\Exception\NoRootPageFoundException;
use Contao\CoreBundle\Framework\ContaoFramework;
use Contao\CoreBundle\Routing\Page\PageRoute;
use Contao\CoreBundle\Search\Document;
use Contao\CoreBundle\Util\LocaleUtil;
use Symfony\Cmf\Component\Routing\RouteObjectInterface;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Routing\Exception\ExceptionInterface as RoutingExceptionInterface;
use Symfony\Component\Routing\Exception\MissingMandatoryParametersException;
/**
* Provide methods to manage front end controllers.
*/
abstract class Frontend extends Controller
{
/**
* Meta array
* @var array
*/
protected $arrMeta = array();
/**
* Aux array
* @var array
*/
protected $arrAux = array();
/**
* Processed files array
* @var array
*/
protected $arrProcessed = array();
/**
* Load the database object
*
* Make the constructor public, so pages can be instantiated (see #6182)
*/
public function __construct()
{
parent::__construct();
$this->import(Database::class, 'Database');
}
/**
* Split the current request into fragments, strip the URL suffix, recreate the $_GET array and return the page ID
*
* @return mixed
*
* @deprecated Deprecated since Contao 4.7, to be removed in Contao 5.0.
* Use the Symfony routing instead.
*/
public static function getPageIdFromUrl()
{
trigger_deprecation('contao/core-bundle', '4.7', 'Using "Contao\Frontend::getPageIdFromUrl()" has been deprecated and will no longer work in Contao 5.0. Use the Symfony routing instead.');
if (!System::getContainer()->getParameter('contao.legacy_routing'))
{
throw new LegacyRoutingException('Frontend::getPageIdFromUrl() requires legacy routing. Configure "prepend_locale" or "url_suffix" in your app configuration (e.g. config.yml).');
}
$strRequest = Environment::get('relativeRequest');
if (!$strRequest)
{
return null;
}
// Get the request without the query string
list($strRequest) = explode('?', $strRequest, 2);
// URL decode here (see #6232)
$strRequest = rawurldecode($strRequest);
// The request string must not contain "auto_item" (see #4012)
if (strpos($strRequest, '/auto_item/') !== false)
{
return false;
}
// Extract the language
if (Config::get('addLanguageToUrl'))
{
$arrMatches = array();
// Use the matches instead of substr() (thanks to Mario Müller)
if (preg_match('@^([a-z]{2}(-[A-Z]{2})?)/(.*)$@', $strRequest, $arrMatches))
{
Input::setGet('language', $arrMatches[1]);
// Trigger the root page if only the language was given
if (!$arrMatches[3])
{
return null;
}
$strRequest = $arrMatches[3];
}
else
{
return false; // Language not provided
}
}
// Remove the URL suffix if not just a language root (e.g. en/) is requested
if ($strRequest && (!Config::get('addLanguageToUrl') || !preg_match('@^[a-z]{2}(-[A-Z]{2})?/$@', $strRequest)))
{
$intSuffixLength = \strlen(Config::get('urlSuffix'));
// Return false if the URL suffix does not match (see #2864)
if ($intSuffixLength > 0)
{
if (substr($strRequest, -$intSuffixLength) != Config::get('urlSuffix'))
{
return false;
}
$strRequest = substr($strRequest, 0, -$intSuffixLength);
}
}
$arrFragments = null;
// Use folder-style URLs
if (strpos($strRequest, '/') !== false)
{
$strAlias = $strRequest;
$arrOptions = array($strAlias);
// Compile all possible aliases by applying dirname() to the request (e.g. news/archive/item, news/archive, news)
while ($strAlias != '/' && strpos($strAlias, '/') !== false)
{
$strAlias = \dirname($strAlias);
$arrOptions[] = $strAlias;
}
/** @var ContaoFramework $framework */
$framework = System::getContainer()->get('contao.framework');
$objPageModel = $framework->getAdapter(PageModel::class);
// Check if there are pages with a matching alias
$objPages = $objPageModel->findByAliases($arrOptions);
if ($objPages !== null)
{
$arrPages = array();
// Order by domain and language
while ($objPages->next())
{
/** @var PageModel $objModel */
$objModel = $objPages->current();
$objPage = $objModel->loadDetails();
$domain = $objPage->domain ?: '*';
$arrPages[$domain][$objPage->rootLanguage][] = $objPage;
// Also store the fallback language
if ($objPage->rootIsFallback)
{
$arrPages[$domain]['*'][] = $objPage;
}
}
$arrAliases = array();
$strHost = Environment::get('host');
// Look for a root page whose domain name matches the host name
$arrLangs = $arrPages[$strHost] ?? $arrPages['*'] ?? array();
// Use the first result (see #4872)
if (!Config::get('addLanguageToUrl'))
{
$arrAliases = current($arrLangs);
}
// Try to find a page matching the language parameter
elseif (($lang = Input::get('language')) && isset($arrLangs[$lang]))
{
$arrAliases = $arrLangs[$lang];
}
// Return if there are no matches
if (empty($arrAliases))
{
return false;
}
$objPage = $arrAliases[0];
// The request consists of the alias only
if ($strRequest == $objPage->alias)
{
$arrFragments = array($strRequest);
}
// Remove the alias from the request string, explode it and then re-insert the alias at the beginning
else
{
$arrFragments = explode('/', substr($strRequest, \strlen($objPage->alias) + 1));
array_unshift($arrFragments, $objPage->alias);
}
}
}
// If folderUrl is deactivated or did not find a matching page
if ($arrFragments === null)
{
if ($strRequest == '/')
{
return false;
}
$arrFragments = explode('/', $strRequest);
}
// Add the second fragment as auto_item if the number of fragments is even
if (\count($arrFragments) % 2 == 0)
{
if (!Config::get('useAutoItem'))
{
return false; // see #264
}
ArrayUtil::arrayInsert($arrFragments, 1, array('auto_item'));
}
// HOOK: add custom logic
if (isset($GLOBALS['TL_HOOKS']['getPageIdFromUrl']) && \is_array($GLOBALS['TL_HOOKS']['getPageIdFromUrl']))
{
foreach ($GLOBALS['TL_HOOKS']['getPageIdFromUrl'] as $callback)
{
$arrFragments = static::importStatic($callback[0])->{$callback[1]}($arrFragments);
}
}
// Return if the alias is empty (see #4702 and #4972)
if (!$arrFragments[0] && \count($arrFragments) > 1)
{
return false;
}
// Add the fragments to the $_GET array
for ($i=1, $c=\count($arrFragments); $i<$c; $i+=2)
{
// Return false if the key is empty (see #4702 and #263)
if (!$arrFragments[$i])
{
return false;
}
// Return false if there is a duplicate parameter (duplicate content) (see #4277)
if (isset($_GET[$arrFragments[$i]]))
{
return false;
}
// Return false if the request contains an auto_item keyword (duplicate content) (see #4012)
if (Config::get('useAutoItem') && \in_array($arrFragments[$i], $GLOBALS['TL_AUTO_ITEM']))
{
return false;
}
Input::setGet($arrFragments[$i], $arrFragments[$i+1], true);
}
return $arrFragments[0] ?: null;
}
/**
* Return the root page ID
*
* @return integer
*
* @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
* Use Frontend::getRootPageFromUrl()->id instead.
*/
public static function getRootIdFromUrl()
{
trigger_deprecation('contao/core-bundle', '4.0', 'Using "Contao\Frontend::getRootIdFromUrl()" has been deprecated and will no longer work in Contao 5.0. Use "Contao\Frontend::getRootPageFromUrl()->id" instead.');
return static::getRootPageFromUrl()->id;
}
/**
* Try to find a root page based on language and URL
*
* @return PageModel
*/
public static function getRootPageFromUrl()
{
if (!System::getContainer()->getParameter('contao.legacy_routing'))
{
$objRequest = System::getContainer()->get('request_stack')->getCurrentRequest();
if ($objRequest instanceof Request)
{
$objPage = $objRequest->attributes->get('pageModel');
if ($objPage instanceof PageModel)
{
$objPage->loadDetails();
return PageModel::findByPk($objPage->rootId);
}
}
throw new NoRootPageFoundException('No root page found');
}
$accept_language = Environment::get('httpAcceptLanguage');
$blnAddLanguageToUrl = System::getContainer()->getParameter('contao.prepend_locale');
// Get the language from the URL if it is not set (see #456)
if (!isset($_GET['language']) && $blnAddLanguageToUrl)
{
$arrMatches = array();
// Get the request without the query string
list($strRequest) = explode('?', Environment::get('relativeRequest'), 2);
if (preg_match('@^([a-z]{2}(-[A-Z]{2})?)/@', $strRequest, $arrMatches))
{
Input::setGet('language', $arrMatches[1]);
}
}
// The language is set in the URL
if (!empty($_GET['language']) && $blnAddLanguageToUrl)
{
$strUri = Environment::get('url') . '/' . Input::get('language') . '/';
}
// No language given
else
{
$strUri = Environment::get('url') . '/';
}
$objRequest = Request::create($strUri);
$objRequest->headers->set('Accept-Language', $accept_language);
try
{
$arrParameters = System::getContainer()->get('contao.routing.nested_matcher')->matchRequest($objRequest);
}
catch (RoutingExceptionInterface $exception)
{
try
{
$arrParameters = System::getContainer()->get('contao.routing.nested_404_matcher')->matchRequest($objRequest);
}
catch (RoutingExceptionInterface $exception)
{
throw new NoRootPageFoundException('No root page found', 0, $exception);
}
}
$objRootPage = $arrParameters['pageModel'] ?? null;
if (!$objRootPage instanceof PageModel)
{
throw new MissingMandatoryParametersException('Every Contao route must have a "pageModel" parameter');
}
// Redirect to the website root or language root (e.g. en/)
if (!Environment::get('relativeRequest'))
{
if ($blnAddLanguageToUrl)
{
$arrParams = array('_locale' => LocaleUtil::formatAsLocale($objRootPage->language));
$strUrl = System::getContainer()->get('router')->generate('contao_index', $arrParams);
$strUrl = substr($strUrl, \strlen(Environment::get('path')) + 1);
static::redirect($strUrl);
}
// Redirect if the page alias is not "index" or "/" (see #8498, #8560 and #1210)
elseif ($objRootPage->type !== 'root' && !\in_array($objRootPage->alias, array('index', '/')))
{
static::redirect($objRootPage->getAbsoluteUrl());
}
}
if ($objRootPage->type != 'root')
{
return PageModel::findByPk($objRootPage->rootId);
}
return $objRootPage;
}
/**
* Overwrite the parent method as front end URLs are handled differently
*
* @param string $strRequest
* @param boolean $blnIgnoreParams
* @param array $arrUnset
*
* @return string
*/
public static function addToUrl($strRequest, $blnIgnoreParams=false, $arrUnset=array())
{
/** @var PageModel $objPage */
global $objPage;
$arrGet = $blnIgnoreParams ? array() : $_GET;
// Clean the $_GET values (thanks to thyon)
foreach (array_keys($arrGet) as $key)
{
$arrGet[$key] = Input::get($key, true, true);
}
$arrFragments = preg_split('/&(amp;)?/i', $strRequest);
// Merge the new request string
foreach ($arrFragments as $strFragment)
{
list($key, $value) = explode('=', $strFragment) + array(null, null);
if (!$value)
{
unset($arrGet[$key]);
}
else
{
$arrGet[$key] = $value;
}
}
// Unset the language parameter
if ($objPage->urlPrefix)
{
unset($arrGet['language']);
}
$strParams = '';
$strConnector = '/';
$strSeparator = '/';
// Compile the parameters string
foreach ($arrGet as $k=>$v)
{
// Omit the key if it is an auto_item key (see #5037)
if ($objPage->useAutoItem && ($k == 'auto_item' || \in_array($k, $GLOBALS['TL_AUTO_ITEM'])))
{
$strParams = $strConnector . urlencode($v) . $strParams;
}
else
{
$strParams .= $strConnector . urlencode($k) . $strSeparator . urlencode($v);
}
}
$strUrl = System::getContainer()->get('router')->generate(PageRoute::PAGE_BASED_ROUTE_NAME, array(RouteObjectInterface::CONTENT_OBJECT => $objPage, 'parameters' => $strParams));
$strUrl = substr($strUrl, \strlen(Environment::get('path')) + 1);
return $strUrl;
}
/**
* Redirect to a jumpTo page or reload the current page
*
* @param integer|array $intId
* @param string $strParams
* @param string $strForceLang
*/
protected function jumpToOrReload($intId, $strParams=null, $strForceLang=null)
{
if ($strForceLang !== null)
{
trigger_deprecation('contao/core-bundle', '4.0', 'Using "Contao\Frontend::jumpToOrReload()" with $strForceLang has been deprecated and will no longer work in Contao 5.0.');
}
/** @var PageModel $objPage */
global $objPage;
// Always redirect if there are additional arguments (see #5734)
$blnForceRedirect = ($strParams !== null || $strForceLang !== null);
if (\is_array($intId))
{
$intId = $intId['id'] ?? 0;
}
if ($intId > 0 && ($intId != $objPage->id || $blnForceRedirect) && ($objNextPage = PageModel::findPublishedById($intId)) !== null)
{
if (!$strForceLang)
{
$this->redirect($objNextPage->getAbsoluteUrl($strParams));
}
else
{
$this->redirect($objNextPage->getFrontendUrl($strParams, $strForceLang));
}
}
$this->reload();
}
/**
* Check whether a back end or front end user is logged in
*
* @param string $strCookie
*
* @return boolean
*
* @deprecated Deprecated since Contao 4.5, to be removed in Contao 5.0.
* Use Symfony security instead.
*/
protected function getLoginStatus($strCookie)
{
trigger_deprecation('contao/core-bundle', '4.5', 'Using "Contao\Frontend::getLoginStatus()" has been deprecated and will no longer work in Contao 5.0. Use Symfony security instead.');
$objTokenChecker = System::getContainer()->get('contao.security.token_checker');
if ($strCookie == 'BE_USER_AUTH' && $objTokenChecker->hasBackendUser())
{
// Always return false if we are not in preview mode (show hidden elements)
if (TL_MODE == 'FE' && !$objTokenChecker->isPreviewMode())
{
return false;
}
return true;
}
if ($strCookie == 'FE_USER_AUTH' && $objTokenChecker->hasFrontendUser())
{
return true;
}
return false;
}
/**
* Get the metadata from a serialized string
*
* @param string $strData
* @param string $strLanguage
*
* @return array
*/
public static function getMetaData($strData, $strLanguage)
{
if (empty($strLanguage))
{
return array();
}
$arrData = StringUtil::deserialize($strData);
// Convert the language to a locale (see #5678)
$strLanguage = LocaleUtil::formatAsLocale($strLanguage);
if (!\is_array($arrData) || !isset($arrData[$strLanguage]))
{
return array();
}
return $arrData[$strLanguage];
}
/**
* Prepare a text to be used in the meta description tag
*
* @param string $strText
*
* @return string
*
* @deprecated Deprecated since Contao 4.12, to be removed in Contao 5.0;
* use the Contao\CoreBundle\String\HtmlDecoder service instead
*/
protected function prepareMetaDescription($strText)
{
trigger_deprecation('contao/core-bundle', '4.12', 'Using "Contao\Frontend::prepareMetaDescription()" has been deprecated and will no longer work Contao 5.0. Use the "Contao\CoreBundle\String\HtmlDecoder" service instead.');
$strText = System::getContainer()->get('contao.insert_tag.parser')->replaceInline((string) $strText);
$strText = strip_tags($strText);
$strText = str_replace("\n", ' ', $strText);
$strText = StringUtil::substr($strText, 320);
return trim($strText);
}
/**
* Return the cron timeout in seconds
*
* @return integer
*
* @deprecated Deprecated since Contao 4.9, to be removed in Contao 5.0.
*/
public static function getCronTimeout()
{
trigger_deprecation('contao/core-bundle', '4.9', 'Calling "%s()" has been deprecated and will no longer work in Contao 5.0.', __METHOD__);
if (!empty($GLOBALS['TL_CRON']['minutely']))
{
return 60;
}
if (!empty($GLOBALS['TL_CRON']['hourly']))
{
return 3600;
}
return 86400; // daily
}
/**
* Index a page if applicable
*
* @param Response $response
*
* @deprecated Deprecated since Contao 4.9, to be removed in Contao 5.0.
* Use the "contao.search.indexer" service instead.
*/
public static function indexPageIfApplicable(Response $response)
{
trigger_deprecation('contao/core-bundle', '4.9', 'Using "Contao\Frontend::indexPageIfApplicable()" has been deprecated and will no longer work in Contao 5.0. Use the "contao.search.indexer" service instead.');
$searchIndexer = System::getContainer()->get('contao.search.indexer');
// The search indexer is disabled
if ($searchIndexer === null)
{
return;
}
$request = System::getContainer()->get('request_stack')->getCurrentRequest();
if ($request === null)
{
throw new \RuntimeException('The request stack did not contain a request');
}
$document = Document::createFromRequestResponse($request, $response);
$searchIndexer->index($document);
}
/**
* Check whether there is a cached version of the page and return a response object
*
* @return Response|null
*
* @deprecated Deprecated since Contao 4.3, to be removed in Contao 5.0.
* Use proper response caching headers instead.
*/
public static function getResponseFromCache()
{
trigger_deprecation('contao/core-bundle', '4.3', 'Using "Contao\Frontend::getResponseFromCache()" has been deprecated and will no longer work in Contao 5.0. Use proper response caching headers instead.');
return null;
}
}
class_alias(Frontend::class, 'Frontend');