9.5/_create_folder_controller_8php_source.html

<?php

declare(strict_types = 1);

namespace ‪TYPO3\CMS\Backend\Controller\File;


/*

 * 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\Routing\UriBuilder;

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

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

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

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

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

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

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

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

use ‪TYPO3\CMS\Core\Resource\OnlineMedia\Helpers\OnlineMediaHelperRegistry;

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

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

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

use ‪TYPO3\CMS\Fluid\View\StandaloneView;


class ‪CreateFolderController

{

    use ‪PublicMethodDeprecationTrait;

    use ‪PublicPropertyDeprecationTrait;


    private ‪$deprecatedPublicMethods = [

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

    ];


    private ‪$deprecatedPublicProperties = [

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

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

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

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

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

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

    ];


    protected ‪$folderNumber = 10;


    protected ‪$title;


    protected ‪$number;


    protected ‪$target;


    protected ‪$folderObject;


    protected ‪$returnUrl;


    protected ‪$pathInfo;


    protected ‪$content;


    protected ‪$moduleTemplate;


    public function ‪__construct()

    {

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

        // @deprecated since TYPO3 v9, will be moved out of __construct() in TYPO3 v10.0

        $this->‪init(‪$GLOBALS['TYPO3_REQUEST']);

    }


    public function ‪mainAction(ServerRequestInterface $request): ResponseInterface

    {

        $this->‪main();

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

    }


    protected function ‪init(ServerRequestInterface $request): void

    {

        $parsedBody = $request->getParsedBody();

        $queryParams = $request->getQueryParams();


        $this->number = $parsedBody['number'] ?? $queryParams['number'] ?? 0;

        $this->target = ($combinedIdentifier = $parsedBody['target'] ?? $queryParams['target'] ?? '');

        $this->returnUrl = GeneralUtility::sanitizeLocalUrl($parsedBody['returnUrl'] ?? $queryParams['returnUrl'] ?? '');

        // create the folder object

        if ($combinedIdentifier) {

            $this->folderObject = ‪ResourceFactory::getInstance()

                ->‪getFolderObjectFromCombinedIdentifier($combinedIdentifier);

        }

        // Cleaning and checking target directory

        if (!$this->folderObject) {

            ‪$title = $this->‪getLanguageService()->‪sL('LLL:EXT:filelist/Resources/Private/Language/locallang_mod_file_list.xlf:paramError');

            $message = $this->‪getLanguageService()->‪sL('LLL:EXT:filelist/Resources/Private/Language/locallang_mod_file_list.xlf:targetNoDir');

            throw new \RuntimeException(‪$title . ': ' . $message, 1294586845);

        }

        if ($this->folderObject->getStorage()->getUid() === 0) {

            throw new InsufficientFolderAccessPermissionsException(

                'You are not allowed to access folders outside your storages',

                1375889838

            );

        }


        ‪$pathInfo = [

            'combined_identifier' => $this->folderObject->getCombinedIdentifier(),

        ];

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


        $this->moduleTemplate->getDocHeaderComponent()->setMetaInformation(‪$pathInfo);

        $this->moduleTemplate->getPageRenderer()->loadRequireJsModule('TYPO3/CMS/Backend/ContextMenu');

        $this->moduleTemplate->addJavaScriptCode(

            'CreateFolderInlineJavaScript',

            'var path = "' . $this->target . '";

            var confirmTitle = '

            . GeneralUtility::quoteJSvalue(

                $this->‪getLanguageService()->sL('LLL:EXT:core/Resources/Private/Language/locallang_common.xlf:pleaseConfirm')

            )

            . ';

            var confirmText = '

            . GeneralUtility::quoteJSvalue(

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

            )

            . ';

            function reload(a) {

                var params = "&target="+encodeURIComponent(path)+"&number="+a+"&returnUrl=' . rawurlencode($this->returnUrl) . '";

                var url = \'' . (string)$uriBuilder->buildUriFromRoute('file_newfolder') . '\';

                if (!changed) {

                    window.location.href = url + params;

                } else {

                    var modal = top.TYPO3.Modal.confirm(confirmTitle, confirmText);

                    modal.on(\'confirm.button.cancel\', function(e) {

                        top.TYPO3.Modal.currentModal.trigger(\'modal-dismiss\');

                    });

                    modal.on(\'confirm.button.ok\', function(e) {

                        top.TYPO3.Modal.currentModal.trigger(\'modal-dismiss\');

                        window.location.href = url + params;

                    });

                }

            }

            function backToList() {

                top.goToModule("file_FilelistList");

            }

            var changed = 0;'

        );

    }


    protected function ‪main()

    {

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

        $assigns = [];

        $assigns['target'] = ‪$this->target;

        if ($this->folderObject->checkActionPermission('add')) {

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

            $assigns['moduleUrlTceFile'] = (string)$uriBuilder->buildUriFromRoute('tce_file');

            $assigns['cshFileNewFolder'] = ‪BackendUtility::cshItem('xMOD_csh_corebe', 'file_newfolder');

            // Making the selector box for the number of concurrent folder-creations

            $this->number = ‪MathUtility::forceIntegerInRange($this->number, 1, 10);

            for ($a = 1; $a <= ‪$this->folderNumber; $a++) {

                $options = [];

                $options['value'] = $a;

                $options['selected'] = ($this->number == $a ? ' selected="selected"' : '');

                $assigns['options'][] = $options;

            }

            // Making the number of new-folder boxes needed:

            for ($a = 0; $a < ‪$this->number; $a++) {

                $folder = [];

                $folder['this'] = $a;

                $folder['next'] = $a + 1;

                $assigns['folders'][] = $folder;

            }

            // Making submit button for folder creation:

            $assigns['returnUrl'] = ‪$this->returnUrl;

        }


        if ($this->folderObject->getStorage()->checkUserActionPermission('add', 'File')) {

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

            $assigns['moduleUrlOnlineMedia'] = (string)$uriBuilder->buildUriFromRoute('online_media');

            $assigns['cshFileNewMedia'] = ‪BackendUtility::cshItem('xMOD_csh_corebe', 'file_newMedia');

            // Create a list of allowed file extensions with the readable format "youtube, vimeo" etc.

            $fileExtList = [];

            $onlineMediaFileExt = ‪OnlineMediaHelperRegistry::getInstance()->‪getSupportedFileExtensions();

            foreach ($onlineMediaFileExt as $fileExt) {

                if (GeneralUtility::verifyFilenameAgainstDenyPattern('.' . $fileExt)) {

                    $fileExtList[] = strtoupper(htmlspecialchars($fileExt));

                }

            }

            $assigns['fileExtList'] = $fileExtList;


            $assigns['moduleUrlTceFile'] = (string)$uriBuilder->buildUriFromRoute('tce_file');

            $assigns['cshFileNewFile'] = ‪BackendUtility::cshItem('xMOD_csh_corebe', 'file_newfile');

            // Create a list of allowed file extensions with a text format "*.txt, *.css" etc.

            $fileExtList = [];

            $textFileExt = GeneralUtility::trimExplode(',', ‪$GLOBALS['TYPO3_CONF_VARS']['SYS']['textfile_ext'], true);

            foreach ($textFileExt as $fileExt) {

                if (GeneralUtility::verifyFilenameAgainstDenyPattern('.' . $fileExt)) {

                    $fileExtList[] = strtoupper(htmlspecialchars($fileExt));

                }

            }

            $assigns['txtFileExtList'] = $fileExtList;

        }


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

        // CSH button

        $helpButton = $buttonBar->makeHelpButton()

            ->setFieldName('file_new')

            ->setModuleName('xMOD_csh_corebe');

        $buttonBar->addButton($helpButton);


        // Back

        if ($this->returnUrl) {

            $backButton = $buttonBar->makeLinkButton()

                ->setHref($this->returnUrl)

                ->setTitle($lang->sL('LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:labels.goBack'))

                ->setIcon($this->moduleTemplate->getIconFactory()->getIcon('actions-view-go-back', ‪Icon::SIZE_SMALL));

            $buttonBar->addButton($backButton);

        }


        // Rendering of the output via fluid

        $view = GeneralUtility::makeInstance(StandaloneView::class);

        $view->setTemplateRootPaths([GeneralUtility::getFileAbsFileName('EXT:backend/Resources/Private/Templates')]);

        $view->setPartialRootPaths([GeneralUtility::getFileAbsFileName('EXT:backend/Resources/Private/Partials')]);

        $view->setTemplatePathAndFilename(GeneralUtility::getFileAbsFileName(

            'EXT:backend/Resources/Private/Templates/File/CreateFolder.html'

        ));

        $view->assignMultiple($assigns);

        $this->moduleTemplate->setContent($view->render());

    }


    protected function ‪getLanguageService(): ‪LanguageService

    {

        return ‪$GLOBALS['LANG'];

    }

}