Installer.php 9.09 KB
Newer Older
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\composer;

use Composer\Package\PackageInterface;
use Composer\Installer\LibraryInstaller;
use Composer\Repository\InstalledRepositoryInterface;
Qiang Xue committed
13
use Composer\Script\CommandEvent;
14
use Composer\Util\Filesystem;
15 16 17 18 19 20 21

/**
 * @author Qiang Xue <qiang.xue@gmail.com>
 * @since 2.0
 */
class Installer extends LibraryInstaller
{
22 23
    const EXTRA_BOOTSTRAP = 'bootstrap';
    const EXTENSION_FILE = 'yiisoft/extensions.php';
24

25

26 27 28 29 30 31 32
    /**
     * @inheritdoc
     */
    public function supports($packageType)
    {
        return $packageType === 'yii2-extension';
    }
33

34 35 36 37 38 39 40 41 42 43 44 45 46 47
    /**
     * @inheritdoc
     */
    public function install(InstalledRepositoryInterface $repo, PackageInterface $package)
    {
        // install the package the normal composer way
        parent::install($repo, $package);
        // add the package to yiisoft/extensions.php
        $this->addPackage($package);
        // ensure the yii2-dev package also provides Yii.php in the same place as yii2 does
        if ($package->getName() == 'yiisoft/yii2-dev') {
            $this->linkBaseYiiFiles();
        }
    }
48

49 50 51 52 53 54 55 56 57 58 59 60 61
    /**
     * @inheritdoc
     */
    public function update(InstalledRepositoryInterface $repo, PackageInterface $initial, PackageInterface $target)
    {
        parent::update($repo, $initial, $target);
        $this->removePackage($initial);
        $this->addPackage($target);
        // ensure the yii2-dev package also provides Yii.php in the same place as yii2 does
        if ($initial->getName() == 'yiisoft/yii2-dev') {
            $this->linkBaseYiiFiles();
        }
    }
62

63 64 65 66 67 68 69 70 71 72 73 74 75 76
    /**
     * @inheritdoc
     */
    public function uninstall(InstalledRepositoryInterface $repo, PackageInterface $package)
    {
        // uninstall the package the normal composer way
        parent::uninstall($repo, $package);
        // remove the package from yiisoft/extensions.php
        $this->removePackage($package);
        // remove links for Yii.php
        if ($package->getName() == 'yiisoft/yii2-dev') {
            $this->removeBaseYiiFiles();
        }
    }
77

78 79 80 81 82 83
    protected function addPackage(PackageInterface $package)
    {
        $extension = [
            'name' => $package->getName(),
            'version' => $package->getVersion(),
        ];
84

85 86 87 88 89
        $alias = $this->generateDefaultAlias($package);
        if (!empty($alias)) {
            $extension['alias'] = $alias;
        }
        $extra = $package->getExtra();
lynicidn committed
90
        if (isset($extra[self::EXTRA_BOOTSTRAP])) {
91 92
            $extension['bootstrap'] = $extra[self::EXTRA_BOOTSTRAP];
        }
93

94 95 96 97
        $extensions = $this->loadExtensions();
        $extensions[$package->getName()] = $extension;
        $this->saveExtensions($extensions);
    }
98

99 100 101 102 103
    protected function generateDefaultAlias(PackageInterface $package)
    {
        $fs = new Filesystem;
        $vendorDir = $fs->normalizePath($this->vendorDir);
        $autoload = $package->getAutoload();
104

105
        $aliases = [];
106

107 108 109 110
        if (!empty($autoload['psr-0'])) {
            foreach ($autoload['psr-0'] as $name => $path) {
                $name = str_replace('\\', '/', trim($name, '\\'));
                if (!$fs->isAbsolutePath($path)) {
111
                    $path = $this->vendorDir . '/' . $package->getPrettyName() . '/' . $path;
112 113 114 115 116 117 118 119 120
                }
                $path = $fs->normalizePath($path);
                if (strpos($path . '/', $vendorDir . '/') === 0) {
                    $aliases["@$name"] = '<vendor-dir>' . substr($path, strlen($vendorDir)) . '/' . $name;
                } else {
                    $aliases["@$name"] = $path . '/' . $name;
                }
            }
        }
121

122 123 124 125
        if (!empty($autoload['psr-4'])) {
            foreach ($autoload['psr-4'] as $name => $path) {
                $name = str_replace('\\', '/', trim($name, '\\'));
                if (!$fs->isAbsolutePath($path)) {
126
                    $path = $this->vendorDir . '/' . $package->getPrettyName() . '/' . $path;
127 128 129 130 131 132 133 134 135
                }
                $path = $fs->normalizePath($path);
                if (strpos($path . '/', $vendorDir . '/') === 0) {
                    $aliases["@$name"] = '<vendor-dir>' . substr($path, strlen($vendorDir));
                } else {
                    $aliases["@$name"] = $path;
                }
            }
        }
136

137 138
        return $aliases;
    }
139

140 141 142 143 144 145
    protected function removePackage(PackageInterface $package)
    {
        $packages = $this->loadExtensions();
        unset($packages[$package->getName()]);
        $this->saveExtensions($packages);
    }
146

147 148 149 150 151 152 153 154 155 156 157
    protected function loadExtensions()
    {
        $file = $this->vendorDir . '/' . self::EXTENSION_FILE;
        if (!is_file($file)) {
            return [];
        }
        // invalidate opcache of extensions.php if exists
        if (function_exists('opcache_invalidate')) {
            opcache_invalidate($file, true);
        }
        $extensions = require($file);
158

159 160
        $vendorDir = str_replace('\\', '/', $this->vendorDir);
        $n = strlen($vendorDir);
161

162 163 164 165 166 167 168 169 170 171
        foreach ($extensions as &$extension) {
            if (isset($extension['alias'])) {
                foreach ($extension['alias'] as $alias => $path) {
                    $path = str_replace('\\', '/', $path);
                    if (strpos($path . '/', $vendorDir . '/') === 0) {
                        $extension['alias'][$alias] = '<vendor-dir>' . substr($path, $n);
                    }
                }
            }
        }
172

173 174
        return $extensions;
    }
175

176 177 178
    protected function saveExtensions(array $extensions)
    {
        $file = $this->vendorDir . '/' . self::EXTENSION_FILE;
179 180 181
        if (!file_exists(dirname($file))) {
            mkdir(dirname($file), 0777, true);
        }
182 183 184 185 186 187 188
        $array = str_replace("'<vendor-dir>", '$vendorDir . \'', var_export($extensions, true));
        file_put_contents($file, "<?php\n\n\$vendorDir = dirname(__DIR__);\n\nreturn $array;\n");
        // invalidate opcache of extensions.php if exists
        if (function_exists('opcache_invalidate')) {
            opcache_invalidate($file, true);
        }
    }
189

190 191 192 193 194 195 196 197
    protected function linkBaseYiiFiles()
    {
        $yiiDir = $this->vendorDir . '/yiisoft/yii2';
        if (!file_exists($yiiDir)) {
            mkdir($yiiDir, 0777, true);
        }
        foreach (['Yii.php', 'BaseYii.php', 'classes.php'] as $file) {
            file_put_contents($yiiDir . '/' . $file, <<<EOF
198 199
<?php
/**
200 201 202 203 204 205
 * This is a link provided by the yiisoft/yii2-dev package via yii2-composer plugin.
 *
 * @link http://www.yiiframework.com/
 * @copyright Copyright (c) 2008 Yii Software LLC
 * @license http://www.yiiframework.com/license/
 */
206

207
return require(__DIR__ . '/../yii2-dev/framework/$file');
208 209

EOF
210 211 212
            );
        }
    }
213

214 215 216 217 218 219 220 221 222 223 224 225
    protected function removeBaseYiiFiles()
    {
        $yiiDir = $this->vendorDir . '/yiisoft/yii2';
        foreach (['Yii.php', 'BaseYii.php', 'classes.php'] as $file) {
            if (file_exists($yiiDir . '/' . $file)) {
                unlink($yiiDir . '/' . $file);
            }
        }
        if (file_exists($yiiDir)) {
            rmdir($yiiDir);
        }
    }
226 227 228 229 230 231 232 233 234 235
    
    public static function postCreateProject($event)
    {
        $params = $event->getComposer()->getPackage()->getExtra();
        if (isset($params[__METHOD__]) && is_array($params[__METHOD__])) {
            foreach ($params[__METHOD__] as $method => $args) {
                call_user_func_array([__CLASS__, $method], (array) $args);
            }
        }
    }
236

237 238
    /**
     * Sets the correct permission for the files and directories listed in the extra section.
239
     * @param array $paths the paths (keys) and the corresponding permission octal strings (values)
240
     */
241
    public static function setPermission(array $paths)
242
    {
243 244
        foreach ($paths as $path => $permission) {
            echo "chmod('$path', $permission)...";
245
            if (is_dir($path) || is_file($path)) {
246 247
                chmod($path, octdec($permission));
                echo "done.\n";
248
            } else {
249
                echo "file not found.\n";
250 251 252
            }
        }
    }
253 254 255

    /**
     * Generates a cookie validation key for every app config listed in "config" in extra section.
256
     * You can provide one or multiple parameters as the configuration files which need to have validation key inserted.
257
     */
258
    public static function generateCookieValidationKey()
259
    {
260
        $configs = func_get_args();
261
        $key = self::generateRandomString();
262
        foreach ($configs as $config) {
263
            if (is_file($config)) {
264
                $content = preg_replace('/(("|\')cookieValidationKey("|\')\s*=>\s*)(""|\'\')/', "\\1'$key'", file_get_contents($config));
265 266 267 268 269
                file_put_contents($config, $content);
            }
        }
    }

270
    protected static function generateRandomString()
271 272 273 274 275 276 277 278
    {
        if (!extension_loaded('mcrypt')) {
            throw new \Exception('The mcrypt PHP extension is required by Yii2.');
        }
        $length = 32;
        $bytes = mcrypt_create_iv($length, MCRYPT_DEV_URANDOM);
        return strtr(substr(base64_encode($bytes), 0, $length), '+/=', '_-.');
    }
279
}