FileBrowser.php

Go to the documentation of this file.

<?php
 
/*
 * 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\Recordlist\Browser;
 
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\Filter\FileExtensionFilter;
use ‪TYPO3\CMS\Core\Resource\Folder;
use ‪TYPO3\CMS\Core\Resource\FolderInterface;
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;
use ‪TYPO3\CMS\Recordlist\View\RecordSearchBoxComponent;
 
class ‪FileBrowser extends ‪AbstractElementBrowser implements ‪ElementBrowserInterface, ‪LinkParameterProviderInterface
{
    protected ‪$expandFolder;
 
    protected ‪$selectedFolder;
 
    protected ‪$searchWord;
 
    protected ‪$thumbnailConfiguration = [];
 
    protected function ‪initialize()
    {
        parent::initialize();
        $this->pageRenderer->loadRequireJsModule('TYPO3/CMS/Recordlist/BrowseFiles');
        $this->pageRenderer->loadRequireJsModule('TYPO3/CMS/Backend/Tree/FileStorageBrowser');
        $this->pageRenderer->loadRequireJsModule('TYPO3/CMS/Backend/MultiRecordSelection');
 
        $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 = $this->‪getRequest()->getParsedBody()['expandFolder'] ?? $this->‪getRequest()->getQueryParams()['expandFolder'] ?? null;
        $this->searchWord = $this->‪getRequest()->getParsedBody()['search_field'] ?? $this->‪getRequest()->getQueryParams()['search_field'] ?? '';
    }
 
    public function ‪processSessionData($data)
    {
        if ($this->‪expandFolder !== null) {
            $data['expandFolder'] = ‪$this->expandFolder;
            ‪$store = true;
        } else {
            $this->‪expandFolder = $data['expandFolder'] ?? null;
            ‪$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 = GeneralUtility::makeInstance(ResourceFactory::class)->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 $driverMissingException) {
                // 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]);
                if (($defaultUploadFolder = $backendUser->getDefaultUploadFolder($pid, $table, $field)) instanceof ‪FolderInterface) {
                    $this->selectedFolder = $defaultUploadFolder;
                }
            } 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' => ''];
            $_MOD_SETTINGS = BackendUtility::getModuleData($_MOD_MENU, GeneralUtility::_GP('SET'), 'file_list');
        }
        $displayThumbs = $_MOD_SETTINGS['displayThumbs'] ?? true;
        $noThumbs = $noThumbs ?: !$displayThumbs;
        if ($this->selectedFolder) {
            $files = $this->‪renderFilesInFolder($this->selectedFolder, $allowedFileExtensions, $noThumbs);
        } else {
            $files = '';
        }
        $contentOnly = (bool)($this->‪getRequest()->getQueryParams()['contentOnly'] ?? false);
 
        $this->‪setBodyTagParameters();
        $this->moduleTemplate->setTitle($this->‪getLanguageService()->getLL('fileSelector'));
        $view = $this->moduleTemplate->getView();
        $view->assignMultiple([
            'treeEnabled' => true,
            'treeType' => 'folder',
            'activeFolder' => $this->selectedFolder,
            'initialNavigationWidth' => $this->‪getBackendUser()->uc['selector']['navigation']['width'] ?? 250,
            'content' => $files . $uploadForm . $createFolder,
            'contentOnly' => $contentOnly,
        ]);
        if ($contentOnly) {
            return $view->render();
        }
        return $this->moduleTemplate->renderContent();
    }
 
    public function ‪renderFilesInFolder(‪FolderInterface $folder, array $extensionList = [], $noThumbs = false)
    {
        if (!$folder->checkActionPermission('read')) {
            return '';
        }
        $lang = $this->‪getLanguageService();
        $titleLen = (int)$this->‪getBackendUser()->uc['titleLen'];
 
        // Create the header of current folder:
        $folderIcon = $this->iconFactory->getIconForResource($folder, ‪Icon::SIZE_SMALL);
        $header = '<h4 class="text-truncate p-0 mb-1">' . $folderIcon . ' ' . htmlspecialchars($folder->‪getStorage()->‪getName() . ': ' . $folder->getReadablePath()) . '</h4>';
 
        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);
        }
 
        // Prepare search box, since the component should always be displayed, even if no files are available
        $searchBox = GeneralUtility::makeInstance(RecordSearchBoxComponent::class)
            ->setSearchWord($this->searchWord)
            ->render($this->‪getScriptUrl() . ‪HttpUtility::buildQueryString($this->‪getUrlParameters([]), '&'));
        $searchBox = '<div class="mt-4 mb-4">' . $searchBox . '</div>';
 
        if (!count($files)) {
            // No files found. Either due to an active search or simply because the folder is empty.
            if ($this->searchWord !== '') {
                $message = sprintf(
                    $lang->sL('LLL:EXT:recordlist/Resources/Private/Language/locallang_browse_links.xlf:no_files_search'),
                    $folder->‪getStorage()->‪getName() . ':' . $folder->getReadablePath(),
                    $this->searchWord
                );
            } else {
                $message = sprintf(
                    $lang->sL('LLL:EXT:recordlist/Resources/Private/Language/locallang_browse_links.xlf:no_files'),
                    $folder->‪getStorage()->‪getName() . ':' . $folder->getReadablePath()
                );
            }
 
            return $header
                . '<div class="shadow-sm bg-info bg-gradient p-3 mb-4 mt-4">' .
                    htmlspecialchars($message)
                . '</div>' .
                $searchBox;
        }
        $lines = [];
 
        $tableHeader = '
            <thead>
                <tr>
                    <th colspan="3" class="nowrap">
                        <div class="btn-group dropdown position-static me-1">
                            <button type="button" class="btn btn-borderless dropdown-toggle t3js-multi-record-selection-check-actions-toggle" data-bs-toggle="dropdown" data-bs-boundary="window" aria-expanded="false">
                                ' . $this->iconFactory->getIcon('content-special-div', ‪Icon::SIZE_SMALL) . '
                            </button>
                            <ul class="dropdown-menu t3js-multi-record-selection-check-actions">
                                <li>
                                    <button type="button" class="btn btn-link dropdown-item disabled" data-multi-record-selection-check-action="check-all" title="' . htmlspecialchars($lang->sL('LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:labels.checkAll')) . '">' .
                                        $this->iconFactory->getIcon('actions-check-square', ‪Icon::SIZE_SMALL) . ' ' . htmlspecialchars($lang->sL('LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:labels.checkAll')) .
                                    '</button>
                                </li>
                                <li>
                                    <button type="button" class="btn btn-link dropdown-item disabled" data-multi-record-selection-check-action="check-none" title="' . htmlspecialchars($lang->sL('LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:labels.uncheckAll')) . '">' .
                                        $this->iconFactory->getIcon('actions-square', ‪Icon::SIZE_SMALL) . ' ' . htmlspecialchars($lang->sL('LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:labels.uncheckAll')) .
                                    '</button>
                                </li>
                                <li>
                                    <button type="button" class="btn btn-link dropdown-item" data-multi-record-selection-check-action="toggle" title="' . htmlspecialchars($lang->sL('LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:labels.toggleSelection')) . '">' .
                                        $this->iconFactory->getIcon('actions-document-select', ‪Icon::SIZE_SMALL) . ' ' . htmlspecialchars($lang->sL('LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:labels.toggleSelection')) .
                                    '</button>
                                </li>
                            </ul>
                        </div>
                    </th>
                    <th class="col-control nowrap"></th>
                </tr>
            </thead>';
 
        foreach ($files as $fileObject) {
            // Thumbnail/size generation:
            $imgInfo = [];
            if (!$noThumbs && ($fileObject->isMediaFile() || $fileObject->isImage())) {
                $processedFile = $fileObject->process(
                    ‪ProcessedFile::CONTEXT_IMAGEPREVIEW,
                    $this->thumbnailConfiguration
                );
                $imageUrl = $processedFile->getPublicUrl();
                $imgInfo = [
                    $fileObject->getProperty('width'),
                    $fileObject->getProperty('height'),
                ];
                $pDim = $imgInfo[0] . 'x' . $imgInfo[1] . ' pixels';
                $clickIcon = '<img src="' . htmlspecialchars($imageUrl) . '"'
                    . ' width="' . $processedFile->getProperty('width') . '"'
                    . ' height="' . $processedFile->getProperty('height') . '" class="me-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>';
            if ($this->‪fileIsSelectableInFileList($fileObject, $imgInfo)) {
                $ATag = '<a href="#" class="btn btn-default" title="' . htmlspecialchars($fileObject->getName()) . '" data-file-name="' . htmlspecialchars($fileObject->getName()) . '" data-file-uid="' . $fileObject->getUid() . '" 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-name="' . htmlspecialchars($fileObject->getName()) . '" data-file-uid="' . $fileObject->getUid() . '" data-close="1">';
                $ATag_e = '</a>';
                $bulkCheckBox = '
                    <span class="form-check form-toggle">
                        <input type="checkbox" data-file-name="' . htmlspecialchars($fileObject->getName()) . '" data-file-uid="' . $fileObject->getUid() . '" name="file_' . $fileObject->getUid() . '" value="0" autocomplete="off" class="form-check-input t3js-multi-record-selection-check"  />
                    </span>';
            } else {
                $ATag = '';
                $ATag_alt = '';
                $ATag_e = '';
                $bulkCheckBox = '';
            }
            // Create link to showing details about the file in a window:
            $Ahref = (string)$this->uriBuilder->buildUriFromRoute('show_item', [
                'type' => 'file',
                'table' => '_FILE',
                'uid' => $fileObject->getCombinedIdentifier(),
                'returnUrl' => $this->‪getRequest()->getAttribute('normalizedParams')->getRequestUri(),
            ]);
 
            // Combine the stuff:
            $filenameAndIcon = $ATag_alt . $icon . htmlspecialchars(GeneralUtility::fixed_lgd_cs($fileObject->getName(), $titleLen)) . $ATag_e;
            // Show element:
            $lines[] = '
                    <tr>
                        <td>' . $bulkCheckBox . '</td>
                        <td class="col-title nowrap">' . $filenameAndIcon . '</td>
                        <td class="nowrap">' . ($pDim ? $ATag_alt . $clickIcon . $ATag_e . $pDim : '') . '</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>
                    </tr>';
        }
 
        $markup = [];
        $markup[] = $searchBox;
        $markup[] = '<div id="filelist">';
        $markup[] = '  <div class="row row-cols-auto justify-content-between gx-0 list-header multi-record-selection-actions-wrapper">';
        $markup[] = '      <div class="col-auto">';
        $markup[] = '          <div class="row row-cols-auto align-items-center g-2 t3js-multi-record-selection-actions hidden">';
        $markup[] = '              <div class="col">';
        $markup[] = '                  <strong>' . htmlspecialchars($lang->sL('LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:labels.selection')) . '</strong>';
        $markup[] = '              </div>';
        $markup[] = '              <div class="col">';
        $markup[] = '                  <button type="button" class="btn btn-default btn-sm" data-multi-record-selection-action="import" title="' . htmlspecialchars($lang->getLL('importSelection')) . '">';
        $markup[] = '                      ' . $this->iconFactory->getIcon('actions-document-import-t3d', ‪Icon::SIZE_SMALL) . ' ' . htmlspecialchars($lang->getLL('importSelection'));
        $markup[] = '                  </button>';
        $markup[] = '              </div>';
        $markup[] = '          </div>';
        $markup[] = '      </div>';
        $markup[] = '      ' . $this->‪getThumbnailSelector();
        $markup[] = '   </div>';
        $markup[] = '   <table class="table table-sm table-responsive table-striped table-hover" id="typo3-filelist" data-list-container="files">';
        $markup[] = '       ' . $tableHeader;
        $markup[] = '       <tbody data-multi-record-selection-row-selection="true">';
        $markup[] = '         ' . implode('', $lines);
        $markup[] = '       </tbody>';
        $markup[] = '   </table>';
        $markup[] = ' </div>';
        return $header . implode('', $markup);
    }
 
    protected function ‪getFilesInFolder(FolderInterface $folder, array $extensionList)
    {
        if (!empty($extensionList)) {
            $filter = GeneralUtility::makeInstance(FileExtensionFilter::class);
            $filter->setAllowedFileExtensions($extensionList);
            $folder->setFileAndFolderNameFilters([[$filter, 'filterFileList']]);
        }
        return $folder->getFiles();
    }
 
    protected function ‪getThumbnailSelector(): string
    {
        // Getting flag for showing/not showing thumbnails:
        if (!$this->selectedFolder || ($this->‪getBackendUser()->getTSConfig()['options.']['noThumbsInEB'] ?? false)) {
            return '';
        }
 
        $lang = $this->‪getLanguageService();
 
        // MENU-ITEMS, fetching the setting for thumbnails from File>List module:
        $_MOD_MENU = ['displayThumbs' => ''];
        $currentValue = BackendUtility::getModuleData($_MOD_MENU, GeneralUtility::_GP('SET'), 'file_list')['displayThumbs'] ?? true;
        $addParams = ‪HttpUtility::buildQueryString($this->‪getUrlParameters(['identifier' => $this->selectedFolder->getCombinedIdentifier()]), '&');
 
        return '
            <div class="col-auto">
                <div class="form-check form-switch">
                    ' . BackendUtility::getFuncCheck('', 'SET[displayThumbs]', $currentValue, $this->thisScript, $addParams, 'id="checkDisplayThumbs"') . '
                    <label for="checkDisplayThumbs" class="form-check-label">
                        ' . htmlspecialchars($lang->sL('LLL:EXT:recordlist/Resources/Private/Language/locallang_browse_links.xlf:displayThumbs')) . '
                    </label>
                </div>
            </div>';
    }
 
    protected function ‪fileIsSelectableInFileList(FileInterface $file, array $imgInfo)
    {
        return true;
    }
 
    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;
    }
}