9.5/_file_browser_8php_source.html

<?php

namespace ‪TYPO3\CMS\Recordlist\Browser;


/*

 * 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\Backend\Tree\View\ElementBrowserFolderTreeView;

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

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

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

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

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

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

use ‪TYPO3\CMS\Core\Resource\Filter\FileExtensionFilter;

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

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

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

use ‪TYPO3\CMS\Core\Resource\Search\FileSearchDemand;

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

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

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

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

use ‪TYPO3\CMS\Recordlist\View\FolderUtilityRenderer;


class ‪FileBrowser extends ‪AbstractElementBrowser implements ‪ElementBrowserInterface, ‪LinkParameterProviderInterface

{

    protected ‪$expandFolder;


    protected ‪$selectedFolder;


    protected ‪$elements = [];


    protected ‪$searchWord;


    protected ‪$fileRepository;


    protected ‪$thumbnailConfiguration = [];


    protected function ‪initialize()

    {

        parent::initialize();

        $this->pageRenderer->loadRequireJsModule('TYPO3/CMS/Recordlist/BrowseFiles');

        $this->fileRepository = GeneralUtility::makeInstance(FileRepository::class);


        $thumbnailConfig = $this->‪getBackendUser()->‪getTSConfig()['options.']['file_list.']['thumbnail.'] ?? [];

        if (isset($thumbnailConfig['width']) && ‪MathUtility::canBeInterpretedAsInteger($thumbnailConfig['width'])) {

            $this->thumbnailConfiguration['width'] = (int)$thumbnailConfig['width'];

        }

        if (isset($thumbnailConfig['height']) && ‪MathUtility::canBeInterpretedAsInteger($thumbnailConfig['height'])) {

            $this->thumbnailConfiguration['height'] = (int)$thumbnailConfig['height'];

        }

    }


    protected function ‪initVariables()

    {

        parent::initVariables();

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

        $this->searchWord = (string)GeneralUtility::_GP('searchWord');

    }


    public function ‪processSessionData($data)

    {

        if ($this->expandFolder !== null) {

            $data['expandFolder'] = ‪$this->expandFolder;

            $store = true;

        } else {

            $this->expandFolder = $data['expandFolder'];

            $store = false;

        }

        return [$data, $store];

    }


    public function ‪render()

    {

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


        // The key number 3 of the bparams contains the "allowed" string. Disallowed is not passed to

        // the element browser at all but only filtered out in DataHandler afterwards

        $allowedFileExtensions = GeneralUtility::trimExplode(',', explode('|', $this->bparams)[3], true);

        if (!empty($allowedFileExtensions) && $allowedFileExtensions[0] !== 'sys_file' && $allowedFileExtensions[0] !== '*') {

            // Create new filter object

            $filterObject = GeneralUtility::makeInstance(FileExtensionFilter::class);

            $filterObject->setAllowedFileExtensions($allowedFileExtensions);

            // Set file extension filters on all storages

            $storages = $backendUser->getFileStorages();

            foreach ($storages as $storage) {

                $storage->addFileAndFolderNameFilter([$filterObject, 'filterFileList']);

            }

        }

        if ($this->expandFolder) {

            $fileOrFolderObject = null;


            // Try to fetch the folder the user had open the last time he browsed files

            // Fallback to the default folder in case the last used folder is not existing

            try {

                $fileOrFolderObject = ‪ResourceFactory::getInstance()->‪retrieveFileOrFolderObject($this->expandFolder);

            } catch (Exception $accessException) {

                // We're just catching the exception here, nothing to be done if folder does not exist or is not accessible.

            } catch (\InvalidArgumentException $driverMissingExecption) {

                // We're just catching the exception here, nothing to be done if the driver does not exist anymore.

            }


            if ($fileOrFolderObject instanceof Folder) {

                // It's a folder

                $this->selectedFolder = $fileOrFolderObject;

            } elseif ($fileOrFolderObject instanceof FileInterface) {

                // It's a file

                $this->selectedFolder = $fileOrFolderObject->‪getParentFolder();

            }

        }

        // Or get the user's default upload folder

        if (!$this->selectedFolder) {

            try {

                [, $pid, $table,, $field] = explode('-', explode('|', $this->bparams)[4]);

                $this->selectedFolder = $backendUser->getDefaultUploadFolder($pid, $table, $field);

            } catch (\Exception $e) {

                // The configured default user folder does not exist

            }

        }

        // Build the file upload and folder creation form

        $uploadForm = '';

        $createFolder = '';

        if ($this->selectedFolder) {

            $folderUtilityRenderer = GeneralUtility::makeInstance(FolderUtilityRenderer::class, $this);

            $uploadForm = $folderUtilityRenderer->uploadForm($this->selectedFolder, $allowedFileExtensions);

            $createFolder = $folderUtilityRenderer->createFolder($this->selectedFolder);

        }


        // Getting flag for showing/not showing thumbnails:

        $noThumbs = $backendUser->getTSConfig()['options.']['noThumbsInEB'] ?? false;

        $_MOD_SETTINGS = [];

        if (!$noThumbs) {

            // MENU-ITEMS, fetching the setting for thumbnails from File>List module:

            $_MOD_MENU = ['displayThumbs' => ''];

            $_MCONF['name'] = 'file_list';

            $_MOD_SETTINGS = ‪BackendUtility::getModuleData($_MOD_MENU, GeneralUtility::_GP('SET'), $_MCONF['name']);

        }

        $displayThumbs = $_MOD_SETTINGS['displayThumbs'] ?? false;

        $noThumbs = $noThumbs ?: !$displayThumbs;

        // Create folder tree:

        $folderTree = GeneralUtility::makeInstance(ElementBrowserFolderTreeView::class);

        $folderTree->setLinkParameterProvider($this);

        $tree = $folderTree->getBrowsableTree();

        if ($this->selectedFolder) {

            $files = $this->‪renderFilesInFolder($this->selectedFolder, $allowedFileExtensions, $noThumbs);

        } else {

            $files = '';

        }


        $this->‪initDocumentTemplate();

        // Starting content:

        $content = $this->doc->startPage(htmlspecialchars($this->‪getLanguageService()->getLL('fileSelector')));


        // Putting the parts together, side by side:

        $markup = [];

        $markup[] = '<!-- Wrapper table for folder tree / filelist: -->';

        $markup[] = '<div class="element-browser">';

        $markup[] = '   <div class="element-browser-panel element-browser-main">';

        $markup[] = '       <div class="element-browser-main-sidebar">';

        $markup[] = '           <div class="element-browser-body">';

        $markup[] = '               ' . $tree;

        $markup[] = '           </div>';

        $markup[] = '       </div>';

        $markup[] = '       <div class="element-browser-main-content">';

        $markup[] = '           <div class="element-browser-body">';

        $markup[] = '               ' . $this->doc->getFlashMessages();

        $markup[] = '               ' . $files;

        $markup[] = '               ' . $uploadForm;

        $markup[] = '               ' . $createFolder;

        $markup[] = '           </div>';

        $markup[] = '       </div>';

        $markup[] = '   </div>';

        $markup[] = '</div>';

        $content .= implode('', $markup);


        // Ending page, returning content:

        $content .= $this->doc->endPage();

        return $this->doc->insertStylesAndJS($content);

    }


    public function ‪renderFilesInFolder(Folder $folder, array $extensionList = [], $noThumbs = false)

    {

        if (!$folder->checkActionPermission('read')) {

            return '';

        }

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

        $titleLen = (int)$this->‪getBackendUser()->uc['titleLen'];


        if ($this->searchWord !== '') {

            $searchDemand = ‪FileSearchDemand::createForSearchTerm($this->searchWord)->withRecursive();

            $files = $folder->searchFiles($searchDemand);

        } else {

            $extensionList = !empty($extensionList) && $extensionList[0] === '*' ? [] : $extensionList;

            $files = $this->‪getFilesInFolder($folder, $extensionList);

        }

        $filesCount = count($files);


        $lines = [];


        // Create the header of current folder:

        $folderIcon = $this->iconFactory->getIconForResource($folder, ‪Icon::SIZE_SMALL);


        $lines[] = '

            <tr>

                <th class="col-title nowrap">' . $folderIcon . ' ' . htmlspecialchars(GeneralUtility::fixed_lgd_cs($folder->getStorage()->getName() . ':' . $folder->getReadablePath(), $titleLen)) . '</th>

                <th class="col-control nowrap"></th>

                <th class="col-clipboard nowrap">

                    <a href="#" class="btn btn-default" id="t3js-importSelection" title="' . htmlspecialchars($lang->getLL('importSelection')) . '">' . $this->iconFactory->getIcon('actions-document-import-t3d', ‪Icon::SIZE_SMALL) . '</a>

                    <a href="#" class="btn btn-default" id="t3js-toggleSelection" title="' . htmlspecialchars($lang->getLL('toggleSelection')) . '">' . $this->iconFactory->getIcon('actions-document-select', ‪Icon::SIZE_SMALL) . '</a>

                </th>

                <th class="nowrap">&nbsp;</th>

            </tr>';


        if ($filesCount === 0) {

            $lines[] = '

                <tr>

                    <td colspan="4">No files found.</td>

                </tr>';

        }


        foreach ($files as $fileObject) {

            $fileExtension = $fileObject->getExtension();

            // Thumbnail/size generation:

            $imgInfo = [];

            if (!$noThumbs && GeneralUtility::inList(strtolower(‪$GLOBALS['TYPO3_CONF_VARS']['GFX']['imagefile_ext'] . ',' . ‪$GLOBALS['TYPO3_CONF_VARS']['SYS']['mediafile_ext']), strtolower($fileExtension))) {

                $processedFile = $fileObject->process(

                    ‪ProcessedFile::CONTEXT_IMAGEPREVIEW,

                    $this->thumbnailConfiguration

                );

                $imageUrl = $processedFile->getPublicUrl(true);

                $imgInfo = [

                    $fileObject->getProperty('width'),

                    $fileObject->getProperty('height')

                ];

                $pDim = $imgInfo[0] . 'x' . $imgInfo[1] . ' pixels';

                $clickIcon = '<img src="' . $imageUrl . '"'

                    . ' width="' . $processedFile->getProperty('width') . '"'

                    . ' height="' . $processedFile->getProperty('height') . '"'

                    . ' hspace="5" vspace="5" border="1" />';

            } else {

                $clickIcon = '';

                $pDim = '';

            }

            // Create file icon:

            $size = ' (' . GeneralUtility::formatSize($fileObject->getSize(), $this->getLanguageService()->sL('LLL:EXT:core/Resources/Private/Language/locallang_common.xlf:byteSizeUnits')) . ($pDim ? ', ' . $pDim : '') . ')';

            $icon = '<span title="id=' . htmlspecialchars($fileObject->getUid()) . '">' . $this->iconFactory->getIconForResource($fileObject, ‪Icon::SIZE_SMALL) . '</span>';

            // Create links for adding the file:

            $filesIndex = count($this->elements);

            $this->elements['file_' . $filesIndex] = [

                'type' => 'file',

                'table' => 'sys_file',

                'uid' => $fileObject->getUid(),

                'fileName' => $fileObject->getName(),

                'filePath' => $fileObject->getUid(),

                'fileExt' => $fileExtension,

                'fileIcon' => $icon

            ];

            if ($this->‪fileIsSelectableInFileList($fileObject, $imgInfo)) {

                $ATag = '<a href="#" class="btn btn-default" title="' . htmlspecialchars($fileObject->getName()) . '" data-file-index="' . htmlspecialchars($filesIndex) . '" data-close="0">';

                $ATag .= '<span title="' . htmlspecialchars($lang->getLL('addToList')) . '">' . $this->iconFactory->getIcon('actions-add', ‪Icon::SIZE_SMALL)->render() . '</span>';

                $ATag_alt = '<a href="#" title="' . htmlspecialchars($fileObject->getName()) . $size . '" data-file-index="' . htmlspecialchars($filesIndex) . '" data-close="1">';

                $ATag_e = '</a>';

                $bulkCheckBox = '<label class="btn btn-default btn-checkbox"><input type="checkbox" class="typo3-bulk-item" name="file_' . $filesIndex . '" value="0" /><span class="t3-icon fa"></span></label>';

            } else {

                $ATag = '';

                $ATag_alt = '';

                $ATag_e = '';

                $bulkCheckBox = '';

            }

            $uriBuilder = GeneralUtility::makeInstance(\‪TYPO3\CMS\Backend\Routing\UriBuilder::class);

            // Create link to showing details about the file in a window:

            $Ahref = (string)$uriBuilder->buildUriFromRoute('show_item', [

                'type' => 'file',

                'table' => '_FILE',

                'uid' => $fileObject->getCombinedIdentifier(),

                'returnUrl' => GeneralUtility::getIndpEnv('REQUEST_URI')

            ]);


            // Combine the stuff:

            $filenameAndIcon = $ATag_alt . $icon . htmlspecialchars(GeneralUtility::fixed_lgd_cs($fileObject->getName(), $titleLen)) . $ATag_e;

            // Show element:

            $lines[] = '

                    <tr class="file_list_normal">

                        <td class="col-title nowrap">' . $filenameAndIcon . '&nbsp;</td>

                        <td class="col-control">

                            <div class="btn-group">' . $ATag . $ATag_e . '

                            <a href="' . htmlspecialchars($Ahref) . '" class="btn btn-default" title="' . htmlspecialchars($lang->getLL('info')) . '">' . $this->iconFactory->getIcon('actions-document-info', ‪Icon::SIZE_SMALL) . '</a>

                        </td>

                        <td class="col-clipboard" valign="top">' . $bulkCheckBox . '</td>

                        <td class="nowrap">&nbsp;' . $pDim . '</td>

                    </tr>';

            if ($pDim) {

                $lines[] = '

                    <tr>

                        <td class="filelistThumbnail" colspan="4">' . $ATag_alt . $clickIcon . $ATag_e . '</td>

                    </tr>';

            }

        }


        $markup = [];

        $markup[] = '<h3>' . htmlspecialchars($lang->getLL('files')) . ' ' . $filesCount . ':</h3>';

        $markup[] = GeneralUtility::makeInstance(FolderUtilityRenderer::class, $this)->getFileSearchField($this->searchWord);

        $markup[] = '<div id="filelist">';

        $markup[] = '   ' . $this->‪getBulkSelector($filesCount);

        $markup[] = '   <!-- Filelisting -->';

        $markup[] = '   <div class="table-fit">';

        $markup[] = '       <table class="table table-striped table-hover" id="typo3-filelist">';

        $markup[] = '           ' . implode('', $lines);

        $markup[] = '       </table>';

        $markup[] = '   </div>';

        $markup[] = ' </div>';

        $content = implode('', $markup);


        return $content;

    }


    protected function ‪getFilesInFolder(Folder $folder, array $extensionList)

    {

        if (!empty($extensionList)) {

            $filter = GeneralUtility::makeInstance(FileExtensionFilter::class);

            $filter->setAllowedFileExtensions($extensionList);

            $folder->setFileAndFolderNameFilters([[$filter, 'filterFileList']]);

        }

        return $folder->getFiles();

    }


    protected function ‪getBulkSelector($filesCount)

    {

        if (!$filesCount) {

            return '';

        }


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

        $out = '';


        // Getting flag for showing/not showing thumbnails:

        $noThumbsInEB = $this->‪getBackendUser()->‪getTSConfig()['options.']['noThumbsInEB'] ?? false;

        if (!$noThumbsInEB && $this->selectedFolder) {

            // MENU-ITEMS, fetching the setting for thumbnails from File>List module:

            $_MOD_MENU = ['displayThumbs' => ''];

            $_MCONF['name'] = 'file_list';

            $_MOD_SETTINGS = ‪BackendUtility::getModuleData($_MOD_MENU, GeneralUtility::_GP('SET'), $_MCONF['name']);

            $addParams = ‪HttpUtility::buildQueryString($this->‪getUrlParameters(['identifier' => $this->selectedFolder->getCombinedIdentifier()]), '&');

            $thumbNailCheck = '<div class="checkbox" style="padding:5px 0 15px 0"><label for="checkDisplayThumbs">'

                . ‪BackendUtility::getFuncCheck(

                    '',

                    'SET[displayThumbs]',

                    $_MOD_SETTINGS['displayThumbs'],

                    $this->thisScript,

                    $addParams,

                    'id="checkDisplayThumbs"'

                )

                . htmlspecialchars($lang->sL('LLL:EXT:filelist/Resources/Private/Language/locallang_mod_file_list.xlf:displayThumbs')) . '</label></div>';

            $out .= $thumbNailCheck;

        } else {

            $out .= '<div style="padding-top: 15px;"></div>';

        }

        return $out;

    }


    protected function ‪fileIsSelectableInFileList(FileInterface $file, array $imgInfo)

    {

        return true;

    }


    protected function ‪getBodyTagAttributes()

    {

        return [

            'data-mode' => 'file',

            'data-elements' => json_encode($this->elements)

        ];

    }


    public function ‪getUrlParameters(array $values)

    {

        return [

            'mode' => 'file',

            'expandFolder' => $values['identifier'] ?? ‪$this->expandFolder,

            'bparams' => ‪$this->bparams

        ];

    }


    public function ‪isCurrentlySelectedItem(array $values)

    {

        return false;

    }


    public function ‪getScriptUrl()

    {

        return ‪$this->thisScript;

    }

}