9.5/install_2_classes_2_folder_structure_2_abstract_node_8php_source.html

<?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\Core\Environment;

use ‪TYPO3\CMS\Core\Messaging\FlashMessage;


abstract class ‪AbstractNode

{

    protected ‪$name = '';


    protected ‪$targetPermission;


    protected ‪$parent;


    protected ‪$children = [];


    public function ‪getName()

    {

        return ‪$this->name;

    }


    protected function ‪getTargetPermission()

    {

        return ‪$this->targetPermission;

    }


    protected function ‪setTargetPermission($permission)

    {

        // Normalize the permission string to "4 characters", padding with leading "0" if necessary:

        $permission = substr($permission, 0, 4);

        $permission = str_pad($permission, 4, '0', STR_PAD_LEFT);

        $this->targetPermission = $permission;

    }


    protected function ‪getChildren()

    {

        return ‪$this->children;

    }


    protected function ‪getParent()

    {

        return ‪$this->parent;

    }


    public function ‪getAbsolutePath()

    {

        return $this->‪getParent()->‪getAbsolutePath() . '/' . ‪$this->name;

    }


    public function ‪isWritable()

    {

        return $this->‪getParent()->‪isWritable();

    }


    protected function ‪exists()

    {

        if (@is_link($this->‪getAbsolutePath())) {

            return true;

        }

        return @file_exists($this->‪getAbsolutePath());

    }


    protected function ‪fixPermission(): FlashMessage

    {

        if ($this->‪isPermissionCorrect()) {

            throw new Exception(

                'Permission on ' . $this->‪getAbsolutePath() . ' are already ok',

                1366744035

            );

        }

        $result = @chmod($this->‪getAbsolutePath(), octdec($this->‪getTargetPermission()));

        if ($result === true) {

            return new FlashMessage(

                '',

                'Fixed permission on ' . $this->‪getRelativePathBelowSiteRoot() . '.'

            );

        }

        return new FlashMessage(

            'Permissions could not be changed to ' . $this->‪getTargetPermission()

                . '. This only is a problem if files and folders within this node cannot be written.',

            'Permission change on ' . $this->‪getRelativePathBelowSiteRoot() . ' not successful',

            ‪FlashMessage::NOTICE

        );

    }


    protected function ‪isPermissionCorrect()

    {

        if ($this->‪isWindowsOs()) {

            return true;

        }

        if ($this->‪getCurrentPermission() === $this->‪getTargetPermission()) {

            return true;

        }

        return false;

    }


    protected function ‪getCurrentPermission()

    {

        $permissions = decoct(fileperms($this->‪getAbsolutePath()));

        return substr($permissions, -4);

    }


    protected function ‪isWindowsOs()

    {

        return ‪Environment::isWindows();

    }


    protected function ‪getRelativePathBelowSiteRoot($path = null)

    {

        if ($path === null) {

            $path = $this->‪getAbsolutePath();

        }

        $publicPath = ‪Environment::getPublicPath();

        if (strpos($path, $publicPath, 0) !== 0) {

            throw new Exception\InvalidArgumentException(

                'Public path is not first part of given path',

                1366398198

            );

        }

        $relativePath = substr($path, strlen($publicPath), strlen($path));

        // Add a forward slash again, so we don't end up with an empty string

        if ($relativePath === '') {

            $relativePath = '/';

        }

        return $relativePath;

    }

}