Less.php 7.18 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 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225
<?php
/**
 * Copyright © Magento, Inc. All rights reserved.
 * See COPYING.txt for license details.
 */
namespace Magento\Deploy\Package\Processor\PreProcessor;

use Magento\Deploy\Console\DeployStaticOptions;
use Magento\Deploy\Package\Package;
use Magento\Deploy\Package\PackageFile;
use Magento\Deploy\Package\Processor\ProcessorInterface;
use Magento\Deploy\Service\DeployStaticFile;
use Magento\Framework\View\Asset\PreProcessor\FileNameResolver;
use Magento\Framework\View\Asset\Minification;
use Magento\Framework\Css\PreProcessor\Instruction\Import;
use Magento\Framework\View\Asset\NotationResolver;
use Magento\Framework\View\Asset\Repository;

/**
 * Pre-processor for speeding up deployment of Less files
 *
 * LESS-to-CSS compilation should happen only when it is really needed. If in some package there is no LESS files
 * overridden which used for generating some CSS file, then such CSS file can be copied from ancestor package as is
 */
class Less implements ProcessorInterface
{
    /**
     * Resolver allows to distinguish "root" LESS files from "imported" LESS files
     *
     * @var FileNameResolver
     */
    private $fileNameResolver;

    /**
     * @var \Magento\Framework\View\Asset\NotationResolver\Module
     */
    private $notationResolver;

    /**
     * @var DeployStaticFile
     */
    private $deployStaticFile;

    /**
     * @var Minification
     */
    private $minification;

    /**
     * Deployment procedure options
     *
     * @var array
     */
    private $options = [];

    /**
     * @var array
     */
    private $map = [];

    /**
     * Less constructor
     *
     * @param FileNameResolver $fileNameResolver
     * @param NotationResolver\Module $notationResolver
     * @param DeployStaticFile $deployStaticFile
     * @param Minification $minification
     */
    public function __construct(
        FileNameResolver $fileNameResolver,
        NotationResolver\Module $notationResolver,
        DeployStaticFile $deployStaticFile,
        Minification $minification
    ) {
        $this->fileNameResolver = $fileNameResolver;
        $this->notationResolver = $notationResolver;
        $this->deployStaticFile = $deployStaticFile;
        $this->minification = $minification;
    }

    /**
     * @inheritdoc
     */
    public function process(Package $package, array $options)
    {
        $this->options = $options;
        if ($this->options[DeployStaticOptions::NO_CSS] === true) {
            return false;
        }
        if ($package->getArea() !== Package::BASE_AREA && $package->getTheme() !== Package::BASE_THEME) {
            $files = $package->getParentFiles('less');
            foreach ($files as $file) {
                $packageFile = $package->getFile($file->getFileId());
                if ($packageFile && $packageFile->getOrigPackage() === $package) {
                    continue;
                }
                $deployFileName = $this->fileNameResolver->resolve($file->getFileName());
                if ($deployFileName !== $file->getFileName()) {
                    if ($this->hasOverrides($file, $package)) {
                        $file = clone $file;
                        $file->setArea($package->getArea());
                        $file->setTheme($package->getTheme());
                        $file->setLocale($package->getLocale());

                        $file->setPackage($package);
                        $package->addFileToMap($file);
                    }
                }
            }
        }
        return true;
    }

    /**
     * Checks if there are LESS files in current package which used for generating given CSS file from parent package
     *
     * If true then such CSS file must be re-compiled for current package to use overridden LESS files
     *
     * @param PackageFile $parentFile
     * @param Package $package
     * @return bool
     */
    private function hasOverrides(PackageFile $parentFile, Package $package)
    {
        $map = $this->buildMap(
            $parentFile->getFilePath(),
            $parentFile->getPackage()->getPath(),
            $parentFile->getExtension()
        );
        /** @var PackageFile[] $currentPackageFiles */
        $currentPackageFiles = array_merge($package->getFilesByType('less'), $package->getFilesByType('css'));

        foreach ($currentPackageFiles as $file) {
            if ($this->inParentFiles($file->getDeployedFileName(), $parentFile->getFileName(), $map)) {
                return true;
            }
        }
        return false;
    }

    /**
     * @param string  $fileName
     * @param string  $parentFile
     * @param array $map
     * @return bool
     */
    private function inParentFiles($fileName, $parentFile, $map)
    {
        if (isset($map[$parentFile])) {
            if (in_array($fileName, $map[$parentFile])) {
                return true;
            } else {
                foreach ($map[$parentFile] as $pFile) {
                    return $this->inParentFiles($fileName, $pFile, $map);
                }
            }
        }
        return false;
    }

    /**
     * Build map of imported files
     *
     * @param string $filePath
     * @param string $packagePath
     * @param string $contentType
     * @return array
     */
    private function buildMap($filePath, $packagePath, $contentType)
    {
        $content = $this->deployStaticFile->readTmpFile($filePath, $packagePath);
        $replaceCallback = function ($matchedContent) use ($filePath, $packagePath, $contentType) {
            $matchedFileId = $matchedContent['path'];
            if (!pathinfo($matchedContent['path'], PATHINFO_EXTENSION)) {
                $matchedFileId .= '.' . $contentType;
            }
            if (strpos($matchedFileId, Repository::FILE_ID_SEPARATOR) !== false) {
                $basePath = $packagePath;
            } else {
                $basePath = pathinfo($filePath, PATHINFO_DIRNAME);
            }
            $resolvedPath = str_replace(Repository::FILE_ID_SEPARATOR, '/', $matchedFileId);
            if (strpos($resolvedPath, '@{baseUrl}') === 0) {
                $resolvedMapPath = str_replace('@{baseUrl}', '', $resolvedPath);
            } else {
                $resolvedMapPath = $this->normalizePath($basePath . '/' . $resolvedPath);
            }
            if (!isset($this->map[$filePath])) {
                $this->map[$filePath] = [];
            }
            $this->map[$filePath][] = $resolvedMapPath;
            $this->buildMap($resolvedMapPath, $packagePath, $contentType);
        };
        if ($content) {
            preg_replace_callback(Import::REPLACE_PATTERN, $replaceCallback, $content);
        }
        return $this->map;
    }

    /**
     * Return normalized path
     *
     * @param string $path
     * @return string
     */
    private function normalizePath($path)
    {
        if (strpos($path, '/../') === false) {
            return $path;
        }
        $pathParts = explode('/', $path);
        $realPath = [];
        foreach ($pathParts as $pathPart) {
            if ($pathPart == '.') {
                continue;
            }
            if ($pathPart == '..') {
                array_pop($realPath);
                continue;
            }
            $realPath[] = $pathPart;
        }
        return implode('/', $realPath);
    }
}