MigrateUrlTypesInPagesUpdate.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
/*
 * 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!
 */
 
namespace ‪TYPO3\CMS\Install\Updates;
 
use ‪TYPO3\CMS\Core\Database\ConnectionPool;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
 
class ‪MigrateUrlTypesInPagesUpdate implements ‪UpgradeWizardInterface
{
    private ‪$databaseTables = ['pages', 'pages_language_overlay'];
 
    private ‪$urltypes = ['', 'http://', 'ftp://', 'mailto:', 'https://'];
 
    public function ‪getIdentifier(): string
    {
        return 'pagesUrltypeField';
    }
 
    public function ‪getTitle(): string
    {
        return 'Migrate pages.urltype to pages.url';
    }
 
    public function ‪getDescription(): string
    {
        return 'The page property "URL Protocol" for external URLs has been merged into the URL itself.'
            . ' The update wizard takes care of properly populating all existing pages and page translations.';
    }
 
    public function ‪updateNecessary(): bool
    {
        if (!$this->‪checkIfWizardIsRequired()) {
            return false;
        }
        $recordsToMigrate = 0;
        // Check if there is data to migrate
        foreach ($this->databaseTables as $databaseTable) {
            $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)
                ->getQueryBuilderForTable($databaseTable);
            $queryBuilder->getRestrictions()->removeAll();
            $recordsToMigrate = $queryBuilder->count('*')
                ->from($databaseTable)
                ->where(
                    $queryBuilder->expr()->neq('urltype', 0),
                    $queryBuilder->expr()->neq('url', $queryBuilder->createPositionalParameter(''))
                )
                ->execute()
                ->fetchColumn();
 
            if ($recordsToMigrate > 0) {
                break;
            }
        }
        return $recordsToMigrate > 0;
    }
 
    public function ‪getPrerequisites(): array
    {
        return [
            DatabaseUpdatedPrerequisite::class
        ];
    }
 
    public function ‪executeUpdate(): bool
    {
        foreach ($this->databaseTables as $databaseTable) {
            $connection = GeneralUtility::makeInstance(ConnectionPool::class)
                ->getConnectionForTable($databaseTable);
 
            // Process records that have entries in pages.urltype
            $queryBuilder = $connection->createQueryBuilder();
            $queryBuilder->getRestrictions()->removeAll();
            $statement = $queryBuilder->select('uid', 'urltype', 'url')
                ->from($databaseTable)
                ->where(
                    $queryBuilder->expr()->neq('urltype', 0),
                    $queryBuilder->expr()->neq('url', $queryBuilder->createPositionalParameter(''))
                )
                ->execute();
 
            while ($row = $statement->fetch()) {
                $url = $this->urltypes[(int)$row['urltype']] . $row['url'];
                $updateQueryBuilder = $connection->createQueryBuilder();
                $updateQueryBuilder
                    ->update($databaseTable)
                    ->where(
                        $updateQueryBuilder->expr()->eq(
                            'uid',
                            $updateQueryBuilder->createNamedParameter($row['uid'], \PDO::PARAM_INT)
                        )
                    )
                    ->set('url', $updateQueryBuilder->createNamedParameter($url), false)
                    ->set('urltype', 0);
                $updateQueryBuilder->execute();
            }
        }
        return true;
    }
 
    protected function ‪checkIfWizardIsRequired(): bool
    {
        foreach ($this->databaseTables as $key => $databaseTable) {
            $columns = GeneralUtility::makeInstance(ConnectionPool::class)
                ->getConnectionForTable($databaseTable)
                ->getSchemaManager()
                ->listTableColumns($databaseTable);
            if (!isset($columns['urltype'])) {
                unset($this->databaseTables[$key]);
            }
        }
        return count($this->databaseTables) > 0;
    }
}