FileLinkHandler.php

Go to the documentation of this file.

<?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\Core\LinkHandling;
 
use ‪TYPO3\CMS\Core\Resource\Exception\FileDoesNotExistException;
use ‪TYPO3\CMS\Core\Resource\FileInterface;
use ‪TYPO3\CMS\Core\Resource\ResourceFactory;
use ‪TYPO3\CMS\Core\Resource\Security\FileNameValidator;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
 
class ‪FileLinkHandler implements ‪LinkHandlingInterface
{
    protected ‪$baseUrn = 't3://file';
 
    protected ‪$resourceFactory;
 
    public function ‪asString(array $parameters): string
    {
        if ($parameters['file'] === null) {
            return '';
        }
        $uid = $parameters['file']->getUid();
        // I am not sure about this use case. Maybe if the file was not indexed and saved to DB (migration from old systems)
        if ($uid > 0) {
            $urn = '?uid=' . $uid;
        } else {
            $identifier = $parameters['file']->getIdentifier();
            $urn = '?identifier=' . urlencode($identifier);
        }
        if (!empty($parameters['fragment'])) {
            $urn .= '#' . $parameters['fragment'];
        }
        return $this->baseUrn . $urn;
    }
 
    public function ‪resolveHandlerData(array $data): array
    {
        try {
            $file = $this->‪resolveFile($data);
            $fileNameValidator = GeneralUtility::makeInstance(FileNameValidator::class);
            if (
                !$fileNameValidator->isValid(basename($file->getIdentifier())) ||
                !$fileNameValidator->isValid($file->getName())
            ) {
                $file = null;
            }
        } catch (‪FileDoesNotExistException $e) {
            $file = null;
        }
        $result = ['file' => $file];
        if (!empty($data['fragment'])) {
            $result['fragment'] = $data['fragment'];
        }
        return $result;
    }
 
    protected function ‪resolveFile(array $data): ?‪FileInterface
    {
        if (isset($data['uid'])) {
            return $this->‪getResourceFactory()->‪getFileObject($data['uid']);
        }
        if (isset($data['identifier'])) {
            return $this->‪getResourceFactory()->‪getFileObjectFromCombinedIdentifier($data['identifier']);
        }
        return null;
    }
 
    protected function ‪getResourceFactory(): ‪ResourceFactory
    {
        if (!$this->resourceFactory) {
            $this->resourceFactory = GeneralUtility::makeInstance(ResourceFactory::class);
        }
        return ‪$this->resourceFactory;
    }
}