LinkNode.php

Go to the documentation of this file.

<?php
namespace ‪TYPO3\CMS\Install\FolderStructure;
 
/*
 * 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\Core\Messaging\FlashMessage;
 
class ‪LinkNode extends ‪AbstractNode implements ‪NodeInterface
{
    protected ‪$target = '';
 
    public function ‪__construct(array $structure, ‪NodeInterface ‪$parent = null)
    {
        if (‪$parent === null) {
            throw new Exception\InvalidArgumentException(
                'Link node must have parent',
                1380485700
            );
        }
        $this->parent = ‪$parent;
 
        // Ensure name is a single segment, but not a path like foo/bar or an absolute path /foo
        if (strstr($structure['name'], '/') !== false) {
            throw new Exception\InvalidArgumentException(
                'File name must not contain forward slash',
                1380546061
            );
        }
        $this->name = $structure['name'];
 
        if (isset($structure['target']) && $structure['target'] !== '') {
            $this->target = $structure['target'];
        }
    }
 
    public function ‪getStatus(): array
    {
        if ($this->‪isWindowsOs()) {
            return [
                new ‪FlashMessage(
                    'This node is not handled for Windows OS and should be checked manually.',
                    $this->‪getRelativePathBelowSiteRoot() . ' should be a link, but this support is incomplete for Windows.',
                    ‪FlashMessage::INFO
                ),
            ];
        }
 
        if (!$this->‪exists()) {
            return [
                new ‪FlashMessage(
                    'Links cannot be fixed by this system',
                    $this->‪getRelativePathBelowSiteRoot() . ' should be a link, but it does not exist',
                    ‪FlashMessage::ERROR
                ),
            ];
        }
 
        if (!$this->‪isLink()) {
            $type = @filetype($this->‪getAbsolutePath());
            if ($type) {
                $messageBody =
                    'The target ' . $this->‪getRelativePathBelowSiteRoot() . ' should be a link,' .
                    ' but is of type ' . $type . '. This cannot be fixed automatically. Please investigate.'
                ;
            } else {
                $messageBody =
                    'The target ' . $this->‪getRelativePathBelowSiteRoot() . ' should be a file,' .
                    ' but is of unknown type, probably because an upper level directory does not exist. Please investigate.'
                ;
            }
            return [
                new ‪FlashMessage(
                    $messageBody,
                    'Path ' . $this->‪getRelativePathBelowSiteRoot() . ' is not a link',
                    ‪FlashMessage::WARNING
                ),
            ];
        }
 
        if (!$this->‪isTargetCorrect()) {
            return [
                new ‪FlashMessage(
                    'Link target should be ' . $this->‪getTarget() . ' but is ' . $this->‪getCurrentTarget(),
                    $this->‪getRelativePathBelowSiteRoot() . ' is a link, but link target is not as specified',
                    ‪FlashMessage::ERROR
                ),
            ];
        }
        $message = 'Is a link';
        if ($this->‪getTarget() !== '') {
            $message .= ' and correctly points to target ' . $this->‪getTarget();
        }
        return [
            new ‪FlashMessage(
                $message,
                $this->‪getRelativePathBelowSiteRoot()
            ),
        ];
    }
 
    public function ‪fix(): array
    {
        return [];
    }
 
    protected function ‪getTarget()
    {
        return ‪$this->target;
    }
 
    protected function ‪isLink()
    {
        if (!$this->‪exists()) {
            throw new Exception\InvalidArgumentException(
                'Link does not exist',
                1380556246
            );
        }
        return @is_link($this->‪getAbsolutePath());
    }
 
    protected function ‪isTargetCorrect()
    {
        if (!$this->‪exists()) {
            throw new Exception\InvalidArgumentException(
                'Link does not exist',
                1380556245
            );
        }
        if (!$this->‪isLink()) {
            throw new Exception\InvalidArgumentException(
                'Node is not a link',
                1380556247
            );
        }
 
        $result = false;
        $expectedTarget = $this->‪getTarget();
        if (empty($expectedTarget)) {
            $result = true;
        } else {
            $actualTarget = $this->‪getCurrentTarget();
            if ($expectedTarget === rtrim($actualTarget, '/')) {
                $result = true;
            }
        }
        return $result;
    }
 
    protected function ‪getCurrentTarget()
    {
        return readlink($this->‪getAbsolutePath());
    }
}