BackendUserConfigurationUpdate.php

Go to the documentation of this file.

<?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\Database\ConnectionPool;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
 
class ‪BackendUserConfigurationUpdate implements ‪UpgradeWizardInterface
{
    public function ‪getIdentifier(): string
    {
        return 'backendUsersConfiguration';
    }
 
    public function ‪getTitle(): string
    {
        return 'Update backend user configuration array';
    }
 
    public function ‪getDescription(): string
    {
        return 'The backend user "uc" array, which is persisted in the db, now only allows for'
            . ' arrays inside its structure instead of stdClass objects.'
            . ' Update the uc structure for all backend users.';
    }
 
    public function ‪updateNecessary(): bool
    {
        $needsExecution = false;
 
        foreach ($this->‪getAffectedBackendUsers() as $backendUser) {
            $userConfig = $this->‪unserializeUserConfig($backendUser['uc']);
 
            if (!is_array($userConfig)) {
                continue;
            }
 
            array_walk_recursive($userConfig, function (&$item) use (&$needsExecution) {
                if ($item instanceof \stdClass) {
                    $needsExecution = true;
                }
            });
 
            if ($needsExecution) {
                break;
            }
        }
 
        return $needsExecution;
    }
 
    public function ‪getPrerequisites(): array
    {
        return [
            DatabaseUpdatedPrerequisite::class
        ];
    }
 
    public function ‪executeUpdate(): bool
    {
        foreach ($this->‪getAffectedBackendUsers() as $backendUser) {
            $userConfig = $this->‪unserializeUserConfig($backendUser['uc']);
 
            if (!is_array($userConfig)) {
                continue;
            }
 
            array_walk_recursive($userConfig, function (&$item) {
                if ($item instanceof \stdClass) {
                    $item = json_decode(json_encode($item), true);
                }
            });
 
            $this->‪updateBackendUser((int)$backendUser['uid'], $userConfig);
        }
 
        return true;
    }
 
    private function ‪unserializeUserConfig(string $userConfig)
    {
        return unserialize($userConfig, ['allowed_classes' => ['stdClass']]);
    }
 
    private function ‪getAffectedBackendUsers(): iterable
    {
        $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)
            ->getQueryBuilderForTable('be_users');
        $queryBuilder->getRestrictions()->removeAll();
        $statement = $queryBuilder
            ->select('uid', 'uc')
            ->from('be_users')
            ->where(
                $queryBuilder->expr()->like(
                    'uc',
                    $queryBuilder->createNamedParameter(
                        '%"stdClass"%'
                    )
                )
            );
 
        return $statement->execute();
    }
 
    private function ‪updateBackendUser(int $userId, array $userConfig): void
    {
        $connection = GeneralUtility::makeInstance(ConnectionPool::class)->getConnectionForTable('be_users');
        $connection->update('be_users', ['uc' => serialize($userConfig)], ['uid' => $userId], [\PDO::PARAM_LOB, \PDO::PARAM_INT]);
    }
}