first commit
This commit is contained in:
salam committed
commit
1218dd1517
12716 files changed
+989233
No files matched your search
@@ -0,0 +1,266 @@
|
||||
<?php
|
||||
declare(strict_types = 1);
|
||||
namespace TYPO3\CMS\Install\Updates;
|
||||
|
||||
/*
|
||||
* 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\Context\Context;
|
||||
use TYPO3\CMS\Core\Database\ConnectionPool;
|
||||
use TYPO3\CMS\Core\Database\Query\Restriction\DeletedRestriction;
|
||||
use TYPO3\CMS\Core\DataHandling\Model\RecordStateFactory;
|
||||
use TYPO3\CMS\Core\DataHandling\SlugHelper;
|
||||
use TYPO3\CMS\Core\Utility\GeneralUtility;
|
||||
|
||||
/**
|
||||
* Fills pages.slug with a proper value for pages that do not have a slug updater.
|
||||
* Does not take "deleted" pages into account, but respects workspace records.
|
||||
*
|
||||
* This is how it works:
|
||||
* - Check if a page has pages.alias filled.
|
||||
* - Check if realurl v1 (tx_realurl_pathcache) or v2 (tx_realurl_pathdata) has a page path, use that instead.
|
||||
* - If not -> generate the slug.
|
||||
*
|
||||
* @internal This class is only meant to be used within EXT:install and is not part of the TYPO3 Core API.
|
||||
*/
|
||||
class PopulatePageSlugs implements UpgradeWizardInterface
|
||||
{
|
||||
protected $table = 'pages';
|
||||
|
||||
protected $fieldName = 'slug';
|
||||
|
||||
/**
|
||||
* @return string Unique identifier of this updater
|
||||
*/
|
||||
public function getIdentifier(): string
|
||||
{
|
||||
return 'pagesSlugs';
|
||||
}
|
||||
|
||||
/**
|
||||
* @return string Title of this updater
|
||||
*/
|
||||
public function getTitle(): string
|
||||
{
|
||||
return 'Introduce URL parts ("slugs") to all existing pages';
|
||||
}
|
||||
|
||||
/**
|
||||
* @return string Longer description of this updater
|
||||
*/
|
||||
public function getDescription(): string
|
||||
{
|
||||
return 'TYPO3 includes native URL handling. Every page record has its own speaking URL path'
|
||||
. ' called "slug" which can be edited in TYPO3 Backend. However, it is necessary that all pages have'
|
||||
. ' a URL pre-filled. This is done by evaluating the page title / navigation title and all of its rootline.';
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks whether updates are required.
|
||||
*
|
||||
* @return bool Whether an update is required (TRUE) or not (FALSE)
|
||||
*/
|
||||
public function updateNecessary(): bool
|
||||
{
|
||||
$updateNeeded = false;
|
||||
// Check if the database table even exists
|
||||
if ($this->checkIfWizardIsRequired()) {
|
||||
$updateNeeded = true;
|
||||
}
|
||||
return $updateNeeded;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return string[] All new fields and tables must exist
|
||||
*/
|
||||
public function getPrerequisites(): array
|
||||
{
|
||||
return [
|
||||
DatabaseUpdatedPrerequisite::class
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* Performs the accordant updates.
|
||||
*
|
||||
* @return bool Whether everything went smoothly or not
|
||||
*/
|
||||
public function executeUpdate(): bool
|
||||
{
|
||||
$this->populateSlugs();
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Fills the database table "pages" with slugs based on the page title and its configuration.
|
||||
* But also checks "legacy" functionality.
|
||||
*/
|
||||
protected function populateSlugs()
|
||||
{
|
||||
$connection = GeneralUtility::makeInstance(ConnectionPool::class)->getConnectionForTable($this->table);
|
||||
$queryBuilder = $connection->createQueryBuilder();
|
||||
$queryBuilder->getRestrictions()->removeAll()->add(GeneralUtility::makeInstance(DeletedRestriction::class));
|
||||
$statement = $queryBuilder
|
||||
->select('*')
|
||||
->from($this->table)
|
||||
->where(
|
||||
$queryBuilder->expr()->orX(
|
||||
$queryBuilder->expr()->eq($this->fieldName, $queryBuilder->createNamedParameter('')),
|
||||
$queryBuilder->expr()->isNull($this->fieldName)
|
||||
)
|
||||
)
|
||||
// Ensure that fields with alias are managed first
|
||||
->orderBy('alias', 'desc')
|
||||
// Ensure that live workspace records are handled first
|
||||
->addOrderBy('t3ver_wsid', 'asc')
|
||||
// Ensure that all pages are run through "per parent page" field, and in the correct sorting values
|
||||
->addOrderBy('pid', 'asc')
|
||||
->addOrderBy('sorting', 'asc')
|
||||
->execute();
|
||||
|
||||
// Check for existing slugs from realurl
|
||||
$suggestedSlugs = [];
|
||||
if ($this->checkIfTableExists('tx_realurl_pathdata')) {
|
||||
$suggestedSlugs = $this->getSuggestedSlugs('tx_realurl_pathdata');
|
||||
} elseif ($this->checkIfTableExists('tx_realurl_pathcache')) {
|
||||
$suggestedSlugs = $this->getSuggestedSlugs('tx_realurl_pathcache', 'cache_id');
|
||||
}
|
||||
|
||||
$fieldConfig = $GLOBALS['TCA'][$this->table]['columns'][$this->fieldName]['config'];
|
||||
$fieldConfig['generatorOptions']['fields'] = ['tx_realurl_pathsegment,title'];
|
||||
$evalInfo = !empty($fieldConfig['eval']) ? GeneralUtility::trimExplode(',', $fieldConfig['eval'], true) : [];
|
||||
$hasToBeUniqueInSite = in_array('uniqueInSite', $evalInfo, true);
|
||||
$hasToBeUniqueInPid = in_array('uniqueInPid', $evalInfo, true);
|
||||
$slugHelper = GeneralUtility::makeInstance(SlugHelper::class, $this->table, $this->fieldName, $fieldConfig);
|
||||
while ($record = $statement->fetch()) {
|
||||
$recordId = (int)$record['uid'];
|
||||
$pid = (int)$record['pid'];
|
||||
$languageId = (int)$record['sys_language_uid'];
|
||||
$pageIdInDefaultLanguage = $languageId > 0 ? (int)$record['l10n_parent'] : $recordId;
|
||||
$slug = $suggestedSlugs[$pageIdInDefaultLanguage][$languageId] ?? '';
|
||||
|
||||
// see if an alias field was used, then let's build a slug out of that.
|
||||
if (!empty($record['alias'])) {
|
||||
$slug = $slugHelper->sanitize('/' . $record['alias']);
|
||||
}
|
||||
|
||||
if (empty($slug)) {
|
||||
if ($pid === -1) {
|
||||
$queryBuilder = $connection->createQueryBuilder();
|
||||
$queryBuilder->getRestrictions()->removeAll()->add(GeneralUtility::makeInstance(DeletedRestriction::class));
|
||||
$liveVersion = $queryBuilder
|
||||
->select('pid')
|
||||
->from('pages')
|
||||
->where(
|
||||
$queryBuilder->expr()->eq('uid', $queryBuilder->createNamedParameter($record['t3ver_oid'], \PDO::PARAM_INT))
|
||||
)->execute()->fetch();
|
||||
$pid = (int)$liveVersion['pid'];
|
||||
}
|
||||
$slug = $slugHelper->generate($record, $pid);
|
||||
}
|
||||
|
||||
$state = RecordStateFactory::forName($this->table)
|
||||
->fromArray($record, $pid, $recordId);
|
||||
if ($hasToBeUniqueInSite && !$slugHelper->isUniqueInSite($slug, $state)) {
|
||||
$slug = $slugHelper->buildSlugForUniqueInSite($slug, $state);
|
||||
}
|
||||
if ($hasToBeUniqueInPid && !$slugHelper->isUniqueInPid($slug, $state)) {
|
||||
$slug = $slugHelper->buildSlugForUniqueInPid($slug, $state);
|
||||
}
|
||||
|
||||
$connection->update(
|
||||
$this->table,
|
||||
[$this->fieldName => $slug],
|
||||
['uid' => $recordId]
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if there are record within "pages" database table with an empty "slug" field.
|
||||
*
|
||||
* @return bool
|
||||
* @throws \InvalidArgumentException
|
||||
*/
|
||||
protected function checkIfWizardIsRequired(): bool
|
||||
{
|
||||
$connectionPool = GeneralUtility::makeInstance(ConnectionPool::class);
|
||||
$queryBuilder = $connectionPool->getQueryBuilderForTable($this->table);
|
||||
$queryBuilder->getRestrictions()->removeAll()->add(GeneralUtility::makeInstance(DeletedRestriction::class));
|
||||
|
||||
$numberOfEntries = $queryBuilder
|
||||
->count('uid')
|
||||
->from($this->table)
|
||||
->where(
|
||||
$queryBuilder->expr()->orX(
|
||||
$queryBuilder->expr()->eq($this->fieldName, $queryBuilder->createNamedParameter('')),
|
||||
$queryBuilder->expr()->isNull($this->fieldName)
|
||||
)
|
||||
)
|
||||
->execute()
|
||||
->fetchColumn();
|
||||
return $numberOfEntries > 0;
|
||||
}
|
||||
|
||||
/**
|
||||
* Resolve prepared realurl "pagepath" for pages
|
||||
*
|
||||
* @param string $tableName
|
||||
* @param string $identityField
|
||||
* @return array with pageID (default language) and language ID as two-dimensional array containing the page path
|
||||
*/
|
||||
protected function getSuggestedSlugs(string $tableName, string $identityField = 'uid'): array
|
||||
{
|
||||
$context = GeneralUtility::makeInstance(Context::class);
|
||||
$currentTimestamp = $context->getPropertyFromAspect('date', 'timestamp');
|
||||
|
||||
$queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)->getQueryBuilderForTable($tableName);
|
||||
$statement = $queryBuilder
|
||||
->select('*')
|
||||
->from($tableName)
|
||||
->where(
|
||||
$queryBuilder->expr()->eq('mpvar', $queryBuilder->createNamedParameter('')),
|
||||
$queryBuilder->expr()->orX(
|
||||
$queryBuilder->expr()->eq('expire', $queryBuilder->createNamedParameter(0)),
|
||||
$queryBuilder->expr()->gt('expire', $queryBuilder->createNamedParameter($currentTimestamp))
|
||||
)
|
||||
)
|
||||
->orderBy('expire', 'ASC')
|
||||
->execute();
|
||||
$suggestedSlugs = [];
|
||||
while ($row = $statement->fetch()) {
|
||||
// rawurldecode ensures that non-ASCII arguments are also migrated
|
||||
$pagePath = rawurldecode($row['pagepath']);
|
||||
if (!isset($suggestedSlugs[(int)$row['page_id']][(int)$row['language_id']])) { // keep only first result
|
||||
$suggestedSlugs[(int)$row['page_id']][(int)$row['language_id']] = '/' . trim($pagePath, '/');
|
||||
}
|
||||
}
|
||||
return $suggestedSlugs;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if given table exists
|
||||
*
|
||||
* @param string $table
|
||||
* @return bool
|
||||
*/
|
||||
protected function checkIfTableExists($table)
|
||||
{
|
||||
$tableExists = GeneralUtility::makeInstance(ConnectionPool::class)
|
||||
->getConnectionForTable($table)
|
||||
->getSchemaManager()
|
||||
->tablesExist([$table]);
|
||||
|
||||
return $tableExists;
|
||||
}
|
||||
}
|
||||
Reference in new issue
Block a user