9.5/_setup_module_controller_8php_source.html

<?php

namespace ‪TYPO3\CMS\Setup\Controller;


/*

 * 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 Psr\Http\Message\ResponseInterface;

use Psr\Http\Message\ServerRequestInterface;

use ‪TYPO3\CMS\Backend\Backend\Avatar\DefaultAvatarProvider;

use ‪TYPO3\CMS\Backend\Module\ModuleLoader;

use ‪TYPO3\CMS\Backend\Routing\UriBuilder;

use ‪TYPO3\CMS\Backend\Template\ModuleTemplate;

use ‪TYPO3\CMS\Backend\Utility\BackendUtility;

use ‪TYPO3\CMS\Core\Authentication\BackendUserAuthentication;

use ‪TYPO3\CMS\Core\Compatibility\PublicMethodDeprecationTrait;

use ‪TYPO3\CMS\Core\Compatibility\PublicPropertyDeprecationTrait;

use ‪TYPO3\CMS\Core\Core\Environment;

use ‪TYPO3\CMS\Core\Crypto\PasswordHashing\InvalidPasswordHashException;

use ‪TYPO3\CMS\Core\Crypto\PasswordHashing\PasswordHashFactory;

use ‪TYPO3\CMS\Core\Database\ConnectionPool;

use ‪TYPO3\CMS\Core\DataHandling\DataHandler;

use ‪TYPO3\CMS\Core\FormProtection\FormProtectionFactory;

use ‪TYPO3\CMS\Core\Http\HtmlResponse;

use ‪TYPO3\CMS\Core\Imaging\Icon;

use ‪TYPO3\CMS\Core\Imaging\IconFactory;

use ‪TYPO3\CMS\Core\Localization\Locales;

use ‪TYPO3\CMS\Core\Messaging\FlashMessage;

use ‪TYPO3\CMS\Core\Messaging\FlashMessageService;

use ‪TYPO3\CMS\Core\Resource\Exception\FileDoesNotExistException;

use ‪TYPO3\CMS\Core\Resource\ResourceFactory;

use ‪TYPO3\CMS\Core\Utility\GeneralUtility;


class ‪SetupModuleController

{

    use ‪PublicPropertyDeprecationTrait;

    use ‪PublicMethodDeprecationTrait;


    const ‪PASSWORD_NOT_UPDATED = 0;


    const ‪PASSWORD_UPDATED = 1;


    const ‪PASSWORD_NOT_THE_SAME = 2;


    const ‪PASSWORD_OLD_WRONG = 3;


    private ‪$deprecatedPublicProperties = [

        'OLD_BE_USER' => 'Using $OLD_BE_USER of class SetupModuleController from the outside is discouraged, the variable will be removed.',

        'MOD_MENU' => 'Using $MOD_MENU of class SetupModuleController from the outside is discouraged, the variable will be removed.',

        'MOD_SETTINGS' => 'Using $MOD_SETTINGS of class SetupModuleController from the outside is discouraged, the variable will be removed.',

        'content' => 'Using $content of class SetupModuleController from the outside is discouraged, as this variable is only used for internal storage.',

        'overrideConf' => 'Using $overrideConf of class SetupModuleController from the outside is discouraged, as this variable is only used for internal storage.',

        'languageUpdate' => 'Using $languageUpdate of class SetupModuleController from the outside is discouraged, as this variable is only used for internal storage.',

    ];


    private ‪$deprecatedPublicMethods = [

        'storeIncomingData' => 'Using SetupModuleController::storeIncomingData() is deprecated and will not be possible anymore in TYPO3 v10.0.',

        'main' => 'Using SetupModuleController::main() is deprecated and will not be possible anymore in TYPO3 v10.0.',

        'init' => 'Using SetupModuleController::init() is deprecated and will not be possible anymore in TYPO3 v10.0.',

    ];


    protected ‪$MOD_MENU = [];


    protected ‪$MOD_SETTINGS = [];


    protected ‪$content;


    protected ‪$overrideConf;


    protected ‪$OLD_BE_USER;


    protected ‪$languageUpdate;


    protected ‪$pagetreeNeedsRefresh = false;


    protected ‪$isAdmin;


    protected ‪$tsFieldConf;


    protected ‪$saveData = false;


    protected ‪$passwordIsUpdated = ‪self::PASSWORD_NOT_UPDATED;


    protected ‪$passwordIsSubmitted = false;


    protected ‪$setupIsUpdated = false;


    protected ‪$settingsAreResetToDefault = false;


    protected ‪$formProtection;


    protected ‪$simulateSelector = '';


    protected ‪$simUser;


    protected ‪$moduleName = 'user_setup';


    protected ‪$moduleTemplate;


    public function ‪__construct()

    {

        $this->moduleTemplate = GeneralUtility::makeInstance(ModuleTemplate::class);

        $this->formProtection = ‪FormProtectionFactory::get();

        $pageRenderer = $this->moduleTemplate->getPageRenderer();

        $pageRenderer->loadRequireJsModule('TYPO3/CMS/Backend/Modal');

        $pageRenderer->loadRequireJsModule('TYPO3/CMS/Backend/FormEngine');

        $pageRenderer->addInlineSetting('FormEngine', 'formName', 'editform');

        $pageRenderer->addInlineLanguageLabelArray([

            'FormEngine.remainingCharacters' => $this->‪getLanguageService()->sL('LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:labels.remainingCharacters'),

        ]);

    }


    public function ‪getFormProtection()

    {

        trigger_error('SetupModuleController->getFormProtection() will be removed in TYPO3 v10.0.', E_USER_DEPRECATED);

        return ‪$this->formProtection;

    }


    protected function ‪storeIncomingData()

    {

        // First check if something is submitted in the data-array from POST vars

        $d = GeneralUtility::_POST('data');

        $columns = ‪$GLOBALS['TYPO3_USER_SETTINGS']['columns'];

        $backendUser = $this->‪getBackendUser();

        $beUserId = $backendUser->user['uid'];

        $storeRec = [];

        $fieldList = $this->‪getFieldsFromShowItem();

        if (is_array($d) && $this->formProtection->validateToken((string)GeneralUtility::_POST('formToken'), 'BE user setup', 'edit')) {

            // UC hashed before applying changes

            $save_before = md5(serialize($backendUser->uc));

            // PUT SETTINGS into the ->uc array:

            // Reload left frame when switching BE language

            if (isset($d['lang']) && $d['lang'] != $backendUser->uc['lang']) {

                $this->languageUpdate = true;

            }

            // Reload pagetree if the title length is changed

            if (isset($d['titleLen']) && $d['titleLen'] !== $backendUser->uc['titleLen']) {

                $this->pagetreeNeedsRefresh = true;

            }

            if ($d['setValuesToDefault']) {

                // If every value should be default

                $backendUser->resetUC();

                $this->settingsAreResetToDefault = true;

            } elseif ($d['save']) {

                // Save all submitted values if they are no array (arrays are with table=be_users) and exists in $GLOBALS['TYPO3_USER_SETTINGS'][columns]

                foreach ($columns as $field => $config) {

                    if (!in_array($field, $fieldList)) {

                        continue;

                    }

                    if ($config['table']) {

                        if ($config['table'] === 'be_users' && !in_array($field, ['password', 'password2', 'passwordCurrent', 'email', 'realName', 'admin', 'avatar'])) {

                            if (!isset($config['access']) || $this->‪checkAccess($config) && $backendUser->user[$field] !== $d['be_users'][$field]) {

                                if ($config['type'] === 'check') {

                                    $fieldValue = isset($d['be_users'][$field]) ? 1 : 0;

                                } else {

                                    $fieldValue = $d['be_users'][$field];

                                }

                                $storeRec['be_users'][$beUserId][$field] = $fieldValue;

                                $backendUser->user[$field] = $fieldValue;

                            }

                        }

                    }

                    if ($config['type'] === 'check') {

                        $backendUser->uc[$field] = isset($d[$field]) ? 1 : 0;

                    } else {

                        $backendUser->uc[$field] = htmlspecialchars($d[$field]);

                    }

                }

                // Personal data for the users be_user-record (email, name, password...)

                // If email and name is changed, set it in the users record:

                $be_user_data = $d['be_users'];

                // Possibility to modify the transmitted values. Useful to do transformations, like RSA password decryption

                foreach (‪$GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['ext/setup/mod/index.php']['modifyUserDataBeforeSave'] ?? [] as $function) {

                    $params = ['be_user_data' => &$be_user_data];

                    GeneralUtility::callUserFunction($function, $params, $this);

                }

                $this->passwordIsSubmitted = (string)$be_user_data['password'] !== '';

                $passwordIsConfirmed = $this->passwordIsSubmitted && $be_user_data['password'] === $be_user_data['password2'];

                // Update the real name:

                if ($be_user_data['realName'] !== $backendUser->user['realName']) {

                    $backendUser->user['realName'] = ($storeRec['be_users'][$beUserId]['realName'] = substr($be_user_data['realName'], 0, 80));

                }

                // Update the email address:

                if ($be_user_data['email'] !== $backendUser->user['email']) {

                    $backendUser->user['email'] = ($storeRec['be_users'][$beUserId]['email'] = substr($be_user_data['email'], 0, 80));

                }

                // Update the password:

                if ($passwordIsConfirmed) {

                    if ($this->isAdmin) {

                        $passwordOk = true;

                    } else {

                        $currentPasswordHashed = ‪$GLOBALS['BE_USER']->user['password'];

                        $passwordOk = false;

                        $saltFactory = GeneralUtility::makeInstance(PasswordHashFactory::class);

                        try {

                            $hashInstance = $saltFactory->get($currentPasswordHashed, 'BE');

                            $passwordOk = $hashInstance->checkPassword($be_user_data['passwordCurrent'], $currentPasswordHashed);

                        } catch (InvalidPasswordHashException $e) {

                            // Could not find hash class responsible for existing password. This is a

                            // misconfiguration and user can not change its password.

                        }

                    }

                    if ($passwordOk) {

                        $this->passwordIsUpdated = ‪self::PASSWORD_UPDATED;

                        $storeRec['be_users'][$beUserId]['password'] = $be_user_data['password'];

                    } else {

                        $this->passwordIsUpdated = ‪self::PASSWORD_OLD_WRONG;

                    }

                } else {

                    $this->passwordIsUpdated = ‪self::PASSWORD_NOT_THE_SAME;

                }


                $this->‪setAvatarFileUid($beUserId, $be_user_data['avatar'], $storeRec);


                $this->saveData = true;

            }

            // Inserts the overriding values.

            $backendUser->overrideUC();

            $save_after = md5(serialize($backendUser->uc));

            // If something in the uc-array of the user has changed, we save the array...

            if ($save_before != $save_after) {

                $backendUser->writeUC($backendUser->uc);

                $backendUser->writelog(254, 1, 0, 1, 'Personal settings changed', []);

                $this->setupIsUpdated = true;

            }

            // Persist data if something has changed:

            if (!empty($storeRec) && $this->saveData) {

                // Make instance of TCE for storing the changes.

                $dataHandler = GeneralUtility::makeInstance(DataHandler::class);

                $dataHandler->start($storeRec, []);

                $dataHandler->admin = true;

                // This is to make sure that the users record can be updated even if in another workspace. This is tolerated.

                $dataHandler->bypassWorkspaceRestrictions = true;

                $dataHandler->process_datamap();

                if ($this->passwordIsUpdated === self::PASSWORD_NOT_UPDATED || count($storeRec['be_users'][$beUserId]) > 1) {

                    $this->setupIsUpdated = true;

                }

                ‪BackendUtility::setUpdateSignal('updateTopbar');

            }

        }

    }


    protected function ‪init()

    {

        $this->‪getLanguageService()->includeLLFile('EXT:setup/Resources/Private/Language/locallang.xlf');

        $backendUser = $this->‪getBackendUser();

        $this->isAdmin = $backendUser->isAdmin();

        // Getting the 'override' values as set might be set in User TSconfig

        $this->overrideConf = $backendUser->getTSConfig()['setup.']['override.'] ?? null;

        // Getting the disabled fields might be set in User TSconfig (eg setup.fields.password.disabled=1)

        $this->tsFieldConf = $backendUser->getTSConfig()['setup.']['fields.'] ?? null;

        // id password is disabled, disable repeat of password too (password2)

        if (isset($this->tsFieldConf['password.']) && $this->tsFieldConf['password.']['disabled']) {

            $this->tsFieldConf['password2.']['disabled'] = 1;

            $this->tsFieldConf['passwordCurrent.']['disabled'] = 1;

        }

    }


    protected function ‪getJavaScript()

    {

        $javaScript = '';

        foreach (‪$GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['ext/setup/mod/index.php']['setupScriptHook'] ?? [] as $function) {

            $params = [];

            $javaScript .= GeneralUtility::callUserFunction($function, $params, $this);

        }

        return $javaScript;

    }


    protected function ‪main()

    {

        $uriBuilder = GeneralUtility::makeInstance(UriBuilder::class);

        $this->content .= '<form action="' . (string)$uriBuilder->buildUriFromRoute('user_setup') . '" method="post" id="SetupModuleController" name="usersetup" enctype="multipart/form-data">';

        if ($this->languageUpdate) {

            $this->moduleTemplate->addJavaScriptCode('languageUpdate', '

                if (top && top.TYPO3.ModuleMenu.App) {

                    top.TYPO3.ModuleMenu.App.refreshMenu();

                }

                if (top && top.TYPO3.Backend.Topbar) {

                    top.TYPO3.Backend.Topbar.refresh();

                }

            ');

        }

        if ($this->pagetreeNeedsRefresh) {

            ‪BackendUtility::setUpdateSignal('updatePageTree');

        }

        // Start page:

        $this->moduleTemplate->getPageRenderer()->addJsFile('EXT:backend/Resources/Public/JavaScript/md5.js');

        // Use a wrapper div

        $this->content .= '<div id="user-setup-wrapper">';

        $this->content .= $this->moduleTemplate->header($this->‪getLanguageService()->getLL('UserSettings'));

        $this->‪addFlashMessages();


        // Render the menu items

        $menuItems = $this->‪renderUserSetup();

        $this->content .= $this->moduleTemplate->getDynamicTabMenu($menuItems, 'user-setup', 1, false, false);

        $formToken = $this->formProtection->generateToken('BE user setup', 'edit');

        $this->content .= '<div>';

        $this->content .= '<input type="hidden" name="simUser" value="' . (int)$this->simUser . '" />

            <input type="hidden" name="formToken" value="' . htmlspecialchars($formToken) . '" />

            <input type="hidden" value="1" name="data[save]" />

            <input type="hidden" name="data[setValuesToDefault]" value="0" id="setValuesToDefault" />';

        $this->content .= '</div>';

        // End of wrapper div

        $this->content .= '</div>';

        // Setting up the buttons and markers for docheader

        $this->‪getButtons();

        // Build the <body> for the module

        // Renders the module page

        $this->moduleTemplate->setContent($this->content);

        $this->content .= '</form>';

    }


    public function ‪mainAction(ServerRequestInterface $request): ResponseInterface

    {

        $this->‪init();

        $this->‪storeIncomingData();

        $this->‪main();

        return new ‪HtmlResponse($this->moduleTemplate->renderContent());

    }


    protected function ‪getButtons()

    {

        $buttonBar = $this->moduleTemplate->getDocHeaderComponent()->getButtonBar();

        $cshButton = $buttonBar->makeHelpButton()

            ->setModuleName('_MOD_user_setup')

            ->setFieldName('');

        $buttonBar->addButton($cshButton);


        $saveButton = $buttonBar->makeInputButton()

            ->setName('data[save]')

            ->setTitle($this->‪getLanguageService()->sL('LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:rm.saveDoc'))

            ->setValue('1')

            ->setForm('SetupModuleController')

            ->setShowLabelText(true)

            ->setIcon($this->moduleTemplate->getIconFactory()->getIcon('actions-document-save', ‪Icon::SIZE_SMALL));


        $buttonBar->addButton($saveButton);

        $shortcutButton = $buttonBar->makeShortcutButton()

            ->setModuleName($this->moduleName);

        $buttonBar->addButton($shortcutButton);

    }


    /******************************

     *

     * Render module

     *

     ******************************/


    protected function ‪renderUserSetup()

    {

        $backendUser = $this->‪getBackendUser();

        $html = '';

        $result = [];

        $firstTabLabel = '';

        $code = [];

        $fieldArray = $this->‪getFieldsFromShowItem();

        $tabLabel = '';

        foreach ($fieldArray as $fieldName) {

            $config = ‪$GLOBALS['TYPO3_USER_SETTINGS']['columns'][$fieldName];

            if (isset($config['access']) && !$this->‪checkAccess($config)) {

                continue;

            }


            if (strpos($fieldName, '--div--;') === 0) {

                if ($firstTabLabel === '') {

                    // First tab

                    $tabLabel = $this->‪getLabel(substr($fieldName, 8), '', false);

                    $firstTabLabel = $tabLabel;

                } else {

                    $result[] = [

                        'label' => $tabLabel,

                        'content' => count($code) ? implode(LF, $code) : ''

                    ];

                    $tabLabel = $this->‪getLabel(substr($fieldName, 8), '', false);

                    $code = [];

                }

                continue;

            }

            $label = $this->‪getLabel($config['label'], $fieldName);

            $label = $this->‪getCSH($config['csh'] ?: $fieldName, $label);

            $type = $config['type'];

            $class = $config['class'];

            if ($type !== 'check') {

                $class .= ' form-control';

            }

            $more = '';

            if ($class) {

                $more .= ' class="' . htmlspecialchars($class) . '"';

            }

            $style = $config['style'];

            if ($style) {

                $more .= ' style="' . htmlspecialchars($style) . '"';

            }

            if (isset($this->overrideConf[$fieldName])) {

                $more .= ' disabled="disabled"';

            }

            $value = $config['table'] === 'be_users' ? $backendUser->user[$fieldName] : $backendUser->uc[$fieldName];

            if (!$value && isset($config['default'])) {

                $value = $config['default'];

            }

            $dataAdd = '';

            if ($config['table'] === 'be_users') {

                $dataAdd = '[be_users]';

            }


            switch ($type) {

                case 'text':

                case 'number':

                case 'email':

                case 'password':

                    $noAutocomplete = '';


                    $maxLength = $config['max'] ?? 0;

                    if ((int)$maxLength > 0) {

                        $more .= ' maxlength="' . (int)$maxLength . '"';

                    }


                    if ($type === 'password') {

                        $value = '';

                        $noAutocomplete = 'autocomplete="new-password" ';

                        $more .= ' data-rsa-encryption=""';

                    }

                    $html = '<input id="field_' . htmlspecialchars($fieldName) . '"

                        type="' . htmlspecialchars($type) . '"

                        name="data' . $dataAdd . '[' . htmlspecialchars($fieldName) . ']" ' .

                        $noAutocomplete .

                        'value="' . htmlspecialchars($value) . '" ' .

                        $more .

                        ' />';

                    break;

                case 'check':

                    $html = $label . '<div class="checkbox"><label><input id="field_' . htmlspecialchars($fieldName) . '"

                        type="checkbox"

                        name="data' . $dataAdd . '[' . htmlspecialchars($fieldName) . ']"' .

                        ($value ? ' checked="checked"' : '') .

                        $more .

                        ' /></label></div>';

                    $label = '';

                    break;

                case 'select':

                    if ($config['itemsProcFunc']) {

                        $html = GeneralUtility::callUserFunction($config['itemsProcFunc'], $config, $this);

                    } else {

                        $html = '<select id="field_' . htmlspecialchars($fieldName) . '"

                            name="data' . $dataAdd . '[' . htmlspecialchars($fieldName) . ']"' .

                            $more . '>' . LF;

                        foreach ($config['items'] as $key => $optionLabel) {

                            $html .= '<option value="' . htmlspecialchars($key) . '"' . ($value == $key ? ' selected="selected"' : '') . '>' . $this->‪getLabel($optionLabel, '', false) . '</option>' . LF;

                        }

                        $html .= '</select>';

                    }

                    break;

                case 'user':

                    $html = GeneralUtility::callUserFunction($config['userFunc'], $config, $this);

                    break;

                case 'button':

                    if ($config['onClick']) {

                        $onClick = $config['onClick'];

                        if ($config['onClickLabels']) {

                            foreach ($config['onClickLabels'] as $key => $labelclick) {

                                $config['onClickLabels'][$key] = $this->‪getLabel($labelclick, '', false);

                            }

                            $onClick = vsprintf($onClick, $config['onClickLabels']);

                        }

                        $html = '<br><input class="btn btn-default" type="button"

                            value="' . $this->‪getLabel($config['buttonlabel'], '', false) . '"

                            onclick="' . $onClick . '" />';

                    }

                    if (!empty($config['confirm'])) {

                        $confirmData = $config['confirmData'];

                        $html = '<br><input class="btn btn-default t3js-modal-trigger" type="button"'

                            . ' value="' . $this->‪getLabel($config['buttonlabel'], '', false) . '"'

                            . ' data-href="javascript:' . htmlspecialchars($confirmData['jsCodeAfterOk']) . '"'

                            . ' data-severity="warning"'

                            . ' data-title="' . $this->‪getLabel($config['label'], '', false) . '"'

                            . ' data-content="' . $this->‪getLabel($confirmData['message'], '', false) . '" />';

                    }

                    break;

                case 'avatar':

                    // Get current avatar image

                    $html = '<br>';

                    $avatarFileUid = $this->‪getAvatarFileUid($backendUser->user['uid']);


                    if ($avatarFileUid) {

                        $defaultAvatarProvider = GeneralUtility::makeInstance(DefaultAvatarProvider::class);

                        $avatarImage = $defaultAvatarProvider->getImage($backendUser->user, 32);

                        if ($avatarImage) {

                            $icon = '<span class="avatar"><span class="avatar-image">' .

                                '<img src="' . htmlspecialchars($avatarImage->getUrl(true)) . '"' .

                                ' width="' . (int)$avatarImage->getWidth() . '" ' .

                                'height="' . (int)$avatarImage->getHeight() . '" />' .

                                '</span></span>';

                            $html .= '<span class="pull-left" style="padding-right: 10px" id="image_' . htmlspecialchars($fieldName) . '">' . $icon . ' </span>';

                        }

                    }

                    $html .= '<input id="field_' . htmlspecialchars($fieldName) . '" type="hidden" ' .

                            'name="data' . $dataAdd . '[' . htmlspecialchars($fieldName) . ']"' . $more .

                            ' value="' . (int)$avatarFileUid . '" />';


                    $html .= '<div class="btn-group">';

                    $iconFactory = GeneralUtility::makeInstance(IconFactory::class);

                    if ($avatarFileUid) {

                        $html .=

                            '<button type="button" id="clear_button_' . htmlspecialchars($fieldName) . '" aria-label="' . htmlspecialchars($this->‪getLanguageService()->getLL('avatar.clear')) . '" '

                                . 'onclick="clearExistingImage(); return false;" class="btn btn-default">'

                                . $iconFactory->getIcon('actions-delete', ‪Icon::SIZE_SMALL)

                            . '</button>';

                    }

                    $html .=

                        '<button type="button" id="add_button_' . htmlspecialchars($fieldName) . '" class="btn btn-default btn-add-avatar"'

                            . ' aria-label="' . htmlspecialchars($this->‪getLanguageService()->getLL('avatar.openFileBrowser')) . '"'

                            . ' onclick="openFileBrowser();return false;">'

                            . $iconFactory->getIcon('actions-insert-record', ‪Icon::SIZE_SMALL)

                            . '</button></div>';


                    $this->‪addAvatarButtonJs($fieldName);

                    break;

                default:

                    $html = '';

            }


            $code[] = '<div class="form-section"><div class="row"><div class="form-group t3js-formengine-field-item col-md-12">' .

                $label .

                $html .

                '</div></div></div>';

        }


        $result[] = [

            'label' => $tabLabel,

            'content' => count($code) ? implode(LF, $code) : ''

        ];

        return $result;

    }


    public function ‪renderLanguageSelect()

    {

        $backendUser = $this->‪getBackendUser();

        $language = $this->‪getLanguageService();

        $languageOptions = [];

        // Compile the languages dropdown

        $langDefault = htmlspecialchars($language->getLL('lang_default'));

        $languageOptions[$langDefault] = '<option value=""' . ($backendUser->uc['lang'] === '' ? ' selected="selected"' : '') . '>' . $langDefault . '</option>';

        if (isset(‪$GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['lang']['availableLanguages'])) {

            // Traverse the number of languages

            ‪$locales = GeneralUtility::makeInstance(Locales::class);

            $languages = ‪$locales->getLanguages();


            foreach ($languages as $locale => $name) {

                if ($locale !== 'default') {

                    $defaultName = isset(‪$GLOBALS['LOCAL_LANG']['default']['lang_' . $locale]) ? ‪$GLOBALS['LOCAL_LANG']['default']['lang_' . $locale][0]['source'] : $name;

                    $localizedName = htmlspecialchars($language->getLL('lang_' . $locale));

                    if ($localizedName === '') {

                        $localizedName = htmlspecialchars($name);

                    }

                    $localLabel = '  -  [' . htmlspecialchars($defaultName) . ']';

                    $available = in_array($locale, ‪$GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['lang']['availableLanguages'], true) || is_dir(‪Environment::getLabelsPath() . '/' . $locale);

                    if ($available) {

                        $languageOptions[$defaultName] = '<option value="' . $locale . '"' . ($backendUser->uc['lang'] === $locale ? ' selected="selected"' : '') . '>' . $localizedName . $localLabel . '</option>';

                    }

                }

            }

        }

        ksort($languageOptions);

        $languageCode = '

            <select id="field_lang" name="data[lang]" class="form-control">' . implode('', $languageOptions) . '

            </select>';

        if ($backendUser->uc['lang'] && !@is_dir(‪Environment::getLabelsPath() . '/' . $backendUser->uc['lang'])) {

            // TODO: The text constants have to be moved into language files

            $languageUnavailableWarning = 'The selected language "' . htmlspecialchars($language->getLL('lang_' . $backendUser->uc['lang'])) . '" is not available before the language files are installed.&nbsp;&nbsp;<br />&nbsp;&nbsp;' . ($backendUser->isAdmin() ? 'You can use the Language module to easily download new language files.' : 'Please ask your system administrator to do this.');

            $languageCode = '<br /><span class="label label-danger">' . $languageUnavailableWarning . '</span><br /><br />' . $languageCode;

        }

        return $languageCode;

    }


    public function ‪renderStartModuleSelect()

    {

        // Load available backend modules

        $backendUser = $this->‪getBackendUser();

        $language = $this->‪getLanguageService();

        $loadModules = GeneralUtility::makeInstance(ModuleLoader::class);

        $loadModules->observeWorkspaces = true;

        $loadModules->load(‪$GLOBALS['TBE_MODULES']);

        $startModuleSelect = '<option value="">' . htmlspecialchars($language->getLL('startModule.firstInMenu')) . '</option>';

        foreach ($loadModules->modules as $mainMod => $modData) {

            if (!empty($modData['sub']) && is_array($modData['sub'])) {

                $modules = '';

                foreach ($modData['sub'] as $subData) {

                    $modName = $subData['name'];

                    $modules .= '<option value="' . htmlspecialchars($modName) . '"';

                    $modules .= $backendUser->uc['startModule'] === $modName ? ' selected="selected"' : '';

                    $modules .= '>' . htmlspecialchars($language->sL($loadModules->getLabelsForModule($modName)['title'])) . '</option>';

                }

                $groupLabel = htmlspecialchars($language->sL($loadModules->getLabelsForModule($mainMod)['title']));

                $startModuleSelect .= '<optgroup label="' . htmlspecialchars($groupLabel) . '">' . $modules . '</optgroup>';

            }

        }

        return '<select id="field_startModule" name="data[startModule]" class="form-control">' . $startModuleSelect . '</select>';

    }


    public function ‪simulateUser()

    {

        trigger_error('SetupModuleController->simulateUser() will be removed in TYPO3 v10.0.', E_USER_DEPRECATED);

        // If admin, allow simulation of another user

        $this->simUser = 0;

        $this->simulateSelector = '';

        unset($this->OLD_BE_USER);

        $currentBeUser = $this->‪getBackendUser();

        if ($currentBeUser->isAdmin()) {

            $this->simUser = (int)GeneralUtility::_GP('simUser');

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

            $users = $queryBuilder

                ->select('*')

                ->from('be_users')

                ->where(

                    $queryBuilder->expr()->neq(

                        'uid',

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

                    ),

                    $queryBuilder->expr()->notLike(

                        'username',

                        $queryBuilder->createNamedParameter(

                            $queryBuilder->escapeLikeWildcards('_cli_') . '%',

                            \PDO::PARAM_STR

                        )

                    )

                )

                ->orderBy('username')

                ->execute()

                ->fetchAll();

            $opt = [];

            foreach ($users as $rr) {

                $label = $rr['username'] . ($rr['realName'] ? ' (' . $rr['realName'] . ')' : '');

                $opt[] = '<option value="' . (int)$rr['uid'] . '"' . ($this->simUser === (int)$rr['uid'] ? ' selected="selected"' : '') . '>' . htmlspecialchars($label) . '</option>';

            }

            if (!empty($opt)) {

                $uriBuilder = GeneralUtility::makeInstance(UriBuilder::class);

                $this->simulateSelector = '<select id="field_simulate" class="form-control" name="simulateUser" onchange="window.location.href=' . GeneralUtility::quoteJSvalue((string)$uriBuilder->buildUriFromRoute('user_setup') . '&simUser=') . '+this.options[this.selectedIndex].value;"><option></option>' . implode('', $opt) . '</select>';

            }

        }

        // This can only be set if the previous code was executed.

        if ($this->simUser > 0) {

            // Save old user...

            $this->OLD_BE_USER = $currentBeUser;

            // Unset current

            // New backend user object

            $currentBeUser = GeneralUtility::makeInstance(BackendUserAuthentication::class);

            $currentBeUser->setBeUserByUid($this->simUser);

            $currentBeUser->fetchGroupData();

            $currentBeUser->backendSetUC();

        }

    }


    protected function ‪checkAccess(array $config)

    {

        $access = $config['access'];


        if (isset(‪$GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['setup']['accessLevelCheck'][$access])) {

            if (class_exists($access)) {

                $accessObject = GeneralUtility::makeInstance($access);

                if (method_exists($accessObject, 'accessLevelCheck')) {

                    // Initialize vars. If method fails, $set will be set to FALSE

                    return $accessObject->accessLevelCheck($config);

                }

            }

        } elseif ($access === 'admin') {

            return ‪$this->isAdmin;

        }


        return false;

    }


    protected function ‪getLabel($str, $key = '', $addLabelTag = true)

    {

        if (strpos($str, 'LLL:') === 0) {

            $out = htmlspecialchars($this->‪getLanguageService()->sL($str));

        } else {

            $out = htmlspecialchars($str);

        }

        if (isset($this->overrideConf[$key ?: $str])) {

            $out = '<span style="color:#999999">' . $out . '</span>';

        }

        if ($addLabelTag) {

            $out = '<label>' . $out . '</label>';

        }

        return $out;

    }


    protected function ‪getCSH($str, $label)

    {

        $context = '_MOD_user_setup';

        $field = $str;

        $strParts = explode(':', $str);

        if (count($strParts) > 1) {

            // Setting comes from another extension

            $context = $strParts[0];

            $field = $strParts[1];

        } elseif ($str !== 'language' && $str !== 'simuser' && $str !== 'reset') {

            $field = 'option_' . $str;

        }

        return ‪BackendUtility::wrapInHelp($context, $field, $label);

    }


    protected function ‪getFieldsFromShowItem()

    {

        $allowedFields = GeneralUtility::trimExplode(',', ‪$GLOBALS['TYPO3_USER_SETTINGS']['showitem'], true);

        if ($this->isAdmin) {

            // Do not ask for current password if admin (unknown for other users and no security gain)

            $key = array_search('passwordCurrent', $allowedFields);

            if ($key !== false) {

                unset($allowedFields[$key]);

            }

        }


        $backendUser = $this->‪getBackendUser();

        $systemMaintainers = array_map('intval', ‪$GLOBALS['TYPO3_CONF_VARS']['SYS']['systemMaintainers'] ?? []);

        $isCurrentUserInSystemMaintainerList = in_array((int)$backendUser->user['uid'], $systemMaintainers, true);

        $isInSimulateUserMode = (int)$backendUser->user['ses_backuserid'] !== 0;

        if ($isInSimulateUserMode && $isCurrentUserInSystemMaintainerList) {

            // DataHandler denies changing password of system maintainer users in switch user mode.

            // Do not show the password fields is this case.

            $key = array_search('password', $allowedFields);

            if ($key !== false) {

                unset($allowedFields[$key]);

            }

            $key = array_search('password2', $allowedFields);

            if ($key !== false) {

                unset($allowedFields[$key]);

            }

        }


        if (!is_array($this->tsFieldConf)) {

            return $allowedFields;

        }

        foreach ($this->tsFieldConf as $fieldName => $userTsFieldConfig) {

            if (!empty($userTsFieldConfig['disabled'])) {

                $fieldName = rtrim($fieldName, '.');

                $key = array_search($fieldName, $allowedFields);

                if ($key !== false) {

                    unset($allowedFields[$key]);

                }

            }

        }

        return $allowedFields;

    }


    protected function ‪getAvatarFileUid($beUserId)

    {

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

        $file = $queryBuilder

            ->select('uid_local')

            ->from('sys_file_reference')

            ->where(

                $queryBuilder->expr()->eq(

                    'tablenames',

                    $queryBuilder->createNamedParameter('be_users', \PDO::PARAM_STR)

                ),

                $queryBuilder->expr()->eq(

                    'fieldname',

                    $queryBuilder->createNamedParameter('avatar', \PDO::PARAM_STR)

                ),

                $queryBuilder->expr()->eq(

                    'table_local',

                    $queryBuilder->createNamedParameter('sys_file', \PDO::PARAM_STR)

                ),

                $queryBuilder->expr()->eq(

                    'uid_foreign',

                    $queryBuilder->createNamedParameter($beUserId, \PDO::PARAM_INT)

                )

            )

            ->execute()

            ->fetchColumn();

        return (int)$file;

    }


    protected function ‪setAvatarFileUid($beUserId, $fileUid, array &$storeRec)

    {


        // Update is only needed when new fileUid is set

        if ((int)$fileUid === $this->‪getAvatarFileUid($beUserId)) {

            return;

        }


        // If user is not allowed to modify avatar $fileUid is empty - so don't overwrite existing avatar

        if (empty($fileUid)) {

            return;

        }


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

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

        $queryBuilder

            ->delete('sys_file_reference')

            ->where(

                $queryBuilder->expr()->eq(

                    'tablenames',

                    $queryBuilder->createNamedParameter('be_users', \PDO::PARAM_STR)

                ),

                $queryBuilder->expr()->eq(

                    'fieldname',

                    $queryBuilder->createNamedParameter('avatar', \PDO::PARAM_STR)

                ),

                $queryBuilder->expr()->eq(

                    'table_local',

                    $queryBuilder->createNamedParameter('sys_file', \PDO::PARAM_STR)

                ),

                $queryBuilder->expr()->eq(

                    'uid_foreign',

                    $queryBuilder->createNamedParameter($beUserId, \PDO::PARAM_INT)

                )

            )

            ->execute();


        // If Avatar is marked for delete => set it to empty string so it will be updated properly

        if ($fileUid === 'delete') {

            $fileUid = '';

        }


        // Create new reference

        if ($fileUid) {


            // Get file object

            try {

                $file = ‪ResourceFactory::getInstance()->‪getFileObject($fileUid);

            } catch (FileDoesNotExistException $e) {

                $file = false;

            }


            // Check if user is allowed to use the image (only when not in simulation mode)

            if ($file && $this->simUser === 0 && !$file->getStorage()->checkFileActionPermission('read', $file)) {

                $file = false;

            }


            // Check if extension is allowed

            if ($file && GeneralUtility::inList(‪$GLOBALS['TYPO3_CONF_VARS']['GFX']['imagefile_ext'], $file->getExtension())) {


                // Create new file reference

                $storeRec['sys_file_reference']['NEW1234'] = [

                    'uid_local' => (int)$fileUid,

                    'uid_foreign' => (int)$beUserId,

                    'tablenames' => 'be_users',

                    'fieldname' => 'avatar',

                    'pid' => 0,

                    'table_local' => 'sys_file',

                ];

                $storeRec['be_users'][(int)$beUserId]['avatar'] = 'NEW1234';

            }

        }

    }


    protected function ‪addAvatarButtonJs($fieldName)

    {

        $uriBuilder = GeneralUtility::makeInstance(UriBuilder::class);

        $this->moduleTemplate->addJavaScriptCode('avatar-button', '

            var browserWin="";


            function openFileBrowser() {

                var url = ' . GeneralUtility::quoteJSvalue((string)$uriBuilder->buildUriFromRoute('wizard_element_browser', ['mode' => 'file', 'bparams' => '||||dummy|setFileUid'])) . ';

                browserWin = window.open(url,"Typo3WinBrowser","height=650,width=800,status=0,menubar=0,resizable=1,scrollbars=1");

                browserWin.focus();

            }


            function clearExistingImage() {

                $(' . GeneralUtility::quoteJSvalue('#image_' . htmlspecialchars($fieldName)) . ').hide();

                $(' . GeneralUtility::quoteJSvalue('#clear_button_' . htmlspecialchars($fieldName)) . ').hide();

                $(' . GeneralUtility::quoteJSvalue('#field_' . htmlspecialchars($fieldName)) . ').val(\'delete\');

            }


            function setFileUid(field, value, fileUid) {

                clearExistingImage();

                $(' . GeneralUtility::quoteJSvalue('#field_' . htmlspecialchars($fieldName)) . ').val(fileUid);

                $(' . GeneralUtility::quoteJSvalue('#add_button_' . htmlspecialchars($fieldName)) . ').removeClass(\'btn-default\').addClass(\'btn-info\');


                browserWin.close();

            }

        ');

    }


    protected function ‪getBackendUser()

    {

        return ‪$GLOBALS['BE_USER'];

    }


    protected function ‪getLanguageService()

    {

        return ‪$GLOBALS['LANG'];

    }


    protected function ‪addFlashMessages()

    {

        $flashMessages = [];


        // Show if setup was saved

        if ($this->setupIsUpdated && !$this->settingsAreResetToDefault) {

            $flashMessages[] = $this->‪getFlashMessage('setupWasUpdated', 'UserSettings');

        }


        // Show if temporary data was cleared

        if ($this->settingsAreResetToDefault) {

            $flashMessages[] = $this->‪getFlashMessage('settingsAreReset', 'resetConfiguration');

        }


        // Notice

        if ($this->setupIsUpdated || $this->settingsAreResetToDefault) {

            $flashMessages[] = $this->‪getFlashMessage('activateChanges', '', ‪FlashMessage::INFO);

        }


        // If password is updated, output whether it failed or was OK.

        if ($this->passwordIsSubmitted) {

            switch ($this->passwordIsUpdated) {

                case ‪self::PASSWORD_OLD_WRONG:

                    $flashMessages[] = $this->‪getFlashMessage('oldPassword_failed', 'newPassword', ‪FlashMessage::ERROR);

                    break;

                case ‪self::PASSWORD_NOT_THE_SAME:

                    $flashMessages[] = $this->‪getFlashMessage('newPassword_failed', 'newPassword', ‪FlashMessage::ERROR);

                    break;

                case ‪self::PASSWORD_UPDATED:

                    $flashMessages[] = $this->‪getFlashMessage('newPassword_ok', 'newPassword');

                    break;

            }

        }

        if (!empty($flashMessages)) {

            $this->‪enqueueFlashMessages($flashMessages);

        }

    }


    protected function ‪enqueueFlashMessages(array $flashMessages)

    {

        $flashMessageService = GeneralUtility::makeInstance(FlashMessageService::class);

        $defaultFlashMessageQueue = $flashMessageService->getMessageQueueByIdentifier();

        foreach ($flashMessages as $flashMessage) {

            $defaultFlashMessageQueue->enqueue($flashMessage);

        }

    }


    protected function ‪getFlashMessage($message, $title, $severity = ‪FlashMessage::OK)

    {

        $title = !empty($title) ? $this->‪getLanguageService()->getLL($title) : ' ';

        return GeneralUtility::makeInstance(

            FlashMessage::class,

            $this->‪getLanguageService()->getLL($message),

            $title,

            $severity

        );

    }

}