AssetController.php 23.1 KB
Newer Older
Qiang Xue committed
1 2 3 4 5 6 7 8 9 10 11 12
<?php
/**
 * @link http://www.yiiframework.com/
 * @copyright Copyright (c) 2008 Yii Software LLC
 * @license http://www.yiiframework.com/license/
 */

namespace yii\console\controllers;

use Yii;
use yii\console\Exception;
use yii\console\Controller;
13
use yii\helpers\VarDumper;
Qiang Xue committed
14 15

/**
16
 * Allows you to combine and compress your JavaScript and CSS files.
17
 *
18
 * Usage:
19 20
 * 1. Create a configuration file using the `template` action:
 *
21
 *    yii asset/template /path/to/myapp/config.php
22
 *
23 24
 * 2. Edit the created config file, adjusting it for your web application needs.
 * 3. Run the 'compress' action, using created config:
25
 *
26
 *    yii asset /path/to/myapp/config.php /path/to/myapp/config/assets_compressed.php
27
 *
28 29
 * 4. Adjust your web application config to use compressed assets.
 *
30
 * Note: in the console environment some path aliases like `@webroot` and `@web` may not exist,
31 32 33 34 35
 * so corresponding paths inside the configuration should be specified directly.
 *
 * Note: by default this command relies on an external tools to perform actual files compression,
 * check [[jsCompressor]] and [[cssCompressor]] for more details.
 *
36 37
 * @property \yii\web\AssetManager $assetManager Asset manager instance. Note that the type of this property
 * differs in getter and setter. See [[getAssetManager()]] and [[setAssetManager()]] for details.
38
 *
Qiang Xue committed
39 40 41
 * @author Qiang Xue <qiang.xue@gmail.com>
 * @since 2.0
 */
42
class AssetController extends Controller
Qiang Xue committed
43
{
44 45 46 47 48 49 50 51 52 53 54 55 56 57 58
    /**
     * @var string controller default action ID.
     */
    public $defaultAction = 'compress';
    /**
     * @var array list of asset bundles to be compressed.
     */
    public $bundles = [];
    /**
     * @var array list of asset bundles, which represents output compressed files.
     * You can specify the name of the output compressed file using 'css' and 'js' keys:
     * For example:
     *
     * ~~~
     * 'app\config\AllAsset' => [
59 60
     *     'js' => 'js/all-{hash}.js',
     *     'css' => 'css/all-{hash}.css',
61 62 63 64
     *     'depends' => [ ... ],
     * ]
     * ~~~
     *
65
     * File names can contain placeholder "{hash}", which will be filled by the hash of the resulting file.
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
     */
    public $targets = [];
    /**
     * @var string|callable JavaScript file compressor.
     * If a string, it is treated as shell command template, which should contain
     * placeholders {from} - source file name - and {to} - output file name.
     * Otherwise, it is treated as PHP callback, which should perform the compression.
     *
     * Default value relies on usage of "Closure Compiler"
     * @see https://developers.google.com/closure/compiler/
     */
    public $jsCompressor = 'java -jar compiler.jar --js {from} --js_output_file {to}';
    /**
     * @var string|callable CSS file compressor.
     * If a string, it is treated as shell command template, which should contain
     * placeholders {from} - source file name - and {to} - output file name.
     * Otherwise, it is treated as PHP callback, which should perform the compression.
     *
     * Default value relies on usage of "YUI Compressor"
     * @see https://github.com/yui/yuicompressor/
     */
    public $cssCompressor = 'java -jar yuicompressor.jar --type css {from} -o {to}';

    /**
     * @var array|\yii\web\AssetManager [[\yii\web\AssetManager]] instance or its array configuration, which will be used
     * for assets processing.
     */
    private $_assetManager = [];

95

96 97 98
    /**
     * Returns the asset manager instance.
     * @throws \yii\console\Exception on invalid configuration.
99
     * @return \yii\web\AssetManager asset manager instance.
100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121
     */
    public function getAssetManager()
    {
        if (!is_object($this->_assetManager)) {
            $options = $this->_assetManager;
            if (!isset($options['class'])) {
                $options['class'] = 'yii\\web\\AssetManager';
            }
            if (!isset($options['basePath'])) {
                throw new Exception("Please specify 'basePath' for the 'assetManager' option.");
            }
            if (!isset($options['baseUrl'])) {
                throw new Exception("Please specify 'baseUrl' for the 'assetManager' option.");
            }
            $this->_assetManager = Yii::createObject($options);
        }

        return $this->_assetManager;
    }

    /**
     * Sets asset manager instance or configuration.
122 123
     * @param \yii\web\AssetManager|array $assetManager asset manager instance or its array configuration.
     * @throws \yii\console\Exception on invalid argument type.
124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147
     */
    public function setAssetManager($assetManager)
    {
        if (is_scalar($assetManager)) {
            throw new Exception('"' . get_class($this) . '::assetManager" should be either object or array - "' . gettype($assetManager) . '" given.');
        }
        $this->_assetManager = $assetManager;
    }

    /**
     * Combines and compresses the asset files according to the given configuration.
     * During the process new asset bundle configuration file will be created.
     * You should replace your original asset bundle configuration with this file in order to use compressed files.
     * @param string $configFile configuration file name.
     * @param string $bundleFile output asset bundles configuration file name.
     */
    public function actionCompress($configFile, $bundleFile)
    {
        $this->loadConfiguration($configFile);
        $bundles = $this->loadBundles($this->bundles);
        $targets = $this->loadTargets($this->targets, $bundles);
        foreach ($targets as $name => $target) {
            echo "Creating output bundle '{$name}':\n";
            if (!empty($target->js)) {
148
                $this->buildTarget($target, 'js', $bundles);
149 150
            }
            if (!empty($target->css)) {
151
                $this->buildTarget($target, 'css', $bundles);
152 153 154 155 156 157 158 159 160 161
            }
            echo "\n";
        }

        $targets = $this->adjustDependency($targets, $bundles);
        $this->saveTargets($targets, $bundleFile);
    }

    /**
     * Applies configuration from the given file to self instance.
162
     * @param string $configFile configuration file name.
163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180
     * @throws \yii\console\Exception on failure.
     */
    protected function loadConfiguration($configFile)
    {
        echo "Loading configuration from '{$configFile}'...\n";
        foreach (require($configFile) as $name => $value) {
            if (property_exists($this, $name) || $this->canSetProperty($name)) {
                $this->$name = $value;
            } else {
                throw new Exception("Unknown configuration option: $name");
            }
        }

        $this->getAssetManager(); // check if asset manager configuration is correct
    }

    /**
     * Creates full list of source asset bundles.
181
     * @param string[] $bundles list of asset bundle names
182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201
     * @return \yii\web\AssetBundle[] list of source asset bundles.
     */
    protected function loadBundles($bundles)
    {
        echo "Collecting source bundles information...\n";

        $am = $this->getAssetManager();
        $result = [];
        foreach ($bundles as $name) {
            $result[$name] = $am->getBundle($name);
        }
        foreach ($result as $bundle) {
            $this->loadDependency($bundle, $result);
        }

        return $result;
    }

    /**
     * Loads asset bundle dependencies recursively.
202 203 204
     * @param \yii\web\AssetBundle $bundle bundle instance
     * @param array $result already loaded bundles list.
     * @throws Exception on failure.
205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222
     */
    protected function loadDependency($bundle, &$result)
    {
        $am = $this->getAssetManager();
        foreach ($bundle->depends as $name) {
            if (!isset($result[$name])) {
                $dependencyBundle = $am->getBundle($name);
                $result[$name] = false;
                $this->loadDependency($dependencyBundle, $result);
                $result[$name] = $dependencyBundle;
            } elseif ($result[$name] === false) {
                throw new Exception("A circular dependency is detected for bundle '$name'.");
            }
        }
    }

    /**
     * Creates full list of output asset bundles.
223 224
     * @param array $targets output asset bundles configuration.
     * @param \yii\web\AssetBundle[] $bundles list of source asset bundles.
225
     * @return \yii\web\AssetBundle[] list of output asset bundles.
226
     * @throws Exception on failure.
227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284
     */
    protected function loadTargets($targets, $bundles)
    {
        // build the dependency order of bundles
        $registered = [];
        foreach ($bundles as $name => $bundle) {
            $this->registerBundle($bundles, $name, $registered);
        }
        $bundleOrders = array_combine(array_keys($registered), range(0, count($bundles) - 1));

        // fill up the target which has empty 'depends'.
        $referenced = [];
        foreach ($targets as $name => $target) {
            if (empty($target['depends'])) {
                if (!isset($all)) {
                    $all = $name;
                } else {
                    throw new Exception("Only one target can have empty 'depends' option. Found two now: $all, $name");
                }
            } else {
                foreach ($target['depends'] as $bundle) {
                    if (!isset($referenced[$bundle])) {
                        $referenced[$bundle] = $name;
                    } else {
                        throw new Exception("Target '{$referenced[$bundle]}' and '$name' cannot contain the bundle '$bundle' at the same time.");
                    }
                }
            }
        }
        if (isset($all)) {
            $targets[$all]['depends'] = array_diff(array_keys($registered), array_keys($referenced));
        }

        // adjust the 'depends' order for each target according to the dependency order of bundles
        // create an AssetBundle object for each target
        foreach ($targets as $name => $target) {
            if (!isset($target['basePath'])) {
                throw new Exception("Please specify 'basePath' for the '$name' target.");
            }
            if (!isset($target['baseUrl'])) {
                throw new Exception("Please specify 'baseUrl' for the '$name' target.");
            }
            usort($target['depends'], function ($a, $b) use ($bundleOrders) {
                if ($bundleOrders[$a] == $bundleOrders[$b]) {
                    return 0;
                } else {
                    return $bundleOrders[$a] > $bundleOrders[$b] ? 1 : -1;
                }
            });
            $target['class'] = $name;
            $targets[$name] = Yii::createObject($target);
        }

        return $targets;
    }

    /**
     * Builds output asset bundle.
285 286 287 288
     * @param \yii\web\AssetBundle $target output asset bundle
     * @param string $type either 'js' or 'css'.
     * @param \yii\web\AssetBundle[] $bundles source asset bundles.
     * @throws Exception on failure.
289
     */
290
    protected function buildTarget($target, $type, $bundles)
291
    {
292
        $tempFile = $target->basePath . '/' . strtr($target->$type, ['{hash}' => 'temp']);
293 294 295 296 297 298 299 300 301 302 303 304
        $inputFiles = [];

        foreach ($target->depends as $name) {
            if (isset($bundles[$name])) {
                foreach ($bundles[$name]->$type as $file) {
                    $inputFiles[] = $bundles[$name]->basePath . '/' . $file;
                }
            } else {
                throw new Exception("Unknown bundle: '{$name}'");
            }
        }
        if ($type === 'js') {
305
            $this->compressJsFiles($inputFiles, $tempFile);
306
        } else {
307
            $this->compressCssFiles($inputFiles, $tempFile);
308
        }
309

310 311
        $targetFile = strtr($target->$type, ['{hash}' => md5_file($tempFile)]);
        $outputFile = $target->basePath . '/' . $targetFile;
312
        rename($tempFile, $outputFile);
313
        $target->$type = [$targetFile];
314 315 316 317
    }

    /**
     * Adjust dependencies between asset bundles in the way source bundles begin to depend on output ones.
318 319
     * @param \yii\web\AssetBundle[] $targets output asset bundles.
     * @param \yii\web\AssetBundle[] $bundles source asset bundles.
320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361
     * @return \yii\web\AssetBundle[] output asset bundles.
     */
    protected function adjustDependency($targets, $bundles)
    {
        echo "Creating new bundle configuration...\n";

        $map = [];
        foreach ($targets as $name => $target) {
            foreach ($target->depends as $bundle) {
                $map[$bundle] = $name;
            }
        }

        foreach ($targets as $name => $target) {
            $depends = [];
            foreach ($target->depends as $bn) {
                foreach ($bundles[$bn]->depends as $bundle) {
                    $depends[$map[$bundle]] = true;
                }
            }
            unset($depends[$name]);
            $target->depends = array_keys($depends);
        }

        // detect possible circular dependencies
        foreach ($targets as $name => $target) {
            $registered = [];
            $this->registerBundle($targets, $name, $registered);
        }

        foreach ($map as $bundle => $target) {
            $targets[$bundle] = Yii::createObject([
                'class' => 'yii\\web\\AssetBundle',
                'depends' => [$target],
            ]);
        }

        return $targets;
    }

    /**
     * Registers asset bundles including their dependencies.
362 363 364 365
     * @param \yii\web\AssetBundle[] $bundles asset bundles list.
     * @param string $name bundle name.
     * @param array $registered stores already registered names.
     * @throws Exception if circular dependency is detected.
366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383
     */
    protected function registerBundle($bundles, $name, &$registered)
    {
        if (!isset($registered[$name])) {
            $registered[$name] = false;
            $bundle = $bundles[$name];
            foreach ($bundle->depends as $depend) {
                $this->registerBundle($bundles, $depend, $registered);
            }
            unset($registered[$name]);
            $registered[$name] = true;
        } elseif ($registered[$name] === false) {
            throw new Exception("A circular dependency is detected for target '$name'.");
        }
    }

    /**
     * Saves new asset bundles configuration.
384 385
     * @param \yii\web\AssetBundle[] $targets list of asset bundles to be saved.
     * @param string $bundleFile output file name.
386 387 388 389 390 391 392 393 394 395 396 397 398 399
     * @throws \yii\console\Exception on failure.
     */
    protected function saveTargets($targets, $bundleFile)
    {
        $array = [];
        foreach ($targets as $name => $target) {
            foreach (['basePath', 'baseUrl', 'js', 'css', 'depends'] as $prop) {
                if (!empty($target->$prop)) {
                    $array[$name][$prop] = $target->$prop;
                } elseif (in_array($prop, ['js', 'css'])) {
                    $array[$name][$prop] = [];
                }
            }
        }
400
        $array = VarDumper::export($array);
401 402
        $version = date('Y-m-d H:i:s', time());
        $bundleFileContent = <<<EOD
Qiang Xue committed
403 404
<?php
/**
405
 * This file is generated by the "yii {$this->id}" command.
406
 * DO NOT MODIFY THIS FILE DIRECTLY.
407
 * @version {$version}
Qiang Xue committed
408
 */
409
return {$array};
410
EOD;
411 412 413 414 415 416 417 418
        if (!file_put_contents($bundleFile, $bundleFileContent)) {
            throw new Exception("Unable to write output bundle configuration at '{$bundleFile}'.");
        }
        echo "Output bundle configuration created at '{$bundleFile}'.\n";
    }

    /**
     * Compresses given JavaScript files and combines them into the single one.
419 420
     * @param array $inputFiles list of source file names.
     * @param string $outputFile output file name.
421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447
     * @throws \yii\console\Exception on failure
     */
    protected function compressJsFiles($inputFiles, $outputFile)
    {
        if (empty($inputFiles)) {
            return;
        }
        echo "  Compressing JavaScript files...\n";
        if (is_string($this->jsCompressor)) {
            $tmpFile = $outputFile . '.tmp';
            $this->combineJsFiles($inputFiles, $tmpFile);
            echo shell_exec(strtr($this->jsCompressor, [
                '{from}' => escapeshellarg($tmpFile),
                '{to}' => escapeshellarg($outputFile),
            ]));
            @unlink($tmpFile);
        } else {
            call_user_func($this->jsCompressor, $this, $inputFiles, $outputFile);
        }
        if (!file_exists($outputFile)) {
            throw new Exception("Unable to compress JavaScript files into '{$outputFile}'.");
        }
        echo "  JavaScript files compressed into '{$outputFile}'.\n";
    }

    /**
     * Compresses given CSS files and combines them into the single one.
448 449
     * @param array $inputFiles list of source file names.
     * @param string $outputFile output file name.
450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476
     * @throws \yii\console\Exception on failure
     */
    protected function compressCssFiles($inputFiles, $outputFile)
    {
        if (empty($inputFiles)) {
            return;
        }
        echo "  Compressing CSS files...\n";
        if (is_string($this->cssCompressor)) {
            $tmpFile = $outputFile . '.tmp';
            $this->combineCssFiles($inputFiles, $tmpFile);
            echo shell_exec(strtr($this->cssCompressor, [
                '{from}' => escapeshellarg($tmpFile),
                '{to}' => escapeshellarg($outputFile),
            ]));
            @unlink($tmpFile);
        } else {
            call_user_func($this->cssCompressor, $this, $inputFiles, $outputFile);
        }
        if (!file_exists($outputFile)) {
            throw new Exception("Unable to compress CSS files into '{$outputFile}'.");
        }
        echo "  CSS files compressed into '{$outputFile}'.\n";
    }

    /**
     * Combines JavaScript files into a single one.
477 478
     * @param array $inputFiles source file names.
     * @param string $outputFile output file name.
479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495
     * @throws \yii\console\Exception on failure.
     */
    public function combineJsFiles($inputFiles, $outputFile)
    {
        $content = '';
        foreach ($inputFiles as $file) {
            $content .= "/*** BEGIN FILE: $file ***/\n"
                . file_get_contents($file)
                . "/*** END FILE: $file ***/\n";
        }
        if (!file_put_contents($outputFile, $content)) {
            throw new Exception("Unable to write output JavaScript file '{$outputFile}'.");
        }
    }

    /**
     * Combines CSS files into a single one.
496 497
     * @param array $inputFiles source file names.
     * @param string $outputFile output file name.
498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514
     * @throws \yii\console\Exception on failure.
     */
    public function combineCssFiles($inputFiles, $outputFile)
    {
        $content = '';
        foreach ($inputFiles as $file) {
            $content .= "/*** BEGIN FILE: $file ***/\n"
                . $this->adjustCssUrl(file_get_contents($file), dirname($file), dirname($outputFile))
                . "/*** END FILE: $file ***/\n";
        }
        if (!file_put_contents($outputFile, $content)) {
            throw new Exception("Unable to write output CSS file '{$outputFile}'.");
        }
    }

    /**
     * Adjusts CSS content allowing URL references pointing to the original resources.
515 516 517
     * @param string $cssContent source CSS content.
     * @param string $inputFilePath input CSS file name.
     * @param string $outputFilePath output CSS file name.
518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544
     * @return string adjusted CSS content.
     */
    protected function adjustCssUrl($cssContent, $inputFilePath, $outputFilePath)
    {
        $sharedPathParts = [];
        $inputFilePathParts = explode('/', $inputFilePath);
        $inputFilePathPartsCount = count($inputFilePathParts);
        $outputFilePathParts = explode('/', $outputFilePath);
        $outputFilePathPartsCount = count($outputFilePathParts);
        for ($i =0; $i < $inputFilePathPartsCount && $i < $outputFilePathPartsCount; $i++) {
            if ($inputFilePathParts[$i] == $outputFilePathParts[$i]) {
                $sharedPathParts[] = $inputFilePathParts[$i];
            } else {
                break;
            }
        }
        $sharedPath = implode('/', $sharedPathParts);

        $inputFileRelativePath = trim(str_replace($sharedPath, '', $inputFilePath), '/');
        $outputFileRelativePath = trim(str_replace($sharedPath, '', $outputFilePath), '/');
        $inputFileRelativePathParts = explode('/', $inputFileRelativePath);
        $outputFileRelativePathParts = explode('/', $outputFileRelativePath);

        $callback = function ($matches) use ($inputFileRelativePathParts, $outputFileRelativePathParts) {
            $fullMatch = $matches[0];
            $inputUrl = $matches[1];

545
            if (preg_match('/^https?:\/\//is', $inputUrl) || preg_match('/^data:/is', $inputUrl)) {
546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575
                return $fullMatch;
            }

            $outputUrlParts = array_fill(0, count($outputFileRelativePathParts), '..');
            $outputUrlParts = array_merge($outputUrlParts, $inputFileRelativePathParts);

            if (strpos($inputUrl, '/') !== false) {
                $inputUrlParts = explode('/', $inputUrl);
                foreach ($inputUrlParts as $key => $inputUrlPart) {
                    if ($inputUrlPart == '..') {
                        array_pop($outputUrlParts);
                        unset($inputUrlParts[$key]);
                    }
                }
                $outputUrlParts[] = implode('/', $inputUrlParts);
            } else {
                $outputUrlParts[] = $inputUrl;
            }
            $outputUrl = implode('/', $outputUrlParts);

            return str_replace($inputUrl, $outputUrl, $fullMatch);
        };

        $cssContent = preg_replace_callback('/url\(["\']?([^)^"^\']*)["\']?\)/is', $callback, $cssContent);

        return $cssContent;
    }

    /**
     * Creates template of configuration file for [[actionCompress]].
576
     * @param string $configFile output file name.
577 578 579 580
     * @throws \yii\console\Exception on failure.
     */
    public function actionTemplate($configFile)
    {
581 582
        $jsCompressor = VarDumper::export($this->jsCompressor);
        $cssCompressor = VarDumper::export($this->cssCompressor);
583

584
        $template = <<<EOD
585
<?php
586 587
/**
 * Configuration file for the "yii asset" console command.
588
 * Note that in the console environment, some path aliases like '@webroot' and '@web' may not exist.
Qiang Xue committed
589
 * Please define these missing path aliases.
590
 */
Alexander Makarov committed
591
return [
592 593 594 595
    // Adjust command/callback for JavaScript files compressing:
    'jsCompressor' => {$jsCompressor},
    // Adjust command/callback for CSS files compressing:
    'cssCompressor' => {$cssCompressor},
596 597 598 599 600 601 602 603 604 605
    // The list of asset bundles to compress:
    'bundles' => [
        // 'yii\web\YiiAsset',
        // 'yii\web\JqueryAsset',
    ],
    // Asset bundle for compression output:
    'targets' => [
        'app\assets\AllAsset' => [
            'basePath' => 'path/to/web',
            'baseUrl' => '',
606 607
            'js' => 'js/all-{hash}.js',
            'css' => 'css/all-{hash}.css',
608 609 610 611 612 613 614
        ],
    ],
    // Asset manager configuration:
    'assetManager' => [
        'basePath' => __DIR__,
        'baseUrl' => '',
    ],
Qiang Xue committed
615
];
616
EOD;
617 618
        if (file_exists($configFile)) {
            if (!$this->confirm("File '{$configFile}' already exists. Do you wish to overwrite it?")) {
619
                return self::EXIT_CODE_NORMAL;
620 621 622 623 624 625 626 627
            }
        }
        if (!file_put_contents($configFile, $template)) {
            throw new Exception("Unable to write template file '{$configFile}'.");
        } else {
            echo "Configuration file template created at '{$configFile}'.\n\n";
        }
    }
Zander Baldwin committed
628
}