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

namespace PrestaShopBundle\Command;

use DOMDocument;
use Employee;
use Exception;
use PrestaShop\PrestaShop\Adapter\LegacyContext;
use PrestaShop\PrestaShop\Core\Hook\Extractor\HookExtractor;
use PrestaShop\PrestaShop\Core\Hook\Generator\HookDescriptionGenerator;
use PrestaShop\PrestaShop\Core\Hook\HookDescription;
use PrestaShop\PrestaShop\Core\Hook\Provider\GridDefinitionHookByServiceIdsProvider;
use PrestaShop\PrestaShop\Core\Hook\Provider\IdentifiableObjectHookByFormTypeProvider;
use SimpleXMLElement;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Style\SymfonyStyle;

/**
 * This command is used for appending the hook names in the configuration file.
 */
class AppendConfigurationFileHooksListCommand extends Command
{
    public function __construct(
        private string $env,
        private readonly HookExtractor $hookExtractor,
        private LegacyContext $legacyContext,
        private GridDefinitionHookByServiceIdsProvider $gridDefinitionHookByServiceIdsProvider,
        private IdentifiableObjectHookByFormTypeProvider $identifiableObjectHookByFormTypeProvider,
        private HookDescriptionGenerator $hookDescriptionGenerator,
        private array $serviceIds,
        private array $optionFormHookNames,
        private array $formTypes,
        private string $hookFile
    ) {
        parent::__construct();
    }

    /**
     * {@inheritdoc}
     */
    protected function configure()
    {
        $this
            ->setName('prestashop:update:configuration-file-hooks-listing')
            ->setDescription('Appends configuration file hooks list')
        ;
    }

    protected function execute(InputInterface $input, OutputInterface $output): int
    {
        $this->initContext();

        $io = new SymfonyStyle($input, $output);

        if (!in_array($this->env, ['dev', 'test'])) {
            $io->warning('Dev or test environment is required to fully list all the hooks');

            return 1;
        }

        // Parse all the hooks from the codebase
        $hooks = $this->hookExtractor->findHooks();
        // Reformat them to only get the information needed for the xml file
        $fixtureHooks = [];
        foreach ($hooks as $hook) {
            // This is used to filter out the hooks with placeholders
            if (preg_match('/<[^>]+>/', $hook['hook']) > 0) {
                continue;
            }
            $fixtureHooks[$hook['hook']] = [
                'hook' => $hook['hook'],
                'description' => $hook['description'],
                'title' => $hook['title'],
            ];
        }

        // Get the dynamic hooks information
        $hooksName = $this->getHookNames();
        $hookDescriptions = $this->getHookDescriptions($hooksName);

        foreach ($hookDescriptions as $hookDescription) {
            if (isset($fixtureHooks[$hookDescription->getName()])) {
                continue;
            }
            $fixtureHooks[$hookDescription->getName()] = [
                'hook' => $hookDescription->getName(),
                'description' => $hookDescription->getDescription(),
                'title' => $hookDescription->getTitle(),
            ];
        }

        try {
            $addedHooks = $this->appendHooksInConfigurationFile($fixtureHooks);
        } catch (Exception $e) {
            $io->error($e->getMessage());
        }

        if (!empty($addedHooks)) {
            $io->title('Hooks added to configuration file');
            $io->note(sprintf('Total hooks added: %s', count($addedHooks)));

            return 0;
        }

        $io->note('No new hooks have been added to configuration file');

        return 0;
    }

    /**
     * Initialize PrestaShop Context
     */
    private function initContext()
    {
        // We need to have an employee or the listing hooks don't work
        // see LegacyHookSubscriber
        if (!$this->legacyContext->getContext()->employee) {
            // Even a non existing employee is fine
            $this->legacyContext->getContext()->employee = new Employee();
        }
    }

    /**
     * Gets all hooks names which need to be appended.
     *
     * @return string[]
     */
    private function getHookNames()
    {
        $gridDefinitionHookNames = $this->gridDefinitionHookByServiceIdsProvider->getHookNames($this->serviceIds);

        $identifiableObjectHookNames = $this->identifiableObjectHookByFormTypeProvider->getHookNames($this->formTypes);

        return array_merge(
            $identifiableObjectHookNames,
            $this->optionFormHookNames,
            $gridDefinitionHookNames
        );
    }

    /**
     * Appends given hooks in the configuration file.
     *
     * @param array $hooks
     *
     * @return array
     *
     * @throws Exception
     */
    private function appendHooksInConfigurationFile(array $hooks)
    {
        if (!file_exists($this->hookFile)) {
            throw new Exception(sprintf('File %s has not been found', $this->hookFile));
        }

        $hookFileContent = file_get_contents($this->hookFile);

        $xmlFileContent = new SimpleXMLElement($hookFileContent);

        if (!isset($xmlFileContent->entities, $xmlFileContent->entities->hook)) {
            return [];
        }

        $existingHookNames = $this->filterExistingHookNames($xmlFileContent->entities->hook);

        $addedHooks = [];
        foreach ($hooks as $hook) {
            if (in_array($hook['hook'], $existingHookNames)) {
                continue;
            }

            $hookXmlElement = $xmlFileContent->entities->addChild('hook');

            $hookXmlElement->addAttribute('id', $hook['hook']);
            $hookXmlElement->addChild('name', $hook['hook']);
            $hookXmlElement->addChild('title', $hook['title']);
            $hookXmlElement->addChild('description', $hook['description']);

            $addedHooks[] = $hookXmlElement;
        }

        $xmlContent = $xmlFileContent->asXML();
        if (empty($xmlContent)) {
            throw new Exception(sprintf('Failed to save new xml content to file %s', $this->hookFile));
        }

        $dom = new DOMDocument('1.0');
        $dom->preserveWhiteSpace = false;
        $dom->formatOutput = true;
        $dom->loadXML($xmlContent);

        $formattedXMLContent = $dom->saveXML();
        file_put_contents($this->hookFile, $formattedXMLContent);

        return $addedHooks;
    }

    /**
     * Gets existing hook names which are already defined in the file.
     *
     * @param SimpleXMLElement $hooksFromXmlFile
     *
     * @return array
     */
    private function filterExistingHookNames(SimpleXMLElement $hooksFromXmlFile)
    {
        $hookNames = [];
        foreach ($hooksFromXmlFile as $hook) {
            if (!isset($hook->name)) {
                continue;
            }

            $hookNames[] = $hook->name->__toString();
        }

        return $hookNames;
    }

    /**
     * Gets hook descriptions
     *
     * @param array $hookNames
     *
     * @return HookDescription[]
     */
    private function getHookDescriptions(array $hookNames)
    {
        $descriptions = [];
        foreach ($hookNames as $hookName) {
            $hookDescription = $this->hookDescriptionGenerator->generate($hookName);

            $descriptions[] = $hookDescription;
        }

        return $descriptions;
    }
}