IndexerSetDimensionsModeCommand.php 7.38 KB
Newer Older
Ketan's avatar
Ketan committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207
<?php
/**
 * Copyright © Magento, Inc. All rights reserved.
 * See COPYING.txt for license details.
 */
declare(strict_types=1);

namespace Magento\Indexer\Console\Command;

use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Input\InputArgument;
use Magento\Framework\App\ObjectManagerFactory;
use Magento\Framework\App\Config\ScopeConfigInterface;
use Magento\Framework\Console\Cli;
use Magento\Indexer\Model\ModeSwitcherInterface;

/**
 * Command to set indexer dimensions mode
 */
class IndexerSetDimensionsModeCommand extends AbstractIndexerCommand
{
    const INPUT_KEY_MODE = 'mode';
    const INPUT_KEY_INDEXER = 'indexer';
    const DIMENSION_MODE_NONE = 'none';
    const XML_PATH_DIMENSIONS_MODE_MASK = 'indexer/%s/dimensions_mode';

    /**
     * @var string
     */
    private $commandName = 'indexer:set-dimensions-mode';

    /**
     * ScopeConfigInterface
     *
     * @var ScopeConfigInterface
     */
    private $configReader;

    /**
     * @var ModeSwitcherInterface[]
     */
    private $dimensionProviders;

    /**
     * @param ObjectManagerFactory $objectManagerFactory
     * @param ScopeConfigInterface $configReader
     * @param ModeSwitcherInterface[] $dimensionSwitchers
     */
    public function __construct(
        ObjectManagerFactory $objectManagerFactory,
        ScopeConfigInterface $configReader,
        array $dimensionSwitchers
    ) {
        $this->configReader = $configReader;
        $this->dimensionProviders = $dimensionSwitchers;
        parent::__construct($objectManagerFactory);
    }

    /**
     * {@inheritdoc}
     */
    protected function configure()
    {
        $this->setName($this->commandName)
            ->setDescription('Set Indexer Dimensions Mode')
            ->setDefinition($this->getInputList());
        parent::configure();
    }

    /**
     * {@inheritdoc}
     * @param InputInterface $input
     * @param OutputInterface $output
     * @return int
     */
    protected function execute(InputInterface $input, OutputInterface $output)
    {
        $errors = $this->validate($input);
        if ($errors) {
            throw new \InvalidArgumentException(implode(PHP_EOL, $errors));
        }
        $returnValue = Cli::RETURN_SUCCESS;
        /** @var \Magento\Indexer\Model\Indexer $indexer */
        $indexer = $this->getObjectManager()->get(\Magento\Indexer\Model\Indexer::class);
        try {
            $selectedIndexer = (string)$input->getArgument(self::INPUT_KEY_INDEXER);
            if (!$selectedIndexer) {
                $this->showAvailableModes($output);
            } else {
                $indexer->load($selectedIndexer);
                $currentMode = $input->getArgument(self::INPUT_KEY_MODE);
                $configPath = sprintf(self::XML_PATH_DIMENSIONS_MODE_MASK, $selectedIndexer);
                $previousMode = $this->configReader->getValue($configPath) ?: self::DIMENSION_MODE_NONE;
                if ($previousMode !== $currentMode) {
                    /** @var ModeSwitcherInterface $modeSwitcher */
                    $modeSwitcher = $this->dimensionProviders[$selectedIndexer];
                    // Switch dimensions mode
                    $modeSwitcher->switchMode($currentMode, $previousMode);
                    $output->writeln(
                        'Dimensions mode for indexer "' . $indexer->getTitle() . '" was changed from \''
                        . $previousMode . '\' to \'' . $currentMode . '\''
                    );
                } else {
                    $output->writeln('Dimensions mode for indexer "' . $indexer->getTitle() . '" has not been changed');
                }
            }
        } catch (\Exception $e) {
            $output->writeln('"' . $indexer->getTitle() . '" indexer process unknown error:' . PHP_EOL);
            $output->writeln($e->getMessage() . PHP_EOL);
            // we must have an exit code higher than zero to indicate something was wrong
            $returnValue = Cli::RETURN_FAILURE;
        }

        return $returnValue;
    }

    /**
     * Display all available indexers and modes
     *
     * @param OutputInterface $output
     * @return void
     */
    private function showAvailableModes(OutputInterface $output)
    {
        $output->writeln(sprintf('%-50s', 'Indexer') . 'Available modes');
        foreach ($this->dimensionProviders as $indexer => $provider) {
            $availableModes = implode(',', array_keys($provider->getDimensionModes()->getDimensions()));
            $output->writeln(sprintf('%-50s', $indexer) . $availableModes);
        }
    }

    /**
     * Get list of arguments for the command
     *
     * @return InputArgument[]
     */
    private function getInputList(): array
    {
        $dimensionProvidersList = array_keys($this->dimensionProviders);
        $indexerOptionDescription = 'Indexer name [' . implode('|', $dimensionProvidersList) . ']';
        $arguments[] = new InputArgument(
            self::INPUT_KEY_INDEXER,
            InputArgument::OPTIONAL,
            $indexerOptionDescription
        );
        $modeOptionDescription = 'Indexer dimension modes' . PHP_EOL;
        foreach ($this->dimensionProviders as $indexer => $provider) {
            $availableModes = implode(',', array_keys($provider->getDimensionModes()->getDimensions()));
            $modeOptionDescription .= sprintf('%-30s ', $indexer) . $availableModes . PHP_EOL;
        }
        $arguments[] = new InputArgument(
            self::INPUT_KEY_MODE,
            InputArgument::OPTIONAL,
            $modeOptionDescription
        );

        return $arguments;
    }

    /**
     * Check if all arguments are provided
     *
     * @param InputInterface $input
     * @return string[]
     */
    private function validate(InputInterface $input): array
    {
        $errors = [];
        $inputIndexer = (string)$input->getArgument(self::INPUT_KEY_INDEXER);
        if ($inputIndexer) {
            $acceptedValues = array_keys($this->dimensionProviders);
            $errors = $this->validateArgument(self::INPUT_KEY_INDEXER, $inputIndexer, $acceptedValues);
            if (!$errors) {
                $inputIndexerDimensionMode = (string)$input->getArgument(self::INPUT_KEY_MODE);
                /** @var ModeSwitcherInterface $modeSwitcher */
                $modeSwitcher = $this->dimensionProviders[$inputIndexer];
                $acceptedValues = array_keys($modeSwitcher->getDimensionModes()->getDimensions());
                $errors = $this->validateArgument(self::INPUT_KEY_MODE, $inputIndexerDimensionMode, $acceptedValues);
            }
        }

        return $errors;
    }

    /**
     * Validate command argument and return errors in case if argument is invalid
     *
     * @param string $inputKey
     * @param string $inputIndexer
     * @param array $acceptedValues
     * @return string[]
     */
    private function validateArgument(string $inputKey, string $inputIndexer, array $acceptedValues): array
    {
        $errors = [];
        $acceptedIndexerValues = ' Accepted values for "<' . $inputKey . '>" are \'' .
            implode(',', $acceptedValues) . '\'';
        if (!$inputIndexer) {
            $errors[] = 'Missing argument "<' . $inputKey . '>".' . $acceptedIndexerValues;
        } elseif (!\in_array($inputIndexer, $acceptedValues)) {
            $errors[] = 'Invalid value for "<' . $inputKey . '>" argument.' . $acceptedIndexerValues;
        }

        return $errors;
    }
}