9.5/_start_module_update_8php_source.html

<?php

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 ‪StartModuleUpdate implements ‪UpgradeWizardInterface

{

    public function ‪getIdentifier(): string

    {

        return 'startModuleUpdate';

    }


    public function ‪getTitle(): string

    {

        return 'Update backend user setting "startModule"';

    }


    public function ‪getDescription(): string

    {

        return 'The backend user setting startModule is changed for the extensions about/aboutmodules.'

            . ' Update all backend users that use ext:aboutmodules as startModule.';

    }


    public function ‪updateNecessary(): bool

    {

        $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)->getQueryBuilderForTable('be_users');

        $queryBuilder->getRestrictions()->removeAll();

        $statement = $queryBuilder->select('uid', 'uc')->from('be_users')->execute();

        $needsExecution = false;

        while ($backendUser = $statement->fetch()) {

            if ($backendUser['uc'] !== null) {

                $userConfig = unserialize($backendUser['uc'], ['allowed_classes' => false]);

                if ($userConfig['startModule'] === 'help_aboutmodules'

                    || $userConfig['startModule'] === 'help_AboutmodulesAboutmodules'

                    || $userConfig['startModule'] === 'help_AboutAboutmodules'

                ) {

                    $needsExecution = true;

                    break;

                }

            }

        }

        return $needsExecution;

    }


    public function ‪getPrerequisites(): array

    {

        return [

            DatabaseUpdatedPrerequisite::class

        ];

    }


    public function ‪executeUpdate(): bool

    {

        $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)->getQueryBuilderForTable('be_users');

        $queryBuilder->getRestrictions()->removeAll();

        $statement = $queryBuilder->select('uid', 'uc')->from('be_users')->execute();

        while ($backendUser = $statement->fetch()) {

            if ($backendUser['uc'] !== null) {

                $userConfig = unserialize($backendUser['uc'], ['allowed_classes' => false]);

                if ($userConfig['startModule'] === 'help_aboutmodules'

                    || $userConfig['startModule'] === 'help_AboutmodulesAboutmodules'

                    || $userConfig['startModule'] === 'help_AboutAboutmodules'

                ) {

                    $userConfig['startModule'] = 'help_AboutAbout';

                    $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)->getQueryBuilderForTable('be_users');

                    $queryBuilder->getRestrictions()->removeAll();

                    $queryBuilder->update('be_users')

                        ->where(

                            $queryBuilder->expr()->eq(

                                'uid',

                                $queryBuilder->createNamedParameter($backendUser['uid'], \PDO::PARAM_INT)

                            )

                        )

                        ->set('uc', $queryBuilder->createNamedParameter(serialize($userConfig), \PDO::PARAM_LOB))

                        ->execute();

                }

            }

        }

        return true;

    }

}