1
0
Fork 0

Merge pull request #140 from Seldaek/bins

Add binaries support
pull/142/merge
Nils Adermann 2011-12-04 09:31:43 -08:00
commit 71a6b47e90
13 changed files with 341 additions and 54 deletions

View File

@ -90,7 +90,9 @@ class Application extends BaseApplication
}
// Configuration defaults
$composerConfig = array('vendor-dir' => 'vendor');
$composerConfig = array(
'vendor-dir' => 'vendor',
);
$packageConfig = $file->read();
@ -101,6 +103,10 @@ class Application extends BaseApplication
}
$vendorDir = $packageConfig['config']['vendor-dir'];
if (!isset($packageConfig['config']['bin-dir'])) {
$packageConfig['config']['bin-dir'] = $vendorDir.'/bin';
}
$binDir = $packageConfig['config']['bin-dir'];
// initialize repository manager
$rm = new Repository\RepositoryManager();
@ -120,8 +126,8 @@ class Application extends BaseApplication
// initialize installation manager
$im = new Installer\InstallationManager($vendorDir);
$im->addInstaller(new Installer\LibraryInstaller($vendorDir, $dm, $rm->getLocalRepository(), null));
$im->addInstaller(new Installer\InstallerInstaller($vendorDir, $dm, $rm->getLocalRepository(), $im));
$im->addInstaller(new Installer\LibraryInstaller($vendorDir, $binDir, $dm, $rm->getLocalRepository(), null));
$im->addInstaller(new Installer\InstallerInstaller($vendorDir, $binDir, $dm, $rm->getLocalRepository(), $im));
// load package
$loader = new Package\Loader\ArrayLoader($rm);

View File

@ -96,7 +96,7 @@ abstract class FileDownloader implements DownloaderInterface
public function update(PackageInterface $initial, PackageInterface $target, $path)
{
$fs = new Util\Filesystem();
$fs->remove($path);
$fs->removeDirectory($path);
$this->download($target, $path);
}
@ -106,7 +106,7 @@ abstract class FileDownloader implements DownloaderInterface
public function remove(PackageInterface $package, $path)
{
$fs = new Util\Filesystem();
$fs->remove($path);
$fs->removeDirectory($path);
}
/**

View File

@ -61,7 +61,7 @@ class GitDownloader implements DownloaderInterface
{
$this->enforceCleanDirectory($path);
$fs = new Util\Filesystem();
$fs->remove($path);
$fs->removeDirectory($path);
}
private function enforceCleanDirectory($path)

View File

@ -61,7 +61,7 @@ class HgDownloader implements DownloaderInterface
{
$this->enforceCleanDirectory($path);
$fs = new Util\Filesystem();
$fs->remove($path);
$fs->removeDirectory($path);
}
private function enforceCleanDirectory($path)

View File

@ -51,6 +51,6 @@ class SvnDownloader implements DownloaderInterface
public function remove(PackageInterface $package, $path)
{
$fs = new Util\Filesystem();
$fs->remove($path);
$fs->removeDirectory($path);
}
}

View File

@ -17,7 +17,7 @@ namespace Composer\Downloader\Util;
*/
class Filesystem
{
public function remove($directory)
public function removeDirectory($directory)
{
if (defined('PHP_WINDOWS_VERSION_BUILD')) {
system(sprintf('rmdir /S /Q %s', escapeshellarg(realpath($directory))));
@ -25,4 +25,99 @@ class Filesystem
system(sprintf('rm -rf %s', escapeshellarg($directory)));
}
}
public function ensureDirectoryExists($directory)
{
if (!is_dir($directory)) {
if (file_exists($directory)) {
throw new \RuntimeException(
$directory.' exists and is not a directory.'
);
}
if (!mkdir($directory, 0777, true)) {
throw new \RuntimeException(
$directory.' does not exist and could not be created.'
);
}
}
}
/**
* Returns the shortest path from $from to $to
*
* @param string $from
* @param string $to
* @return string
*/
public function findShortestPath($from, $to)
{
if (!$this->isAbsolutePath($from) || !$this->isAbsolutePath($to)) {
throw new \InvalidArgumentException('from and to must be absolute paths');
}
if (dirname($from) === dirname($to)) {
return './'.basename($to);
}
$from = strtr($from, '\\', '/');
$to = strtr($to, '\\', '/');
$commonPath = dirname($to);
while (strpos($from, $commonPath) !== 0 && '/' !== $commonPath && !preg_match('{^[a-z]:/$}i', $commonPath)) {
$commonPath = strtr(dirname($commonPath), '\\', '/');
}
if (0 !== strpos($from, $commonPath) || '/' === $commonPath) {
return $to;
}
$commonPath = rtrim($commonPath, '/') . '/';
$sourcePathDepth = substr_count(substr($from, strlen($commonPath)), '/');
$commonPathCode = str_repeat('../', $sourcePathDepth);
return $commonPathCode . substr($to, strlen($commonPath));
}
/**
* Returns PHP code that, when executed in $from, will return the path to $to
*
* @param string $from
* @param string $to
* @return string
*/
public function findShortestPathCode($from, $to)
{
if (!$this->isAbsolutePath($from) || !$this->isAbsolutePath($to)) {
throw new \InvalidArgumentException('from and to must be absolute paths');
}
if ($from === $to) {
return '__FILE__';
}
$from = strtr($from, '\\', '/');
$to = strtr($to, '\\', '/');
$commonPath = dirname($to);
while (strpos($from, $commonPath) !== 0 && '/' !== $commonPath && !preg_match('{^[a-z]:/$}i', $commonPath)) {
$commonPath = strtr(dirname($commonPath), '\\', '/');
}
if (0 !== strpos($from, $commonPath) || '/' === $commonPath) {
return var_export($to, true);
}
$commonPath = rtrim($commonPath, '/') . '/';
$sourcePathDepth = substr_count(substr($from, strlen($commonPath)), '/');
$commonPathCode = str_repeat('dirname(', $sourcePathDepth).'__DIR__'.str_repeat(')', $sourcePathDepth);
return $commonPathCode . '.' . var_export('/' . substr($to, strlen($commonPath)), true);
}
/**
* Checks if the given path is absolute
*
* @param string $path
* @return Boolean
*/
public function isAbsolutePath($path)
{
return substr($path, 0, 1) === '/' || substr($path, 1, 1) === ':';
}
}

View File

@ -29,13 +29,14 @@ class InstallerInstaller extends LibraryInstaller
private static $classCounter = 0;
/**
* @param string $dir relative path for packages home
* @param string $vendorDir relative path for packages home
* @param string $binDir relative path for binaries
* @param DownloadManager $dm download manager
* @param WritableRepositoryInterface $repository repository controller
*/
public function __construct($directory, DownloadManager $dm, WritableRepositoryInterface $repository, InstallationManager $im)
public function __construct($vendorDir, $binDir, DownloadManager $dm, WritableRepositoryInterface $repository, InstallationManager $im)
{
parent::__construct($directory, $dm, $repository, 'composer-installer');
parent::__construct($vendorDir, $binDir, $dm, $repository, 'composer-installer');
$this->installationManager = $im;
foreach ($repository->getPackages() as $package) {
@ -94,7 +95,7 @@ class InstallerInstaller extends LibraryInstaller
}
$extra = $package->getExtra();
$installer = new $class($this->directory, $this->downloadManager, $this->repository);
$installer = new $class($this->vendorDir, $this->binDir, $this->downloadManager, $this->repository);
$this->installationManager->addInstaller($installer);
}
}

View File

@ -16,6 +16,7 @@ use Composer\Downloader\DownloadManager;
use Composer\Repository\WritableRepositoryInterface;
use Composer\DependencyResolver\Operation\OperationInterface;
use Composer\Package\PackageInterface;
use Composer\Downloader\Util\Filesystem;
/**
* Package installation manager.
@ -25,39 +26,33 @@ use Composer\Package\PackageInterface;
*/
class LibraryInstaller implements InstallerInterface
{
protected $directory;
protected $vendorDir;
protected $binDir;
protected $downloadManager;
protected $repository;
private $type;
private $filesystem;
/**
* Initializes library installer.
*
* @param string $dir relative path for packages home
* @param string $vendorDir relative path for packages home
* @param string $binDir relative path for binaries
* @param DownloadManager $dm download manager
* @param WritableRepositoryInterface $repository repository controller
* @param string $type package type that this installer handles
*/
public function __construct($directory, DownloadManager $dm, WritableRepositoryInterface $repository, $type = 'library')
public function __construct($vendorDir, $binDir, DownloadManager $dm, WritableRepositoryInterface $repository, $type = 'library')
{
$this->directory = $directory;
$this->downloadManager = $dm;
$this->repository = $repository;
$this->type = $type;
if (!is_dir($this->directory)) {
if (file_exists($this->directory)) {
throw new \UnexpectedValueException(
$this->directory.' exists and is not a directory.'
);
}
if (!mkdir($this->directory, 0777, true)) {
throw new \UnexpectedValueException(
$this->directory.' does not exist and could not be created.'
);
}
}
$this->repository = $repository;
$this->filesystem = new Filesystem();
$this->filesystem->ensureDirectoryExists($vendorDir);
$this->filesystem->ensureDirectoryExists($binDir);
$this->vendorDir = realpath($vendorDir);
$this->binDir = realpath($binDir);
}
/**
@ -84,6 +79,7 @@ class LibraryInstaller implements InstallerInterface
$downloadPath = $this->getInstallPath($package);
$this->downloadManager->download($package, $downloadPath);
$this->installBinaries($package);
$this->repository->addPackage(clone $package);
}
@ -98,7 +94,9 @@ class LibraryInstaller implements InstallerInterface
$downloadPath = $this->getInstallPath($initial);
$this->removeBinaries($initial);
$this->downloadManager->update($initial, $target, $downloadPath);
$this->installBinaries($target);
$this->repository->removePackage($initial);
$this->repository->addPackage(clone $target);
}
@ -117,6 +115,7 @@ class LibraryInstaller implements InstallerInterface
$downloadPath = $this->getInstallPath($package);
$this->downloadManager->remove($package, $downloadPath);
$this->removeBinaries($package);
$this->repository->removePackage($package);
}
@ -126,6 +125,86 @@ class LibraryInstaller implements InstallerInterface
public function getInstallPath(PackageInterface $package)
{
$targetDir = $package->getTargetDir();
return ($this->directory ? $this->directory.'/' : '') . $package->getName() . ($targetDir ? '/'.$targetDir : '');
return ($this->vendorDir ? $this->vendorDir.'/' : '') . $package->getName() . ($targetDir ? '/'.$targetDir : '');
}
protected function installBinaries(PackageInterface $package)
{
if (!$package->getBinaries()) {
return;
}
foreach ($package->getBinaries() as $bin) {
$link = $this->binDir.'/'.basename($bin);
if (file_exists($link)) {
echo 'Skipped installation of '.$bin.' for package '.$package->getName().', name conflicts with an existing file';
continue;
}
$bin = $this->getInstallPath($package).'/'.$bin;
if (defined('PHP_WINDOWS_VERSION_BUILD')) {
// add unixy support for cygwin and similar environments
if ('.bat' !== substr($bin, -4)) {
file_put_contents($link, $this->generateUnixyProxyCode($bin, $link));
chmod($link, 0777);
$link .= '.bat';
}
file_put_contents($link, $this->generateWindowsProxyCode($bin, $link));
} else {
symlink($bin, $link);
}
chmod($link, 0777);
}
}
protected function removeBinaries(PackageInterface $package)
{
if (!$package->getBinaries()) {
return;
}
foreach ($package->getBinaries() as $bin => $os) {
$link = $this->binDir.'/'.basename($bin);
if (!file_exists($link)) {
continue;
}
unlink($link);
}
}
private function generateWindowsProxyCode($bin, $link)
{
$binPath = $this->filesystem->findShortestPath($link, $bin);
if ('.bat' === substr($bin, -4)) {
$caller = 'call';
} else {
$handle = fopen($bin, 'r');
$line = fgets($handle);
fclose($handle);
if (preg_match('{^#!/(?:usr/bin/env )?(?:[^/]+/)*(.+)$}m', $line, $match)) {
$caller = $match[1];
} else {
$caller = 'php';
}
}
return "@echo off\r\n".
"pushd .\r\n".
"cd %~dp0\r\n".
"cd ".escapeshellarg(dirname($binPath))."\r\n".
"set BIN_TARGET=%CD%\\".basename($binPath)."\r\n".
"popd\r\n".
$caller." %BIN_TARGET% %*\r\n";
}
private function generateUnixyProxyCode($bin, $link)
{
$binPath = $this->filesystem->findShortestPath($link, $bin);
return "#!/usr/bin/env sh\n".
'SRC_DIR=`pwd`'."\n".
'cd `dirname "$0"`'."\n".
'cd '.escapeshellarg(dirname($binPath))."\n".
'BIN_TARGET=`pwd`/'.basename($binPath)."\n".
'cd $SRC_DIR'."\n".
'$BIN_TARGET "$@"'."\n";
}
}

View File

@ -78,6 +78,13 @@ class ArrayLoader
$package->setExtra($config['extra']);
}
if (isset($config['bin']) && is_array($config['bin'])) {
foreach ($config['bin'] as $key => $bin) {
$config['bin'][$key]= ltrim($bin, '/');
}
$package->setBinaries($config['bin']);
}
if (!empty($config['description']) && is_string($config['description'])) {
$package->setDescription($config['description']);
}

View File

@ -39,6 +39,7 @@ class MemoryPackage extends BasePackage
protected $description;
protected $homepage;
protected $extra = array();
protected $binaries = array();
protected $requires = array();
protected $conflicts = array();
@ -111,6 +112,22 @@ class MemoryPackage extends BasePackage
return $this->extra;
}
/**
* @param array $binaries
*/
public function setBinaries(array $binaries)
{
$this->binaries = $binaries;
}
/**
* {@inheritDoc}
*/
public function getBinaries()
{
return $this->binaries;
}
/**
* {@inheritDoc}
*/

View File

@ -0,0 +1,67 @@
<?php
/*
* This file is part of Composer.
*
* (c) Nils Adermann <naderman@naderman.de>
* Jordi Boggiano <j.boggiano@seld.be>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace Composer\Test\Repository;
use Composer\Downloader\Util\Filesystem;
use Composer\Test\TestCase;
class FilesystemTest extends TestCase
{
/**
* @dataProvider providePathCouplesAsCode
*/
public function testFindShortestPathCode($a, $b, $expected)
{
$fs = new Filesystem;
$this->assertEquals($expected, $fs->findShortestPathCode($a, $b));
}
public function providePathCouplesAsCode()
{
return array(
array('/foo/bar', '/foo/bar', "__FILE__"),
array('/foo/bar', '/foo/baz', "__DIR__.'/baz'"),
array('/foo/bin/run', '/foo/vendor/acme/bin/run', "dirname(__DIR__).'/vendor/acme/bin/run'"),
array('/foo/bin/run', '/foo/vendor/acme/bin/run', "dirname(__DIR__).'/vendor/acme/bin/run'"),
array('/foo/bin/run', '/bar/bin/run', "'/bar/bin/run'"),
array('c:/bin/run', 'c:/vendor/acme/bin/run', "dirname(__DIR__).'/vendor/acme/bin/run'"),
array('c:\\bin\\run', 'c:/vendor/acme/bin/run', "dirname(__DIR__).'/vendor/acme/bin/run'"),
array('c:/bin/run', 'd:/vendor/acme/bin/run', "'d:/vendor/acme/bin/run'"),
array('c:\\bin\\run', 'd:/vendor/acme/bin/run', "'d:/vendor/acme/bin/run'"),
);
}
/**
* @dataProvider providePathCouples
*/
public function testFindShortestPath($a, $b, $expected)
{
$fs = new Filesystem;
$this->assertEquals($expected, $fs->findShortestPath($a, $b));
}
public function providePathCouples()
{
return array(
array('/foo/bar', '/foo/bar', "./bar"),
array('/foo/bar', '/foo/baz', "./baz"),
array('/foo/bin/run', '/foo/vendor/acme/bin/run', "../vendor/acme/bin/run"),
array('/foo/bin/run', '/foo/vendor/acme/bin/run', "../vendor/acme/bin/run"),
array('/foo/bin/run', '/bar/bin/run', "/bar/bin/run"),
array('c:/bin/run', 'c:/vendor/acme/bin/run', "../vendor/acme/bin/run"),
array('c:\\bin\\run', 'c:/vendor/acme/bin/run', "../vendor/acme/bin/run"),
array('c:/bin/run', 'd:/vendor/acme/bin/run', "d:/vendor/acme/bin/run"),
array('c:\\bin\\run', 'd:/vendor/acme/bin/run', "d:/vendor/acme/bin/run"),
);
}
}

View File

@ -49,7 +49,7 @@ class InstallerInstallerTest extends \PHPUnit_Framework_TestCase
->expects($this->once())
->method('getPackages')
->will($this->returnValue(array()));
$installer = new InstallerInstallerMock(__DIR__.'/Fixtures/', $this->dm, $this->repository, $this->im);
$installer = new InstallerInstallerMock(__DIR__.'/Fixtures/', __DIR__.'/Fixtures/bin', $this->dm, $this->repository, $this->im);
$test = $this;
$this->im
@ -72,7 +72,7 @@ class InstallerInstallerTest extends \PHPUnit_Framework_TestCase
->expects($this->once())
->method('hasPackage')
->will($this->returnValue(true));
$installer = new InstallerInstallerMock(__DIR__.'/Fixtures/', $this->dm, $this->repository, $this->im);
$installer = new InstallerInstallerMock(__DIR__.'/Fixtures/', __DIR__.'/Fixtures/bin', $this->dm, $this->repository, $this->im);
$test = $this;
$this->im
@ -95,7 +95,7 @@ class InstallerInstallerTest extends \PHPUnit_Framework_TestCase
->expects($this->once())
->method('hasPackage')
->will($this->returnValue(true));
$installer = new InstallerInstallerMock(__DIR__.'/Fixtures/', $this->dm, $this->repository, $this->im);
$installer = new InstallerInstallerMock(__DIR__.'/Fixtures/', __DIR__.'/Fixtures/bin', $this->dm, $this->repository, $this->im);
$test = $this;
$this->im

View File

@ -14,20 +14,31 @@ namespace Composer\Test\Installer;
use Composer\Installer\LibraryInstaller;
use Composer\DependencyResolver\Operation;
use Composer\Downloader\Util\Filesystem;
class LibraryInstallerTest extends \PHPUnit_Framework_TestCase
{
private $dir;
private $vendorDir;
private $binDir;
private $dm;
private $repository;
private $library;
protected function setUp()
{
$this->dir = sys_get_temp_dir().'/composer';
if (is_dir($this->dir)) {
rmdir($this->dir);
$fs = new Filesystem;
$this->vendorDir = sys_get_temp_dir().DIRECTORY_SEPARATOR.'composer-test-vendor';
if (is_dir($this->vendorDir)) {
$fs->removeDirectory($this->vendorDir);
}
mkdir($this->vendorDir);
$this->binDir = sys_get_temp_dir().DIRECTORY_SEPARATOR.'composer-test-bin';
if (is_dir($this->binDir)) {
$fs->removeDirectory($this->binDir);
}
mkdir($this->binDir);
$this->dm = $this->getMockBuilder('Composer\Downloader\DownloadManager')
->disableOriginalConstructor()
@ -40,19 +51,19 @@ class LibraryInstallerTest extends \PHPUnit_Framework_TestCase
public function testInstallerCreation()
{
$library = new LibraryInstaller($this->dir, $this->dm, $this->repository);
$this->assertTrue(is_dir($this->dir));
$library = new LibraryInstaller($this->vendorDir, $this->binDir, $this->dm, $this->repository);
$this->assertTrue(is_dir($this->vendorDir));
$file = sys_get_temp_dir().'/file';
touch($file);
$this->setExpectedException('UnexpectedValueException');
$library = new LibraryInstaller($file, $this->dm, $this->repository);
$this->setExpectedException('RuntimeException');
$library = new LibraryInstaller($file, $this->binDir, $this->dm, $this->repository);
}
public function testIsInstalled()
{
$library = new LibraryInstaller($this->dir, $this->dm, $this->repository);
$library = new LibraryInstaller($this->vendorDir, $this->binDir, $this->dm, $this->repository);
$package = $this->createPackageMock();
$this->repository
@ -67,7 +78,7 @@ class LibraryInstallerTest extends \PHPUnit_Framework_TestCase
public function testInstall()
{
$library = new LibraryInstaller($this->dir, $this->dm, $this->repository);
$library = new LibraryInstaller($this->vendorDir, $this->binDir, $this->dm, $this->repository);
$package = $this->createPackageMock();
$package
@ -78,7 +89,7 @@ class LibraryInstallerTest extends \PHPUnit_Framework_TestCase
$this->dm
->expects($this->once())
->method('download')
->with($package, $this->dir.'/some/package');
->with($package, $this->vendorDir.'/some/package');
$this->repository
->expects($this->once())
@ -90,7 +101,7 @@ class LibraryInstallerTest extends \PHPUnit_Framework_TestCase
public function testUpdate()
{
$library = new LibraryInstaller($this->dir, $this->dm, $this->repository);
$library = new LibraryInstaller($this->vendorDir, $this->binDir, $this->dm, $this->repository);
$initial = $this->createPackageMock();
$target = $this->createPackageMock();
@ -108,7 +119,7 @@ class LibraryInstallerTest extends \PHPUnit_Framework_TestCase
$this->dm
->expects($this->once())
->method('update')
->with($initial, $target, $this->dir.'/package1');
->with($initial, $target, $this->vendorDir.'/package1');
$this->repository
->expects($this->once())
@ -129,7 +140,7 @@ class LibraryInstallerTest extends \PHPUnit_Framework_TestCase
public function testUninstall()
{
$library = new LibraryInstaller($this->dir, $this->dm, $this->repository);
$library = new LibraryInstaller($this->vendorDir, $this->binDir, $this->dm, $this->repository);
$package = $this->createPackageMock();
$package
@ -146,7 +157,7 @@ class LibraryInstallerTest extends \PHPUnit_Framework_TestCase
$this->dm
->expects($this->once())
->method('remove')
->with($package, $this->dir.'/pkg');
->with($package, $this->vendorDir.'/pkg');
$this->repository
->expects($this->once())
@ -163,7 +174,7 @@ class LibraryInstallerTest extends \PHPUnit_Framework_TestCase
public function testGetInstallPath()
{
$library = new LibraryInstaller($this->dir, $this->dm, $this->repository);
$library = new LibraryInstaller($this->vendorDir, $this->binDir, $this->dm, $this->repository);
$package = $this->createPackageMock();
$package
@ -171,20 +182,24 @@ class LibraryInstallerTest extends \PHPUnit_Framework_TestCase
->method('getTargetDir')
->will($this->returnValue(null));
$this->assertEquals($this->dir.'/'.$package->getName(), $library->getInstallPath($package));
$this->assertEquals($this->vendorDir.'/'.$package->getName(), $library->getInstallPath($package));
}
public function testGetInstallPathWithTargetDir()
{
$library = new LibraryInstaller($this->dir, $this->dm, $this->repository);
$library = new LibraryInstaller($this->vendorDir, $this->binDir, $this->dm, $this->repository);
$package = $this->createPackageMock();
$package
->expects($this->once())
->method('getTargetDir')
->will($this->returnValue('Some/Namespace'));
$package
->expects($this->any())
->method('getName')
->will($this->returnValue('foo/bar'));
$this->assertEquals($this->dir.'/'.$package->getName().'/Some/Namespace', $library->getInstallPath($package));
$this->assertEquals($this->vendorDir.'/'.$package->getName().'/Some/Namespace', $library->getInstallPath($package));
}
private function createPackageMock()