notamedia / console-jedi

src/Environment/Command/InitCommand.php

<?php
/**
 * For the full copyright and license information, please view the LICENSE.md
 * file that was distributed with this source code.
 */

namespace Notamedia\ConsoleJedi\Environment\Command;

use Bitrix\Main\Application;
use Bitrix\Main\Config\Configuration;
use Bitrix\Main\Config\Option;
use Bitrix\Main\IO\File;
use Bitrix\Main\Loader;
use Notamedia\ConsoleJedi\Application\Command\Command;
use Notamedia\ConsoleJedi\Application\Exception\BitrixException;
use Notamedia\ConsoleJedi\Module\Command\ModuleCommand;
use Notamedia\ConsoleJedi\Module\Exception\ModuleException;
use Notamedia\ConsoleJedi\Module\Exception\ModuleInstallException;
use Notamedia\ConsoleJedi\Module\Module;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Question\ChoiceQuestion;
use Symfony\Component\Console\Helper\ProgressBar;
use Symfony\Component\Filesystem\Filesystem;

/**
 * Installation environment settings.
 *
 * @author Nik Samokhvalov <nik@samokhvalov.info>
 */
class InitCommand extends Command
{
    /**
     * @var string Path to the environment directory.
     */
    protected $dir;
    /**
     * @var array Settings for current environment. The contents of the file `config.php`.
     */
    protected $config = [];
    /**
     * @var array Methods which be running in the first place.
     */
    protected $bootstrap = ['copyFiles', 'initializeBitrix'];
    /**
     * @var array Files that do not need to copy to the application when initializing the environment settings.
     */
    protected $excludedFiles = ['config.php'];
    /**
     * @var string Type of the initialized environment.
     */
    private $type;

    /**
     * {@inheritdoc}
     */
    protected function configure()
    {
        parent::configure();

        $this->setName('env:init')
            ->setDescription('Installation environment settings')
            ->setHelp('Run command and select environment from the list')
            ->addArgument('type', InputArgument::OPTIONAL, 'Type of the environments')
            ->addOption('memcache-cold-start', null, null, 'All memcache servers adds with status "ready"');
    }

    /**
     * {@inheritdoc}
     */
    protected function initialize(InputInterface $input, OutputInterface $output)
    {
        parent::initialize($input, $output);

        if (!$this->getApplication()->getConfiguration()['env-dir']) {
            throw new \Exception('Config env-dir is missing');
        }

        $dir = $this->getApplication()->getRoot() . '/' . $this->getApplication()->getConfiguration()['env-dir'];

        if (!is_dir($dir)) {
            throw new \Exception('Directory ' . $dir . ' is missing');
        }

        $environments = include $dir . '/index.php';

        if (!is_array($environments)) {
            throw new \Exception('File with description of environments is missing');
        } elseif (count($environments) == 0) {
            throw new \Exception('Environments not found in description file');
        }

        if ($input->getArgument('type')) {
            $type = $input->getArgument('type');

            if (!isset($environments[$type])) {
                throw new \Exception('Invalid environment code!');
            }
        } else {
            foreach ($environments as $type => $environment) {
                $choices[$type] = $environment['name'];

$choices was never initialized. Although not strictly required by PHP, it is generally a good practice to add $choices = array(); before regardless.

            }

            $questionHelper = $this->getHelper('question');
            $question = new ChoiceQuestion('<info>Which environment install?</info>', $choices, false);

The variable $choices does not seem to be defined for all execution paths leading up to this point.

            $type = $questionHelper->ask($input, $output, $question);
        }

        if (!isset($environments[$type]['path'])) {
            throw new \Exception('Environment path not found!');
        }

        $this->type = $type;
        $this->dir = $dir . '/' . $environments[$type]['path'];
        $this->config = include $this->dir . '/config.php';
    }

    /**
     * {@inheritdoc}
     */
    protected function execute(InputInterface $input, OutputInterface $output)
    {
        foreach ($this->bootstrap as $method) {
            $this->$method($input, $output);
        }

        foreach ($this->config as $config => $settings) {
            $method = 'configure' . ucfirst($config);

            if (!in_array($method, $this->bootstrap) && method_exists($this, $method)) {
                $output->writeln('<comment>Setup "' . $config . '"</comment>');
                $this->$method($input, $output, $settings);
            }
        }
    }

    /**
     * Copy files and directories from the environment directory to application.
     *
     * @param InputInterface $input
     * @param OutputInterface $output
     */
    protected function copyFiles(InputInterface $input, OutputInterface $output)

The parameter $input is not used and could be removed.

    {
        $output->writeln('<comment>Copy files from the environment directory</comment>');

        $fs = new Filesystem();

        $directoryIterator = new \RecursiveDirectoryIterator($this->dir, \RecursiveDirectoryIterator::SKIP_DOTS);
        $iterator = new \RecursiveIteratorIterator($directoryIterator, \RecursiveIteratorIterator::SELF_FIRST);

        foreach ($iterator as $item) {
            if (in_array($iterator->getSubPathName(), $this->excludedFiles)) {
                continue;
            }

            $itemPath = $this->getApplication()->getRoot() . '/' . $iterator->getSubPathName();

            if ($item->isDir()) {
                $fs->mkdir($itemPath);
            } else {
                $fs->copy($item, $itemPath, true);
            }

            $output->writeln('   ' . $itemPath);
        }
    }

    protected function initializeBitrix()
    {
        $this->getApplication()->initializeBitrix();

        $connections = Configuration::getValue('connections');

        foreach ($connections as $name => $parameters) {
            Application::getInstance()->getConnectionPool()->cloneConnection($name, $name, $parameters);
        }
    }

    /**
     * Sets license key Bitrix CMS.
     *
     * @param InputInterface $input
     * @param OutputInterface $output
     * @param string $licenseKey
     */
    protected function configureLicenseKey(InputInterface $input, OutputInterface $output, $licenseKey)

The parameter $input is not used and could be removed.

The parameter $output is not used and could be removed.

    {
        if (!is_string($licenseKey)) {
            throw new \InvalidArgumentException('Config "licenseKey" must be string type.');
        }

        $licenseFileContent = "<" . "? $" . "LICENSE_KEY = \"" . EscapePHPString($licenseKey) . "\"; ?" . ">";
        File::putFileContents(Application::getDocumentRoot() . BX_ROOT . '/license_key.php', $licenseFileContent);
    }

    /**
     * Installation modules.
     *
     * @param InputInterface $input
     * @param OutputInterface $output
     * @param array $modules
     * @throws BitrixException
     * @throws \LogicException
     * @throws ModuleException
     */
    protected function configureModules(InputInterface $input, OutputInterface $output, array $modules)

The parameter $input is not used and could be removed.

    {
        $app = $this->getApplication();
        if ($app->getConfiguration()) {
            $app->addCommands(ModuleCommand::getCommands());
            if ($app->getBitrixStatus() != \Notamedia\ConsoleJedi\Application\Application::BITRIX_STATUS_COMPLETE) {
                throw new BitrixException('Bitrix core is not available');
            }
        } else {
            throw new BitrixException('No configuration loaded');
        }

        if (!is_array($modules)) {
            throw new \LogicException('Incorrect modules configuration');
        }

        if (!count($modules)) {
            return;
        }

        $bar = new ProgressBar($output, count($modules));
        $bar->setRedrawFrequency(1);
        $bar->setFormat('verbose');

        foreach ($modules as $moduleName) {
            $message = "\r" . '   module:load ' . $moduleName . ': ';

            try {
                if (isset($bar)) {
                    $bar->setMessage($message);
                    $bar->display();
                }

                (new Module($moduleName))->load()->register();

                $bar->clear();
                $output->writeln($message . '<info>ok</info>');
            } catch (ModuleInstallException $e) {
                $bar->clear();
                $output->writeln($e->getMessage(), OutputInterface::VERBOSITY_VERBOSE);
                $output->writeln($message . '<comment>not registered</comment> (install it in admin panel)');
            } catch (ModuleException $e) {
                $bar->clear();
                $output->writeln($e->getMessage(), OutputInterface::VERBOSITY_VERBOSE);
                $output->writeln($message . '<error>FAILED</error>');
            }
            $bar->advance();
        }
        $bar->finish();
        $bar->clear();
        $output->write("\r");
    }

    /**
     * Sets configs to .settings.php.
     *
     * @param InputInterface $input
     * @param OutputInterface $output
     * @param array $settings
     */
    protected function configureSettings(InputInterface $input, OutputInterface $output, array $settings)

The parameter $input is not used and could be removed.

The parameter $output is not used and could be removed.

    {
        $configuration = Configuration::getInstance();

        foreach ($settings as $name => $value) {
            $configuration->setValue($name, $value);
        }
    }

    /**
     * Installation config to module "cluster".
     *
     * @param InputInterface $input
     * @param OutputInterface $output
     * @param array $cluster
     *
     * @throws \Bitrix\Main\LoaderException
     * @throws \Exception
     */
    protected function configureCluster(InputInterface $input, OutputInterface $output, array $cluster)
    {
        global $APPLICATION;

Use of global functionality is not recommended; it makes your code harder to test, and less reusable.

        if (!Loader::includeModule('cluster')) {
            throw new \Exception('Failed to load module "cluster"');
        }

        $memcache = new \CClusterMemcache;

        if (isset($cluster['memcache'])) {
            $output->writeln('   <comment>memcache</comment>');

            if (!is_array($cluster['memcache'])) {
                throw new \Exception('Server info must be an array');
            }

            $rsServers = $memcache->GetList();

            while ($server = $rsServers->Fetch()) {
                $memcache->Delete($server['ID']);
            }

            foreach ($cluster['memcache'] as $index => $server) {
                $serverId = $memcache->Add($server);

                if ($serverId && !$input->getOption('memcache-cold-start')) {
                    $memcache->Resume($serverId);
                } else {
                    $exception = $APPLICATION->GetException();
                    $message = 'Invalid memcache config with index ' . $index;

                    if ($exception->GetString()) {
                        $message = str_replace('<br>', "\n", $exception->GetString());
                    }

                    $output->writeln('<error>' . $message . '</error>');
                }
            }
        }
    }

    /**
     * Installation of option modules.
     *
     * @param InputInterface $input
     * @param OutputInterface $output
     * @param array $options
     */
    protected function configureOptions(InputInterface $input, OutputInterface $output, array $options)

The parameter $input is not used and could be removed.

    {
        if (empty($options)) {
            return;
        }

        foreach ($options as $module => $moduleOptions) {
            if (!is_array($moduleOptions) || empty($moduleOptions)) {
                continue;
            }

            foreach ($moduleOptions as $code => $value) {
                if (is_array($value)) {
                    if (isset($value['value']) && isset($value['siteId'])) {
                        Option::set($module, $code, $value['value'], $value['siteId']);
                    } else {
                        $output->writeln('<error>Invalid option for module "' . $module . '" with code "' . $code . '"</error>');
                    }
                } else {
                    Option::set($module, $code, $value);

                    $output->writeln('   option: "' . $code . '", module: "' . $module . '"');
                }
            }
        }
    }

    /**
     * Gets type of initialized environment.
     * 
     * @return string
     */
    public function getType()
    {
        return $this->type;
    }
}