* @since 2.0 */ class AssetController extends Controller { public $defaultAction = 'compress'; public $bundles = array(); public $extensions = array(); /** * @var array * ~~~ * 'all' => array( * 'css' => 'all.css', * 'js' => 'js.css', * 'depends' => array( ... ), * ) * ~~~ */ public $targets = array(); public $assetManager = array(); public $jsCompressor = 'java -jar compiler.jar --js {from} --js_output_file {to}'; public $cssCompressor = 'java -jar yuicompressor.jar {from} -o {to}'; public function actionCompress($configFile, $bundleFile) { $this->loadConfiguration($configFile); $bundles = $this->loadBundles($this->bundles, $this->extensions); $targets = $this->loadTargets($this->targets, $bundles); $this->publishBundles($bundles, $this->assetManager); $timestamp = time(); foreach ($targets as $target) { if (!empty($target->js)) { $this->buildTarget($target, 'js', $bundles, $timestamp); } if (!empty($target->css)) { $this->buildTarget($target, 'css', $bundles, $timestamp); } } $targets = $this->adjustDependency($targets, $bundles); $this->saveTargets($targets, $bundleFile); } protected function loadConfiguration($configFile) { foreach (require($configFile) as $name => $value) { if (property_exists($this, $name)) { $this->$name = $value; } else { throw new Exception("Unknown configuration option: $name"); } } if (!isset($this->assetManager['basePath'])) { throw new Exception("Please specify 'basePath' for the 'assetManager' option."); } if (!isset($this->assetManager['baseUrl'])) { throw new Exception("Please specify 'baseUrl' for the 'assetManager' option."); } } protected function loadBundles($bundles, $extensions) { $result = array(); foreach ($bundles as $name => $bundle) { $bundle['class'] = 'yii\\web\\AssetBundle'; $result[$name] = Yii::createObject($bundle); } foreach ($extensions as $path) { $manifest = $path . '/assets.php'; if (!is_file($manifest)) { continue; } foreach (require($manifest) as $name => $bundle) { if (!isset($result[$name])) { $bundle['class'] = 'yii\\web\\AssetBundle'; $result[$name] = Yii::createObject($bundle); } } } return $result; } protected function loadTargets($targets, $bundles) { // build the dependency order of bundles $registered = array(); 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 = array(); 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'] = 'yii\\web\\AssetBundle'; $targets[$name] = Yii::createObject($target); } return $targets; } /** * @param \yii\web\AssetBundle[] $bundles * @param array $options */ protected function publishBundles($bundles, $options) { if (!isset($options['class'])) { $options['class'] = 'yii\\web\\AssetManager'; } $am = Yii::createObject($options); foreach ($bundles as $bundle) { $bundle->publish($am); } } /** * @param \yii\web\AssetBundle $target * @param string $type either "js" or "css" * @param \yii\web\AssetBundle[] $bundles * @param integer $timestamp * @throws Exception */ protected function buildTarget($target, $type, $bundles, $timestamp) { $outputFile = strtr($target->$type, array( '{ts}' => $timestamp, )); $inputFiles = array(); 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') { $this->compressJsFiles($inputFiles, $target->basePath . '/' . $outputFile); } else { $this->compressCssFiles($inputFiles, $target->basePath . '/' . $outputFile); } $target->$type = array($outputFile); } protected function adjustDependency($targets, $bundles) { $map = array(); foreach ($targets as $name => $target) { foreach ($target->depends as $bundle) { $map[$bundle] = $name; } } foreach ($targets as $name => $target) { $depends = array(); 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 = array(); $this->registerBundle($targets, $name, $registered); } foreach ($map as $bundle => $target) { $targets[$bundle] = Yii::createObject(array( 'class' => 'yii\\web\\AssetBundle', 'depends' => array($target), )); } return $targets; } 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'."); } } protected function saveTargets($targets, $bundleFile) { $array = array(); foreach ($targets as $name => $target) { foreach (array('js', 'css', 'depends', 'basePath', 'baseUrl') as $prop) { if (!empty($target->$prop)) { $array[$name][$prop] = $target->$prop; } } } $array = var_export($array, true); $version = date('Y-m-d H:i:s', time()); file_put_contents($bundleFile, <<jsCompressor)) { $tmpFile = $outputFile . '.tmp'; $this->combineJsFiles($inputFiles, $tmpFile); $log = shell_exec(strtr($this->jsCompressor, array( '{from}' => $tmpFile, '{to}' => $outputFile, ))); @unlink($tmpFile); } else { $log = call_user_func($this->jsCompressor, $this, $inputFiles, $outputFile); } } protected function compressCssFiles($inputFiles, $outputFile) { if (is_string($this->cssCompressor)) { $tmpFile = $outputFile . '.tmp'; $this->combineCssFiles($inputFiles, $tmpFile); $log = shell_exec(strtr($this->cssCompressor, array( '{from}' => $tmpFile, '{to}' => $outputFile, ))); @unlink($tmpFile); } else { $log = call_user_func($this->cssCompressor, $this, $inputFiles, $outputFile); } } public function combineJsFiles($files, $tmpFile) { $content = ''; foreach ($files as $file) { $content .= "/*** BEGIN FILE: $file ***/\n" . file_get_contents($file) . "/*** END FILE: $file ***/\n"; } file_put_contents($tmpFile, $content); } public function combineCssFiles($files, $tmpFile) { // todo: adjust url() references in CSS files $content = ''; foreach ($files as $file) { $content .= "/*** BEGIN FILE: $file ***/\n" . file_get_contents($file) . "/*** END FILE: $file ***/\n"; } file_put_contents($tmpFile, $content); } /** * Creates template of configuration file for [[actionCompress]]. * @param string $configFile output file name. */ public function actionTemplate($configFile) { $template = << require('path/to/bundles.php'), // 'extensions' => require('path/to/namespaces.php'), // 'targets' => array( 'all' => array( 'basePath' => __DIR__, 'baseUrl' => '/test', 'js' => 'all-{ts}.js', 'css' => 'all-{ts}.css', ), ), 'assetManager' => array( 'basePath' => __DIR__, 'baseUrl' => '/test', ), ); EOD; if (file_exists($configFile)) { if (!$this->confirm("File '{$configFile}' already exists. Do you wish to overwrite it?")) { return; } } $bytesWritten = file_put_contents($configFile, $template); if ($bytesWritten<=0) { echo "Error: unable to write file '{$configFile}'!\n\n"; } else { echo "Configuration file template created at '{$configFile}'.\n\n"; } } }