Last active
May 4, 2022 13:44
-
-
Save klodeckl/08ab910b3ec6ef3e4acb2bed1c986406 to your computer and use it in GitHub Desktop.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
<?php | |
declare(strict_types = 1); | |
namespace Calien\ExtendedRouting\Routing\Aspect; | |
/* | |
* 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 Doctrine\DBAL\Connection; | |
use TYPO3\CMS\Core\Context\Context; | |
use TYPO3\CMS\Core\Context\ContextAwareInterface; | |
use TYPO3\CMS\Core\Context\ContextAwareTrait; | |
use TYPO3\CMS\Core\Context\LanguageAspectFactory; | |
use TYPO3\CMS\Core\Database\ConnectionPool; | |
use TYPO3\CMS\Core\Database\Query\QueryBuilder; | |
use TYPO3\CMS\Core\Database\Query\Restriction\FrontendGroupRestriction; | |
use TYPO3\CMS\Core\Database\Query\Restriction\FrontendRestrictionContainer; | |
use TYPO3\CMS\Core\Routing\Legacy\PersistedAliasMapperLegacyTrait; | |
use TYPO3\CMS\Core\Site\SiteAwareInterface; | |
use TYPO3\CMS\Core\Site\SiteLanguageAwareInterface; | |
use TYPO3\CMS\Core\Utility\GeneralUtility; | |
use TYPO3\CMS\Frontend\Page\PageRepository; | |
use TYPO3\CMS\Core\Routing\Aspect\PersistedAliasMapper; | |
use TYPO3\CMS\Core\DataHandling\SlugHelper; | |
use TYPO3\CMS\Core\Site\SiteLanguageAwareTrait; | |
/** | |
* Classic usage when using a "URL segment" (e.g. slug) field within a database table. | |
* | |
* Example: | |
* routeEnhancers: | |
* EventsPlugin: | |
* type: Extbase | |
* extension: Events2 | |
* plugin: Pi1 | |
* routes: | |
* - { routePath: '/events/{event}', _controller: 'Event::detail', _arguments: {'event': 'event_name'}} | |
* defaultController: 'Events2::list' | |
* aspects: | |
* event: | |
* type: PersistedAliasMapper | |
* tableName: 'tx_events2_domain_model_event' | |
* routeFieldName: 'path_segment' | |
* routeValuePrefix: '/' | |
*/ | |
class PersistedAliasMapperLocales extends PersistedAliasMapper | |
{ | |
//use \TYPO3\CMS\Core\Routing\Aspect\AspectTrait; | |
//use \TYPO3\CMS\Core\Routing\Aspect\SiteLanguageAccessorTrait; | |
//use \TYPO3\CMS\Core\Routing\Aspect\SiteAccessorTrait; | |
//use \TYPO3\CMS\Core\Routing\Aspect\ContextAwareTrait; | |
//use \TYPO3\CMS\Core\Routing\Aspect\PersistedAliasMapperLegacyTrait; | |
use SiteLanguageAwareTrait; | |
/** | |
* @var array | |
*/ | |
protected $settings; | |
/** | |
* @var string | |
*/ | |
protected $tableName; | |
/** | |
* @var string | |
*/ | |
protected $routeFieldName; | |
/** | |
* @var string | |
*/ | |
protected $routeValuePrefix; | |
/** | |
* @var string[] | |
*/ | |
protected $persistenceFieldNames; | |
/** | |
* @var string|null | |
*/ | |
protected $languageFieldName; | |
/** | |
* @var string|null | |
*/ | |
protected $languageParentFieldName; | |
/** | |
* @var bool | |
*/ | |
protected $slugUniqueInSite; | |
/** | |
* @var array | |
*/ | |
protected $localeMap = []; | |
/** | |
* @param array $settings | |
* @throws \InvalidArgumentException | |
*/ | |
public function __construct(array $settings) | |
{ | |
$tableName = $settings['tableName'] ?? null; | |
$routeFieldName = $settings['routeFieldName'] ?? null; | |
$routeValuePrefix = $settings['routeValuePrefix'] ?? ''; | |
$localeMap = $settings['localeMap'] ?? []; | |
if (!is_string($tableName)) { | |
throw new \InvalidArgumentException( | |
'tableName must be string', | |
1537277133 | |
); | |
} | |
if (!is_string($routeFieldName)) { | |
throw new \InvalidArgumentException( | |
'routeFieldName name must be string', | |
1537277134 | |
); | |
} | |
if (!is_string($routeValuePrefix) || strlen($routeValuePrefix) > 1) { | |
throw new \InvalidArgumentException( | |
'$routeValuePrefix must be string with one character', | |
1537277136 | |
); | |
} | |
$this->settings = $settings; | |
$this->tableName = $tableName; | |
$this->routeFieldName = $routeFieldName; | |
$this->routeValuePrefix = $routeValuePrefix; | |
$this->languageFieldName = $GLOBALS['TCA'][$this->tableName]['ctrl']['languageField'] ?? null; | |
$this->languageParentFieldName = $GLOBALS['TCA'][$this->tableName]['ctrl']['transOrigPointerField'] ?? null; | |
$this->persistenceFieldNames = $this->buildPersistenceFieldNames(); | |
$this->slugUniqueInSite = $this->isSlugUniqueInSite($this->tableName, $this->routeFieldName); | |
$this->localeMap = $localeMap; | |
} | |
/** | |
* {@inheritdoc} | |
*/ | |
public function generate(string $value): ?string | |
{ | |
//$this->modify(); | |
$result = $this->findByIdentifier($value); | |
$result = $this->resolveOverlay($result); | |
if (!isset($result[$this->routeFieldName])) { | |
return null; | |
} | |
return $this->purgeRouteValuePrefix( | |
(string)$result[$this->routeFieldName] | |
); | |
} | |
/** | |
* {@inheritdoc} | |
*/ | |
public function resolve(string $value): ?string | |
{ | |
$this->modify(); | |
$value = $this->routeValuePrefix . $this->purgeRouteValuePrefix($value); | |
$result = $this->findByRouteFieldValue($value); | |
if ($result[$this->languageParentFieldName] ?? null > 0) { | |
return (string)$result[$this->languageParentFieldName]; | |
} | |
if (isset($result['uid'])) { | |
return (string)$result['uid']; | |
} | |
return null; | |
} | |
/** | |
* @return string[] | |
*/ | |
protected function buildPersistenceFieldNames(): array | |
{ | |
return array_filter([ | |
'uid', | |
'pid', | |
$this->routeFieldName, | |
$this->languageFieldName, | |
$this->languageParentFieldName, | |
]); | |
} | |
/** | |
* @param string|null $value | |
* @return string | |
*/ | |
protected function purgeRouteValuePrefix(?string $value): ?string | |
{ | |
if (empty($this->routeValuePrefix) || $value === null) { | |
return $value; | |
} | |
return ltrim($value, $this->routeValuePrefix); | |
} | |
protected function findByIdentifier(string $value): ?array | |
{ | |
$locale = $this->siteLanguage->getLocale(); | |
foreach ($this->localeMap as $item) { | |
$pattern = '#^' . $item['locale'] . '#i'; | |
if (preg_match($pattern, $locale)) { | |
$persistenceFieldNames1 = array("uid", "pid", (string)$item['field'] ?? null); | |
} | |
} | |
if (!isset($persistenceFieldNames1)) { | |
$persistenceFieldNames1 = $this->persistenceFieldNames; | |
} | |
//\TYPO3\CMS\Extbase\Utility\DebuggerUtility::var_dump($locale); | |
$queryBuilder = $this->createQueryBuilder(); | |
$result = $queryBuilder | |
->select(...$persistenceFieldNames1) | |
//->select(...$this->persistenceFieldNames) | |
->where($queryBuilder->expr()->eq( | |
'uid', | |
$queryBuilder->createNamedParameter($value, \PDO::PARAM_INT) | |
)) | |
->execute() | |
->fetch(); | |
if ($locale == 'en_GB.UTF-8' || $locale == 'en_US.UTF-8') { | |
$result['path_segment'] = $result['path_segment_en']; | |
} | |
return $result !== false ? $result : null; | |
} | |
protected function findByRouteFieldValue(string $value): ?array | |
{ | |
$languageAware = $this->languageFieldName !== null && $this->languageParentFieldName !== null; | |
$queryBuilder = $this->createQueryBuilder(); | |
$constraints = [ | |
$queryBuilder->expr()->eq( | |
$this->routeFieldName, | |
$queryBuilder->createNamedParameter($value, \PDO::PARAM_STR) | |
), | |
]; | |
$languageIds = null; | |
if ($languageAware) { | |
$languageIds = $this->resolveAllRelevantLanguageIds(); | |
$constraints[] = $queryBuilder->expr()->in( | |
$this->languageFieldName, | |
$queryBuilder->createNamedParameter($languageIds, Connection::PARAM_INT_ARRAY) | |
); | |
} | |
$locale = $this->siteLanguage->getLocale(); | |
foreach ($this->localeMap as $item) { | |
$pattern = '#^' . $item['locale'] . '#i'; | |
if (preg_match($pattern, $locale)) { | |
// \TYPO3\CMS\Extbase\Utility\DebuggerUtility::var_dump($item['field']); | |
$persistenceFieldNames1 = array("uid", "pid", (string)$item['field'] ?? null); | |
//$this->persistenceFieldNames[2] = (string)$item['field'] ?? null; | |
//\TYPO3\CMS\Extbase\Utility\DebuggerUtility::var_dump($persistenceFieldNames1); | |
//\TYPO3\CMS\Extbase\Utility\DebuggerUtility::var_dump((string)$item['field']); | |
//$localizedFieldName = (string)$item['field']; | |
//$this->routeFieldPattern = str_replace($this->routeFieldResultNames[0], $localizedFieldName, $this->routeFieldPattern); | |
//$this->routeFieldResult = str_replace($this->routeFieldResultNames[0], $localizedFieldName, $this->routeFieldResult); | |
//$this->routeFieldResultNames[0] = $localizedFieldName; | |
} | |
} | |
$results = $queryBuilder | |
->select(...$this->persistenceFieldNames) | |
//->select(...$persistenceFieldNames1) | |
->where(...$constraints) | |
->execute() | |
->fetchAll(); | |
// limit results to be contained in rootPageId of current Site | |
// (which is defining the route configuration currently being processed) | |
if ($this->slugUniqueInSite) { | |
$results = array_values($this->filterContainedInSite($results)); | |
} | |
// return first result record in case table is not language aware | |
if (!$languageAware) { | |
return $results[0] ?? null; | |
} | |
// post-process language fallbacks | |
return $this->resolveLanguageFallback($results, $this->languageFieldName, $languageIds); | |
} | |
protected function createQueryBuilder(): QueryBuilder | |
{ | |
$queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class) | |
->getQueryBuilderForTable($this->tableName) | |
->from($this->tableName); | |
$queryBuilder->setRestrictions( | |
GeneralUtility::makeInstance(FrontendRestrictionContainer::class, $this->context) | |
); | |
// Frontend Groups are not available at this time (initialized via TSFE->determineId) | |
// So this must be excluded to allow access restricted records | |
$queryBuilder->getRestrictions()->removeByType(FrontendGroupRestriction::class); | |
return $queryBuilder; | |
} | |
/** | |
* @param array|null $record | |
* @return array|null | |
*/ | |
protected function resolveOverlay(?array $record): ?array | |
{ | |
$languageId = $this->siteLanguage->getLanguageId(); | |
if ($record === null || $languageId === 0) { | |
return $record; | |
} | |
$pageRepository = $this->createPageRepository(); | |
if ($this->tableName === 'pages') { | |
return $pageRepository->getPageOverlay($record, $languageId); | |
} | |
return $pageRepository | |
->getRecordOverlay($this->tableName, $record, $languageId) ?: null; | |
} | |
/** | |
* @return PageRepository | |
*/ | |
protected function createPageRepository(): PageRepository | |
{ | |
$context = clone GeneralUtility::makeInstance(Context::class); | |
$context->setAspect( | |
'language', | |
LanguageAspectFactory::createFromSiteLanguage($this->siteLanguage) | |
); | |
return GeneralUtility::makeInstance( | |
PageRepository::class, | |
$context | |
); | |
} | |
/** | |
* modify | |
* @return void | |
*/ | |
protected function modify(): void | |
{ | |
$locale = $this->siteLanguage->getLocale(); | |
foreach ($this->localeMap as $item) { | |
$pattern = '#^' . $item['locale'] . '#i'; | |
if (preg_match($pattern, $locale)) { | |
$this->routeFieldName = (string)$item['field']; | |
$localizedFieldName = (string)$item['field']; | |
$this->routeFieldPattern = str_replace($this->routeFieldResultNames[0], $localizedFieldName, $this->routeFieldPattern); | |
$this->routeFieldResult = str_replace($this->routeFieldResultNames[0], $localizedFieldName, $this->routeFieldResult); | |
$this->routeFieldResultNames[0] = $localizedFieldName; | |
} | |
} | |
} | |
} |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment