DeployStrategyProvider.php 5.4 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
<?php
/**
 * Copyright © Magento, Inc. All rights reserved.
 * See COPYING.txt for license details.
 */

namespace Magento\Deploy\Model;

use Magento\Deploy\Model\Deploy\DeployInterface;
use Magento\Framework\Component\ComponentRegistrar;
use Magento\Framework\Module\Dir;
use Magento\Framework\View\Design\Fallback\Rule\RuleInterface;
use Magento\Framework\View\DesignInterface;
use Magento\Framework\View\Design\Fallback\RulePool;
use Symfony\Component\Console\Output\OutputInterface;

class DeployStrategyProvider
{
    /**
     * @var RulePool
     */
    private $rulePool;

    /**
     * @var RuleInterface
     */
    private $fallBackRule;

    /**
     * @var array
     */
    private $moduleDirectories;

    /**
     * @var DesignInterface
     */
    private $design;

    /**
     * @var OutputInterface
     */
    private $output;

    /**
     * @var array
     */
    private $options;

    /**
     * @var DeployStrategyFactory
     */
    private $deployStrategyFactory;

    /**
     * @param OutputInterface $output
     * @param RulePool $rulePool
     * @param DesignInterface $design
     * @param DeployStrategyFactory $deployStrategyFactory
     * @param array $options
     */
    public function __construct(
        OutputInterface $output,
        RulePool $rulePool,
        DesignInterface $design,
        DeployStrategyFactory $deployStrategyFactory,
        array $options
    ) {
        $this->rulePool = $rulePool;
        $this->design = $design;
        $this->output = $output;
        $this->options = $options;
        $this->deployStrategyFactory = $deployStrategyFactory;
    }

    /**
     * @param string $area
     * @param string $themePath
     * @param array $locales
     * @return DeployInterface[]
     */
    public function getDeployStrategies($area, $themePath, array $locales)
    {
        if (count($locales) == 1) {
            $locale = current($locales);
            return [$locale => $this->getDeployStrategy(DeployStrategyFactory::DEPLOY_STRATEGY_STANDARD)];
        }

        $baseLocale = null;
        $deployStrategies = [];

        foreach ($locales as $locale) {
            $hasCustomization = false;
            foreach ($this->getCustomizationDirectories($area, $themePath, $locale) as $directory) {
                if (glob($directory . DIRECTORY_SEPARATOR . '*', GLOB_NOSORT)) {
                    $hasCustomization = true;
                    break;
                }
            }
            if ($baseLocale === null && !$hasCustomization) {
                $baseLocale = $locale;
            } else {
                $deployStrategies[$locale] = $hasCustomization
                    ? DeployStrategyFactory::DEPLOY_STRATEGY_STANDARD
                    : DeployStrategyFactory::DEPLOY_STRATEGY_QUICK;
            }
        }
        $deployStrategies = array_merge(
            [$baseLocale => DeployStrategyFactory::DEPLOY_STRATEGY_STANDARD],
            $deployStrategies
        );

        return array_map(function ($strategyType) use ($area, $baseLocale) {
            return $this->getDeployStrategy($strategyType, $baseLocale);
        }, $deployStrategies);
    }

    /**
     * @param array $params
     * @return array
     */
    private function getLocaleDirectories($params)
    {
        $dirs = $this->getFallbackRule()->getPatternDirs($params);

        return array_filter($dirs, function ($dir) {
            return strpos($dir, Dir::MODULE_I18N_DIR);
        });
    }

    /**
     * Get directories which can contains theme customization
     * @param string $area
     * @param string $themePath
     * @param string $locale
     * @return array
     */
    private function getCustomizationDirectories($area, $themePath, $locale)
    {
        $customizationDirectories = [];
        $this->design->setDesignTheme($themePath, $area);

        $params = ['area' => $area, 'theme' => $this->design->getDesignTheme(), 'locale' => $locale];
        foreach ($this->getLocaleDirectories($params) as $patternDir) {
            $customizationDirectories[] = $patternDir;
        }

        if ($this->moduleDirectories === null) {
            $this->moduleDirectories = [];
            $componentRegistrar = new ComponentRegistrar();
            $this->moduleDirectories = array_keys($componentRegistrar->getPaths(ComponentRegistrar::MODULE));
        }

        foreach ($this->moduleDirectories as $moduleDir) {
            $params['module_name'] = $moduleDir;
            $patternDirs = $this->getLocaleDirectories($params);
            foreach ($patternDirs as $patternDir) {
                $customizationDirectories[] = $patternDir;
            }
        }

        return $customizationDirectories;
    }

    /**
     * @return \Magento\Framework\View\Design\Fallback\Rule\RuleInterface
     */
    private function getFallbackRule()
    {
        if (null === $this->fallBackRule) {
            $this->fallBackRule = $this->rulePool->getRule(RulePool::TYPE_STATIC_FILE);
        }

        return $this->fallBackRule;
    }

    /**
     * @param string $type
     * @param null|string $baseLocale
     * @return DeployInterface
     */
    private function getDeployStrategy($type, $baseLocale = null)
    {
        $options = $this->options;
        if ($baseLocale) {
            $options[DeployInterface::DEPLOY_BASE_LOCALE] = $baseLocale;
        }

        return $this->deployStrategyFactory->create(
            $type,
            ['output' => $this->output, 'options' => $options]
        );
    }
}