teamneusta / php-cli-hosts

src/Services/Provider/Filesystem.php

<?php
/**
 * This file is part of the teamneusta/hosts project.
 * Copyright (c) 2017 neusta GmbH | Ein team neusta Unternehmen
 * For the full copyright and license information, please view the LICENSE file that was distributed with this source code.
 * @license http://www.opensource.org/licenses/mit-license.html  MIT License
 *
 */

namespace TeamNeusta\Hosts\Services\Provider;

use TeamNeusta\Hosts\Exception\HostAlreadySetException;

/**
 * Class Filesystem
 *
 * @package TeamNeusta\Hosts\Services\Provider
 */
class Filesystem
{
    /**
     * configuration file name.
     */
    const CONFIGURATION_FILE_NAME = '.hosts';

    /**
     * @var \Symfony\Component\Filesystem\Filesystem
     */
    protected $fs;

    /**
     * @var File
     */
    protected $file;

    /**
     * Determines if currently adding new Data to avoid setting scope.
     * Scope will only be added if not updating.
     *
     * @var bool
     */
    private $_isUpdate = false;

    /**
     * Minimal Configuration used to save and connect.
     *
     * @var array
     */
    private $_defaultConfig = [
        'name' => '',
        'host' => '',
        'user' => '',
        'port' => 22
    ];

    /**
     * Filesystem constructor.
     * @codeCoverageIgnore
     *
     * @param \Symfony\Component\Filesystem\Filesystem $fs
     * @param File $file
     */
    public function __construct(
        \Symfony\Component\Filesystem\Filesystem $fs = null,
        File $file = null
    )
    {
        $this->fs = $fs ?? new \Symfony\Component\Filesystem\Filesystem();
        $this->file = $file ?? new File();
    }

    /**
     * Retrieve home dir.
     *
     * @return null|string
     */
    public function getHomeDir()
    {
        // Cannot use _SERVER superglobal since that's empty during UnitUnishTestCase
        // getenv('HOME') isn't set on Windows and generates a Notice.
        $home = getenv('HOME');
        if (!empty($home)) {
            // home should never end with a trailing slash.
            $home = rtrim($home, '/');
        } elseif (!empty($_SERVER['HOMEDRIVE']) && !empty($_SERVER['HOMEPATH'])) {
            // home on windows
            $home = $_SERVER['HOMEDRIVE'] . $_SERVER['HOMEPATH'];
            // If HOMEPATH is a root directory the path can end with a slash. Make sure
            // that doesn't happen.
            $home = rtrim($home, '\\/');
        }
        return empty($home) ? NULL : $home;
    }

    /**
     * Retrieve local configuration.
     *
     * @return bool|array
     */
    public function getLocalConfiguration() : array
    {
        $fileName = $this->getFilename(self::getHomeDir());
        $config = $this->getConfigurationFile($fileName);
        $config = $this->addScope($config, 'local');
        return $config;
    }

    /**
     * Retrieve project configuration.
     *
     * @return bool|array
     */
    public function getProjectConfiguration() : array
    {
        $filename = $this->getFilename();
        $config = $this->getConfigurationFile($filename, false);
        $config = $this->addScope($config, 'project');
        return $config;
    }

    /**
     * Retrieve local configuration.
     *
     * @return bool|array
     */
    public function getGlobalConfiguration() : array
    {
        $fileName = $this->getGlobalUrlFromConfig();
        $config = [];
        if ($fileName !== false) {
            $config = $this->getConfigurationFile($fileName, false);
            $config = $this->addScope($config, 'global');
        }
        return $config;
    }

    /**
     * @param $fileName
     * @param bool $createIfNotExist
     * @return array|bool|mixed|null
     * @throws \IOException
     */
    public function getConfigurationFile($fileName, $createIfNotExist = true)
    {
        if (!$this->fs->exists($fileName) && $createIfNotExist) {
            try {
                // generate a empty array for local configuration
                $defaults = ['hosts' => []];
                $this->fs->dumpFile($fileName, json_encode($defaults));
            } catch (\Exception $e) {
                throw new \IOException($e->getMessage());
            }
        }
        $config = json_decode($this->file->getContents($fileName), true);
        if (is_null($config)) {
            $config = false;
            return $config;
        }
        return $config;
    }

    /**
     * Adds Host to configuration file.
     *
     * @param $hostConfig
     * @param string $scope
     * @throws \Exception
     */
    public function addHostToConfiguration($hostConfig, $scope = 'local')
    {
        try {
            $this->_isUpdate = true;
            switch ($scope) {
                case 'project':

case statements should be defined using a colon.

                    $fileName = $this->getFilename();
                    $config = $this->getProjectConfiguration();
                    break;
                default:
                    $fileName = $this->getFilename(self::getHomeDir());
                    $config = $this->getLocalConfiguration();
                    break;
            }
            $config['hosts'][] = array_merge($this->_defaultConfig, $hostConfig);
            $this->fs->dumpFile($fileName, json_encode($config));
            $this->_isUpdate = false;
        } catch (\Exception $e) {
            throw new \Exception($e->getMessage());
        } finally {
            $this->_isUpdate = false;
        }
    }

    /**
     * @param $hostUrl
     * @param bool $override
     *
     * @throws HostAlreadySetException
     */
    public function setGlobalHostsUrl($hostUrl, $override = false)
    {
        $fileName = $this->getFilename(self::getHomeDir());
        $config = $this->getConfigurationFile($fileName);

        if (isset($config['hosts_url']) && $override) {
            $config['hosts_url'] = $hostUrl;
        } elseif (isset($config['hosts_url'])) {
            throw new HostAlreadySetException($config['hosts_url']);
        } else {
            $config['hosts_url'] = $hostUrl;
        }
        $this->fs->dumpFile($fileName, json_encode($config));
    }

    /**
     * Get Filename with given location.
     *
     * @param string $baseDir
     * @return string
     */
    public function getFilename($baseDir = '.') : string
    {
        $fileName = $baseDir . DIRECTORY_SEPARATOR . self::CONFIGURATION_FILE_NAME;
        return $fileName;
    }

    /**
     * Add scope to each entry in config.
     *
     * @param $config
     * @param $scope
     *
     * @return mixed
     */
    public function addScope($config, $scope) : array
    {
        // do not add Scope during update. Scope will always be set when reading configuration.
        if (!$this->_isUpdate && is_array($config) && isset($config['hosts'])) {
            foreach ($config['hosts'] as $key => $entry) {
                $config['hosts'][$key]['scope'] = $scope;
            }
        }
        if (!is_array($config)) {
            $config = ['hosts' => []];
        }
        return $config;
    }

    /**
     * Get global URL from config.
     *
     * @return bool | string
     */
    private function getGlobalUrlFromConfig() : string
    {
        $fileName = $this->getFilename(self::getHomeDir());
        $config = $this->getConfigurationFile($fileName, false);

        $hostUrl = false;
        if (isset($config['hosts_url'])) {
            $hostUrl = $config['hosts_url'];
        }

        return $hostUrl;
    }
}