Newer
Older
namespace Rlmp\RlmpLanguageDetection;
/**
* This file is part of the TYPO3 CMS project.
* It is free software; you can redistribute it and/or modify it under
* the terms of the GNU General Public License, either version 2
* of the License, or any later version.
* For the full copyright and license information, please read the
* LICENSE.txt file that was distributed with this source code.
* The TYPO3 project - inspiring people to share!
*/
use TYPO3\CMS\Core\Database\DatabaseConnection;
use TYPO3\CMS\Core\Utility\ExtensionManagementUtility;
use TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController;
use TYPO3\CMS\Frontend\Page\PageRepository;
use TYPO3\CMS\Frontend\Plugin\AbstractPlugin;
/**
* Plugin 'Language Detection' for the 'rlmp_language_detection' extension.
*
* @author robert lemke medienprojekte <rl@robertlemke.de>
* @author Mathias Bolt Lesniak, LiliO Design <mathias@lilio.com>
* @author Joachim Mathes, punkt.de GmbH <t3extensions@punkt.de>
* @author Thomas Löffler <loeffler@spooner-web.de>
* @author Markus Klein <klein.t3@reelworx.at>
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
class LanguageDetection extends AbstractPlugin
{
/**
* @var string
*/
public $prefixId = 'tx_rlmplanguagedetection_pi1';
/**
* @var string
*/
public $scriptRelPath = 'pi1/class.tx_rlmplanguagedetection_pi1.php';
/**
* @var string
*/
public $extKey = 'rlmp_language_detection';
/**
* @var array
*/
public $conf = [];
/**
* @var int
*/
protected $cookieLifetime = 0;
/**
* @var string
*/
protected $botPattern = '/bot|crawl|slurp|spider/i';
/**
* The main function recognizes the browser's preferred languages and
* reloads the page accordingly. Exits if successful.
*
* @param string $content HTML content
* @param array $conf The mandatory configuration array
* @return string
*/
public function main(string $content, array $conf):string
{
$this->conf = $conf;
$this->cookieLifetime = (int)$conf['cookieLifetime'];
// Break out if a spider/search engine bot is visiting the website
if ($this->isBot()) {
return $content;
}
// Break out if language already selected
if (!$this->conf['dontBreakIfLanguageIsAlreadySelected']
&& (GeneralUtility::_GP($this->conf['languageGPVar']) !== null || GeneralUtility::_GP($this->conf['languageGPVar']) !== '')) {
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
if (TYPO3_DLOG) {
GeneralUtility::devLog('Break out since language is already selected', $this->extKey);
}
return $content;
}
// Break out if the last page visited was also on our site:
$referrer = (string)GeneralUtility::getIndpEnv('HTTP_REFERER');
if (TYPO3_DLOG) {
GeneralUtility::devLog('Referrer: ' . $referrer, $this->extKey);
}
if (!$this->conf['dontBreakIfLastPageWasOnSite']
&& $referrer !== ''
&& (
stripos($referrer, GeneralUtility::getIndpEnv('TYPO3_SITE_URL')) !== false
|| stripos($referrer, $this->getTSFE()->baseUrl) !== false
|| stripos($referrer . '/', GeneralUtility::getIndpEnv('TYPO3_SITE_URL')) !== false
|| stripos($referrer . '/', $this->getTSFE()->baseUrl) !== false
)
) {
return $content;
}
// Break out if the session tells us that the user has selected language
if (!$this->conf['dontBreakIfLanguageIsAlreadySelected']) {
if ($this->cookieLifetime) {
// read from browser-cookie
$languageSessionKey = $_COOKIE[$this->extKey . '_languageSelected'];
} else {
$languageSessionKey = $this->getTSFE()->fe_user->getKey('ses', $this->extKey . '_languageSelected');
}
// If session key exists but no language GP var -
// we should redirect client to selected language
if (isset($languageSessionKey)) {
// Can redirect only in one tree method for now
if ($this->conf['useOneTreeMethod'] && is_numeric($languageSessionKey)) {
$this->doRedirect((int)$languageSessionKey, $referrer);
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
return '';
}
return $content;
}
}
//Get available languages
$availableLanguagesArr = $this->conf['useOneTreeMethod'] ? $this->getSysLanguages() : $this->getMultipleTreeLanguages();
if (TYPO3_DLOG) {
GeneralUtility::devLog('Detecting available languages in installation', $this->extKey, 0, $availableLanguagesArr);
}
//Collect language aliases
$languageAliases = [];
if ($this->conf['useLanguageAliases']) {
$tmp = $conf['languageAliases.'];
foreach ($tmp as $key => $languageAlias) {
$languageAliases[strtolower($key)] = GeneralUtility::trimExplode(
',',
strtolower($languageAlias),
true
);
}
}
$testOrder = GeneralUtility::trimExplode(
',',
$conf['testOrder'],
true
);
$preferredLanguageOrPageUid = false;
for ($i = 0; $i < count($testOrder) && $preferredLanguageOrPageUid === false; $i++) {
switch ($testOrder[$i]) {
//Browser information
case 'browser':
//Get Accepted Languages from Browser
$acceptedLanguagesArr = $this->getAcceptedLanguages();
if (empty($acceptedLanguagesArr)) {
break;
}
if (TYPO3_DLOG) {
GeneralUtility::devLog('Detecting user browser languages', $this->extKey, 0, $acceptedLanguagesArr);
}
//Break out if the default languange is already selected
//Thanks to Stefan Mielke
$first = substr(key($acceptedLanguagesArr), 0, 2);
if ($first === $this->conf['defaultLang']) {
$preferredLanguageOrPageUid = 0;
break;
}
//Iterate through the user's accepted languages
foreach ($acceptedLanguagesArr as $currentLanguage) {
if (TYPO3_DLOG) {
GeneralUtility::devLog('Testing language: ' . $currentLanguage, $this->extKey);
}
//If the current language is available (full "US_en" type check)
if (isset($availableLanguagesArr[$currentLanguage])) {
$preferredLanguageOrPageUid = $availableLanguagesArr[$currentLanguage];
if (TYPO3_DLOG) {
GeneralUtility::devLog('Found: ' . $preferredLanguageOrPageUid . ' (full check)', $this->extKey);
}
break;
}
// If the available language is greater (e.g. "fr-ca") as the accepted language ("fr")
foreach ($availableLanguagesArr as $short => $languageUid) {
if (\strlen($short) > 2) {
$availableLanguageShort = substr($short, 0, 2);
if ($currentLanguage === $availableLanguageShort) {
$preferredLanguageOrPageUid = $languageUid;
break 2;
//Old-fashioned 2-char test ("en")
if ($preferredLanguageOrPageUid === false && \strlen($currentLanguage) > 2) {
$currentLanguageShort = substr($currentLanguage, 0, 2);
if (isset($availableLanguagesArr[$currentLanguageShort])) {
$preferredLanguageOrPageUid = $availableLanguagesArr[$currentLanguageShort];
if (TYPO3_DLOG) {
GeneralUtility::devLog('Found: ' . $preferredLanguageOrPageUid . ' (normal check)', $this->extKey);
}
break;
}
}
//If the user's language is in language aliases
if ($this->conf['useLanguageAliases'] && array_key_exists($currentLanguage, $languageAliases) && $preferredLanguageOrPageUid === false) {
$values = $languageAliases[$currentLanguage];
//Iterate through aliases and choose the first possible
foreach ($values as $value) {
if (isset($availableLanguagesArr[$value])) {
$preferredLanguageOrPageUid = $availableLanguagesArr[$value];
if (TYPO3_DLOG) {
GeneralUtility::devLog('Found: ' . $preferredLanguageOrPageUid . ' (alias check)', $this->extKey);
}
break 2;
}
}
}
}
break;
//GeoIP
case 'ip':
if ($this->conf['pearDirectory']) {
$pearDirectory = $this->conf['pearDirectory'];
} else {
$pearDirectory = PEAR_INSTALL_DIR;
}
if ($this->conf['pathToDatabaseForGeoIPData'] && file_exists($pearDirectory . '/Net/GeoIP.php')) {
require_once $pearDirectory . '/Net/GeoIP.php';
$pathToDatabase = GeneralUtility::getFileAbsFileName($this->conf['pathToDatabaseForGeoIPData']);
$geoIp = new \Net_GeoIP($pathToDatabase);
// Get country code from geoip
if (TYPO3_DLOG) {
GeneralUtility::devLog('IP: ' . $this->getUserIP(), $this->extKey);
}
$countryCode = strtolower($geoIp->lookupCountryCode($this->getUserIP()));
if (TYPO3_DLOG) {
GeneralUtility::devLog('GeoIP Country Code: ' . $countryCode, $this->extKey);
}
unset($geoIp);
}
// PHP module geoip
if (!$countryCode && function_exists('geoip_country_code_by_name')) {
// Get country code from geoip
if (TYPO3_DLOG) {
GeneralUtility::devLog('IP: ' . $this->getUserIP(), $this->extKey);
}
$countryCode = geoip_country_code_by_name($this->getUserIP());
if (TYPO3_DLOG) {
GeneralUtility::devLog('GeoIP Country Code: ' . $countryCode, $this->extKey);
}
}
if ($countryCode) {
$countryCode = strtolower($countryCode);
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
//Check for the country code in the configured list of country to languages
if (array_key_exists($countryCode, $this->conf['countryCodeToLanguageCode.'])
&& array_key_exists($this->conf['countryCodeToLanguageCode.'][$countryCode], $availableLanguagesArr)
) {
if (TYPO3_DLOG) {
GeneralUtility::devLog('Available language found in configured: ' . $countryCode, $this->extKey);
}
$preferredLanguageOrPageUid = $availableLanguagesArr[$this->conf['countryCodeToLanguageCode.'][$countryCode]];
//Use the static_info_tables lg_collate_locale to attempt to find a country to language relation.
} elseif (ExtensionManagementUtility::isLoaded('static_info_tables')) {
if (TYPO3_DLOG) {
GeneralUtility::devLog('Checking in static_info_tables.', $this->extKey);
}
//Get the language codes from lg_collate_locate
$values = $this->getLanguageCodesForCountry($countryCode);
foreach ($values as $value) {
//If one of the languages exist
if (array_key_exists($value, $availableLanguagesArr)) {
if (TYPO3_DLOG) {
GeneralUtility::devLog('Found in static_info_tables: ' . $value, $this->extKey);
}
$preferredLanguageOrPageUid = $availableLanguagesArr[$value];
break;
}
}
}
}
break;
//Handle hooks
default:
//Hook for adding other language processing
if (is_array($GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['rlmp_language_detection']['preferredLanguageHooks'])) {
foreach ($GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['rlmp_language_detection']['preferredLanguageHooks'] as $key => $_funcRef) {
if ($key === $testOrder[$i]) {
$preferredLanguageOrPageUid = GeneralUtility::callUserFunction($_funcRef, $availableLanguagesArr,
$this);
if ($preferredLanguageOrPageUid) {
break;
}
}
}
}
break;
}
}
if (TYPO3_DLOG) {
GeneralUtility::devLog('END result: Preferred=' . $preferredLanguageOrPageUid, $this->extKey);
}
if ($preferredLanguageOrPageUid !== false) {
$this->doRedirect((int)$preferredLanguageOrPageUid, $referrer);
}
return '';
}
/**
* @param int $preferredLanguageOrPageUid
* @param string $referrer
* @return void
*/
protected function doRedirect(int $preferredLanguageOrPageUid, string $referrer)
{
if ($this->conf['useOneTreeMethod']) {
$page = $this->getTSFE()->page;
} else {
/** @var PageRepository $sys_page */
$sys_page = GeneralUtility::makeInstance(PageRepository::class);
$sys_page->init(0);
$page = $sys_page->getPage($preferredLanguageOrPageUid);
}
$pageId = method_exists($this->getTSFE(), 'getRequestedId') ? $this->getTSFE()->getRequestedId() : $page['uid'];
//Add id to url GET parameters to remove
$removeParams = array('id');
//Check allowed url GET parameters if configured
if ($this->conf['allowedParams']) {
$getVariables = GeneralUtility::_GET();
if (isset($getVariables) && is_array($getVariables)) {
$allowedParams = GeneralUtility::trimExplode(',', $this->conf['allowedParams'], true);
//"type" and "MP" GET parameters are allowed by default
$allowedParams = array_merge($allowedParams, array('type', 'MP'));
$this->getTSFE()->calculateLinkVars();
parse_str($this->getTSFE()->linkVars, $query);
$allowedParams = array_merge($allowedParams, array_keys($query));
$disallowedParams = array_diff(array_keys($getVariables), $allowedParams);
// Add disallowed parameters to parameters to remove
$removeParams = array_merge($removeParams, $disallowedParams);
}
}
$urlParams = [
'addQueryString' => true,
'addQueryString.' => [
'exclude' => implode(',', $removeParams)
];
if ($this->conf['useOneTreeMethod']) {
$urlParams['additionalParams'] = '&' . $this->conf['languageGPVar'] . '=' . $preferredLanguageOrPageUid;
}
$url = $this->cObj->typoLink_URL($urlParams);
// Prefer the base URL if available
if (strlen($this->getTSFE()->baseUrl) > 1) {
$locationURL = $this->getTSFE()->baseURLWrap($url);
} else {
$locationURL = $this->conf['dontAddSchemeToURL'] ? $url : GeneralUtility::locationHeaderUrl($url);
}
//Set session info
//For one tree method store selected language
if ($this->cookieLifetime) {
setcookie(
$this->extKey . '_languageSelected',
(string)($this->conf['useOneTreeMethod'] ? $preferredLanguageOrPageUid : true),
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
$this->cookieLifetime + time()
);
} else {
$this->getTSFE()->fe_user->setKey(
'ses',
$this->extKey . '_languageSelected',
$this->conf['useOneTreeMethod'] ? $preferredLanguageOrPageUid : true
);
$this->getTSFE()->storeSessionData();
}
if (TYPO3_DLOG) {
GeneralUtility::devLog('Location to redirect to: ' . $locationURL, $this->extKey);
}
if (!$this->conf['dieAtEnd'] && ($preferredLanguageOrPageUid || $this->conf['forceRedirect'])) {
if (TYPO3_DLOG) {
GeneralUtility::devLog('Perform redirect', $this->extKey);
}
header('Location: ' . $locationURL);
header('Connection: close');
header('X-Note: Redirect by rlmp_language_detection (' . $referrer . ')');
}
if ($preferredLanguageOrPageUid) {
die();
}
}
/**
* Returns the preferred languages ("accepted languages") from the visitor's
* browser settings.
*
* The accepted languages are described in RFC 2616.
* It's a list of language codes (e.g. 'en' for english), separated by
* comma (,). Each language may have a quality-value (e.g. 'q=0.7') which
* defines a priority. If no q-value is given, '1' is assumed. The q-value
* is separated from the language code by a semicolon (;) (e.g. 'de;q=0.7')
*
* @return array An array containing the accepted languages; key and value = iso code, sorted by quality
*/
protected function getAcceptedLanguages():array
{
$languagesArr = [];
$rawAcceptedLanguagesArr = GeneralUtility::trimExplode(',', GeneralUtility::getIndpEnv('HTTP_ACCEPT_LANGUAGE'), true);
$acceptedLanguagesArr = [];
foreach ($rawAcceptedLanguagesArr as $languageAndQualityStr) {
list($languageCode, $quality) = GeneralUtility::trimExplode(';', $languageAndQualityStr);
$acceptedLanguagesArr[$languageCode] = $quality ? (float)substr($quality, 2) : (float)1;
}
// Now sort the accepted languages by their quality and create an array containing only the language codes in the correct order.
if (is_array($acceptedLanguagesArr)) {
arsort($acceptedLanguagesArr);
$languageCodesArr = array_keys($acceptedLanguagesArr);
if (is_array($languageCodesArr)) {
foreach ($languageCodesArr as $languageCode) {
$languagesArr[$languageCode] = $languageCode;
}
}
}
return $languagesArr;
}
/**
* Returns an array of sys_language records containing the ISO code as the key and the record's uid as the value
*
* @return array sys_language records: ISO code => uid of sys_language record
*/
protected function getSysLanguages():array
{
$availableLanguages = [];
if (\strlen($this->conf['defaultLang'])) {
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
$availableLanguages[trim(strtolower($this->conf['defaultLang']))] = 0;
}
$res = $this->getDB()->exec_SELECTquery(
'sys_language.uid, static_languages.lg_iso_2, static_languages.lg_country_iso_2',
'sys_language JOIN static_languages ON sys_language.static_lang_isocode = static_languages.uid',
'1=1' . $this->cObj->enableFields('sys_language') . $this->cObj->enableFields('static_languages')
);
while ($row = $this->getDB()->sql_fetch_assoc($res)) {
if (TYPO3_DLOG && !$row['isocode']) {
GeneralUtility::devLog('No ISO-code given for language with UID ' . $row['uid'], $this->extKey);
}
if (!empty($row['lg_country_iso_2'])) {
$availableLanguages[trim(strtolower($row['lg_iso_2'] . '-' . $row['lg_country_iso_2']))] = (int)$row['uid'];
} else {
$availableLanguages[trim(strtolower($row['lg_iso_2']))] = (int)$row['uid'];
}
}
//Remove all languages except limitToLanguages
if ($this->conf['limitToLanguages'] !== '') {
$limitToLanguages = GeneralUtility::trimExplode(
',',
strtolower($this->conf['limitToLanguages']),
true
);
$tmp = [];
foreach ($availableLanguages as $key => $value) {
//Only add allowed languages
if (in_array($key, $limitToLanguages)) {
$tmp[$key] = $value;
}
}
$availableLanguages = $tmp;
}
//Remove all languages in the exclude list
if ($this->conf['excludeLanguages'] !== '') {
$excludeLanguages = GeneralUtility::trimExplode(
',',
strtolower($this->conf['excludeLanguages']),
true
);
foreach ($excludeLanguages as $excludeLanguage) {
unset($availableLanguages[$excludeLanguage]);
}
}
return $availableLanguages;
}
/**
* Returns an array of available languages defined in the TypoScript configuration for this plugin.
* Acts as an alternative for getSysLanguages ()
*
* @return array Available languages: ISO code => Page ID of languages' root page
*/
protected function getMultipleTreeLanguages():array
{
$availableLanguages = [];
foreach ($this->conf['multipleTreesRootPages.'] as $isoCode => $uid) {
$availableLanguages[strtolower(trim($isoCode))] = (int)$uid;
}
return $availableLanguages;
}
/**
* @param string $countryCode
* @return array
*/
protected function getLanguageCodesForCountry(string $countryCode):array
{
/** @var PiBaseApi $staticInfoObj */
$staticInfoObj = GeneralUtility::makeInstance(PiBaseApi::class);
if ($staticInfoObj->needsInit()) {
$staticInfoObj->init();
}
$languages = $staticInfoObj->initLanguages(
' lg_collate_locale LIKE \'%_' . $this->getDB()->quoteStr(strtoupper($countryCode), 'static_languages') . '\' '
);
return array_map('strtolower', array_keys($languages));
}
/**
* Returns the user's IP
*
* @return string IP address
*/
protected function getUserIP():string
{
return GeneralUtility::getIndpEnv('HTTP_CLIENT_IP') ?? GeneralUtility::getIndpEnv('HTTP_X_FORWARDED_FOR') ?? GeneralUtility::getIndpEnv('REMOTE_ADDR');
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
}
/**
* @return TypoScriptFrontendController
*/
protected function getTSFE():TypoScriptFrontendController
{
return $GLOBALS['TSFE'];
}
/**
* @return DatabaseConnection
*/
protected function getDB():DatabaseConnection
{
return $GLOBALS['TYPO3_DB'];
}
/**
* @return bool
*/
protected function isBot():bool
{
$userAgent = GeneralUtility::getIndpEnv('HTTP_USER_AGENT');
return isset($userAgent) && preg_match($this->botPattern, $userAgent);
}
/**
* Test function for preferredLanguageHooks
* Prints arguments and dies.
*
* @param array $availableLanguagesArr Associative array containing available languages. Key is ISO 639-1 language code.
* Value is TYPO3 Website Language UID.
* @param LanguageDetection $parentObject Reference to the calling object.
*
* @return void
*/
public function testPreferredLanguageHooks($availableLanguagesArr, LanguageDetection $parentObject)
{
debug($availableLanguagesArr);
debug($parentObject);
die();
}