Meanbee\LibMageConf\RootDiscovery

Complexity

Total Complexity

31

Size/Duplication

Total Lines	190
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

100%

Importance

Changes

0

14 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	9	2
A	getRootDirectory()	0	8	2
A	getConfigReader()	0	7	1
A	getInstallationType()	0	12	3
A	getConfigurationFilePath()	0	9	3
A	discoverRootDirectory()	0	16	4
A	checkCurrentDirectory()	0	10	3
A	checkParentDirectories()	0	13	3
A	checkChildDirectories()	0	20	4
A	isDirectoryRoot()	0	4	2
A	isMagentoOneDirectoryRoot()	0	4	1
A	isMagentoTwoDirectoryRoot()	0	4	1
A	getLocalXmlPath()	0	4	1
A	getEnvPhpPath()	0	4	1

<?php

namespace Meanbee\LibMageConf;

use Meanbee\LibMageConf\ConfigReader\Factory as ConfigReaderFactory;
use RecursiveDirectoryIterator;
use RecursiveIteratorIterator;
use SplFileInfo;

/**
 * Discover the root directory of a Magento installation given a starting directory.
 *
 * @package Meanbee\LibMageConf
 */
class RootDiscovery
{
    protected $baseDirectory;
    protected $rootDirectory;
    protected $configReaderFactory;

    /**
     * @param string $baseDirectory The directory from which to start the search
     * @param ConfigReaderFactory $configReaderFactory
     */
    public function __construct($baseDirectory, ConfigReaderFactory $configReaderFactory = null)
    {
        if ($configReaderFactory === null) {
            $configReaderFactory = new ConfigReaderFactory();
        }

        $this->baseDirectory = $baseDirectory;
        $this->configReaderFactory = $configReaderFactory;
    }

    /**
     * The root directory of the first Magento installation found in the base directory.
     *
     * @return null|string
     */
    public function getRootDirectory()
    {
        if ($this->rootDirectory === null) {
            $this->rootDirectory = $this->discoverRootDirectory();
        }

        return $this->rootDirectory;
    }

    /**
     * @return ConfigReader
     */
    public function getConfigReader()
    {
        return $this->configReaderFactory->create(
            $this->getConfigurationFilePath(),
            $this->getInstallationType()
        );
    }

    /**
     * @return string
     */
    public function getInstallationType()
    {
        if ($this->isMagentoOneDirectoryRoot($this->getRootDirectory())) {
            return MagentoType::MAGENTO_1;
        }

        if ($this->isMagentoTwoDirectoryRoot($this->getRootDirectory())) {
            return MagentoType::MAGENTO_2;
        }

        return MagentoType::UNKNOWN;
    }

    /**
     * @return string
     */
    protected function getConfigurationFilePath()
    {
        switch ($this->getInstallationType()) {
            case MagentoType::MAGENTO_1:
                return $this->getLocalXmlPath($this->getRootDirectory());
            case MagentoType::MAGENTO_2:
                return $this->getEnvPhpPath($this->getRootDirectory());
        }
    }

    /**
     * @return null|string
     */
    protected function discoverRootDirectory()
    {
        if ($dir = $this->checkCurrentDirectory()) {
            return $dir;
        }

        if ($dir = $this->checkParentDirectories()) {
            return $dir;
        }

        if ($dir = $this->checkChildDirectories()) {
            return $dir;
        }

        return null;
    }

    /**
     * @return null|string
     */
    protected function checkCurrentDirectory()
    {
        if (is_dir($this->baseDirectory)) {
            if ($this->isDirectoryRoot($this->baseDirectory)) {
                return $this->baseDirectory;
            }
        }

        return null;
    }

    /**
     * @return null|string
     */
    protected function checkParentDirectories()
    {
        $dir = new SplFileInfo($this->baseDirectory);
        while ($testDir = $dir->getPath()) {
            if ($this->isDirectoryRoot($testDir)) {
                return $testDir;
            }

            $dir = new SplFileInfo($testDir);
        }

        return null;
    }

    /**
     * @return null|string
     */
    protected function checkChildDirectories()
    {
        $iterator = new RecursiveIteratorIterator(
            new RecursiveDirectoryIterator($this->baseDirectory),
            RecursiveIteratorIterator::SELF_FIRST
        );

        foreach($iterator as $fileInfo) {
            /** @var SplFileInfo $fileInfo */
            $filename = $fileInfo->getPath() . DIRECTORY_SEPARATOR . $fileInfo->getFilename();

            if ($fileInfo->isDir()) {
                if ($this->isDirectoryRoot($filename)) {
                    return $filename;
                }
            }
        }

        return null;
    }

    /**
     * @param $directory
     * @return bool
     */
    protected function isDirectoryRoot($directory)
    {
        return $this->isMagentoOneDirectoryRoot($directory) || $this->isMagentoTwoDirectoryRoot($directory);
    }

    /**
     * @param $directory
     * @return bool
     */
    protected function isMagentoOneDirectoryRoot($directory)
    {
        return file_exists($this->getLocalXmlPath($directory));
    }

    protected function isMagentoTwoDirectoryRoot($directory)
    {
        return file_exists($this->getEnvPhpPath($directory));
    }

    /**
     * @param $directory
     * @return string
     */
    protected function getLocalXmlPath($directory)
    {
        return sprintf("%s/app/etc/local.xml", $directory);
    }

    /**
     * @param $directory
     * @return string
     */
    protected function getEnvPhpPath($directory)
    {
        return sprintf("%s/app/etc/env.php", $directory);
    }
}