10.4/_file_system_navigation_frame_controller_8php_source.html

<?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\Backend\Controller;


use Psr\Http\Message\ResponseInterface;

use Psr\Http\Message\ServerRequestInterface;

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

use ‪TYPO3\CMS\Backend\Template\Components\ButtonBar;

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

use ‪TYPO3\CMS\Backend\Tree\View\ElementBrowserFolderTreeView;

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

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

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

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

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

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

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

use ‪TYPO3\CMS\Filelist\FileListFolderTree;

use ‪TYPO3\CMS\Recordlist\Tree\View\DummyLinkParameterProvider;


class ‪FileSystemNavigationFrameController

{

    protected ‪$content;


    protected ‪$foldertree;


    protected ‪$currentSubScript;


    protected ‪$cMR;


    protected ‪$scopeData;


    protected ‪$moduleTemplate;


    public function ‪mainAction(ServerRequestInterface $request): ResponseInterface

    {

        $this->‪init($request);

        $this->‪initializePageTemplate();

        $this->‪renderFolderTree($request);

        return new ‪HtmlResponse($this->content);

    }


    public function ‪ajaxExpandCollapse(ServerRequestInterface $request): ResponseInterface

    {

        $this->‪init($request);

        $tree = $this->foldertree->getBrowsableTree();

        if ($this->foldertree->getAjaxStatus() === false) {

            return new ‪JsonResponse(null, 500);

        }

        return new JsonResponse([$tree]);

    }


    protected function ‪init(ServerRequestInterface $request)

    {

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


        $parsedBody = $request->getParsedBody();

        $queryParams = $request->getQueryParams();


        $this->currentSubScript = $parsedBody['currentSubScript'] ?? $queryParams['currentSubScript'] ?? null;

        $this->cMR = (bool)($parsedBody['cMR'] ?? $queryParams['cMR'] ?? false);

        ‪$scopeData = $parsedBody['scopeData'] ?? $queryParams['scopeData'] ?? '';

        $scopeHash = $parsedBody['scopeHash'] ?? $queryParams['scopeHash'] ?? '';


        if (!empty(‪$scopeData) && hash_equals(GeneralUtility::hmac(‪$scopeData), $scopeHash)) {

            $this->scopeData = json_decode(‪$scopeData, true);

        }


        // Create folder tree object:

        if (!empty($this->scopeData)) {

            $this->foldertree = GeneralUtility::makeInstance($this->scopeData['class']);

            $this->foldertree->thisScript = $this->scopeData['script'];

            if ($this->foldertree instanceof ‪ElementBrowserFolderTreeView) {

                // create a fake provider to pass link data along properly

                $linkParamProvider = GeneralUtility::makeInstance(

                    DummyLinkParameterProvider::class,

                    $this->scopeData['browser'],

                    $this->scopeData['script']

                );

                $this->foldertree->setLinkParameterProvider($linkParamProvider);

            }

        } else {

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

            $this->foldertree = GeneralUtility::makeInstance(FileListFolderTree::class);

            $this->foldertree->thisScript = (string)$uriBuilder->buildUriFromRoute('file_navframe');

        }

    }


    protected function ‪initializePageTemplate(): void

    {

        $this->moduleTemplate->setBodyTag('<body id="ext-backend-Modules-FileSystemNavigationFrame-index-php">');


        // Adding javascript code for drag&drop and the file tree as well as the click menu code

        $hlClass = $this->‪getBackendUser()->workspace === 0 ? 'active' : 'active active-ws wsver' . ‪$GLOBALS['BE_USER']->workspace;

        $dragDropCode = '

            Tree.highlightClass = "' . $hlClass . '";

            Tree.highlightActiveItem("", top.fsMod.navFrameHighlightedID["file"]);

        ';


        // Adding javascript for drag & drop activation and highlighting

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

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

        $pageRenderer->loadRequireJsModule('TYPO3/CMS/Backend/BroadcastService', 'function(service) { service.listen(); }');

        $pageRenderer->loadRequireJsModule('TYPO3/CMS/Backend/LegacyTree', 'function() {

            DragDrop.table = "folders";

            Tree.registerDragDropHandlers();

            ' . $dragDropCode . '

        }');


        // Setting JavaScript for menu.

        $inlineJs = ($this->currentSubScript ? 'top.currentSubScript=unescape("' . rawurlencode($this->currentSubScript) . '");' : '') . '

        // Function, loading the list frame from navigation tree:

        function jumpTo(id, linkObj, highlightID, bank) {

            var theUrl = top.currentSubScript;

            if (theUrl.indexOf("?") != -1) {

                theUrl += "&id=" + id

            } else {

                theUrl += "?id=" + id

            }

            top.fsMod.currentBank = bank;

            top.TYPO3.Backend.ContentContainer.setUrl(theUrl);


            Tree.highlightActiveItem("file", highlightID + "_" + bank);

            if (linkObj) { linkObj.blur(); }

            return false;

        }

        ' . ($this->cMR ? ' jumpTo(top.fsMod.recentIds[\'file\'],\'\');' : '');


        $this->moduleTemplate->getPageRenderer()->addJsInlineCode(

            'FileSystemNavigationFrame',

            $inlineJs

        );

    }


    protected function ‪renderFolderTree(ServerRequestInterface $request): void

    {

        // Produce browse-tree:

        $tree = $this->foldertree->getBrowsableTree();

        // Outputting page tree:

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

        // Setting up the buttons

        $this->‪getButtons($request);

        // Build the <body> for the module

        $this->moduleTemplate->setTitle('TYPO3 Folder Tree');

        $this->content = $this->moduleTemplate->renderContent();

    }


    protected function ‪getButtons(ServerRequestInterface $request): void

    {

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

        $iconFactory = $this->moduleTemplate->getIconFactory();

        $normalizedParams = $request->getAttribute('normalizedParams');


        // Refresh

        $refreshButton = $buttonBar->makeLinkButton()

            ->setHref($normalizedParams->getRequestUri())

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

            ->setIcon($iconFactory->getIcon('actions-refresh', ‪Icon::SIZE_SMALL));

        $buttonBar->addButton($refreshButton, ‪ButtonBar::BUTTON_POSITION_RIGHT);


        // CSH

        $cshButton = $buttonBar->makeHelpButton()

            ->setModuleName('xMOD_csh_corebe')

            ->setFieldName('filetree');

        $buttonBar->addButton($cshButton);

    }


    protected function ‪getBackendUser(): ‪BackendUserAuthentication

    {

        return ‪$GLOBALS['BE_USER'];

    }


    protected function ‪getLanguageService(): ‪LanguageService

    {

        return ‪$GLOBALS['LANG'];

    }

}