public-mirrors
/
composer
mirror of https://github.com/composer/composer
1
0
Fork 0
Code

Cleaner fallback Algorithm

pull/6159/head
Guillaume ZITTA 2017-02-13 15:54:55 +01:00
parent 211c874b93
commit 921ffe741f
2 changed files with 145 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

76
src/Composer/Downloader/ZipDownloader.php
View File

@ -31,6 +31,7 @@ class ZipDownloader extends ArchiveDownloader
{
protected $process;
protected static $hasSystemUnzip;
protected static $hasZipArchive;
public function __construct(IOInterface $io, Config $config, EventDispatcher $eventDispatcher = null, Cache $cache = null, ProcessExecutor $process = null, RemoteFilesystem $rfs = null)
{
@ -48,7 +49,11 @@ class ZipDownloader extends ArchiveDownloader
self::$hasSystemUnzip = (bool) $finder->find('unzip');
}
if (!class_exists('ZipArchive') && !self::$hasSystemUnzip) {
if (null === self::$hasZipArchive) {
self::$hasZipArchive = class_exists('ZipArchive');
}
if (!self::$hasZipArchive && !self::$hasSystemUnzip) {
// php.ini path is added to the error message to help users find the correct file
$iniMessage = IniHelper::getMessage();
$error = "The zip extension and unzip command are both missing, skipping.\n" . $iniMessage;
@ -62,17 +67,18 @@ class ZipDownloader extends ArchiveDownloader
/**
* extract $file to $path with "unzip" command
*
* @param string $file File to extract
* @param string $path Path where to extract file
* @param string $file File to extract
* @param string $path Path where to extract file
* @param bool $isFallback If true it is called as a fallback and should not throw exception
* @return bool True if succeed
*/
protected function extractWithUnzip($file, $path)
protected function extractWithSystemUnzip($file, $path, $isFallback)
{
$processError = null;
$command = 'unzip -qq '.ProcessExecutor::escape($file).' -d '.ProcessExecutor::escape($path);
if (!Platform::isWindows()) {
$command .= ' && chmod -R u+w ' . ProcessExecutor::escape($path);
}
// When called after a ZipArchive failed, perhaps there is some files to overwrite
$overwrite = $isFallback ? '-o' : '';
$command = 'unzip -qq '.$overwrite.' '.ProcessExecutor::escape($file).' -d '.ProcessExecutor::escape($path);
try {
if (0 === $this->process->execute($command, $ignoredOutput)) {
@ -84,7 +90,11 @@ class ZipDownloader extends ArchiveDownloader
$processError = 'Failed to execute ' . $command . "\n\n" . $e->getMessage();
}
throw new \RuntimeException($processError);
if ( $isFallback ) {
$this->io->write($processError);
return;
}
return new \RuntimeException($processError);
}
/**
@ -99,11 +109,18 @@ class ZipDownloader extends ArchiveDownloader
$zipArchive = new ZipArchive();
if (true !== ($retval = $zipArchive->open($file))) {
throw new \UnexpectedValueException(rtrim($this->getErrorMessage($retval, $file)."\n"), $retval);
return new \UnexpectedValueException(rtrim($this->getErrorMessage($retval, $file)."\n"), $retval);
}
if (true !== $zipArchive->extractTo($path)) {
throw new \RuntimeException(rtrim("There was an error extracting the ZIP file, it is either corrupted or using an invalid format.\n"));
$extractResult = FALSE;
try {
$extractResult = $zipArchive->extractTo($path);
} catch (\Exception $e ) {
return $e;
}
if (true !== $extractResult) {
return new \RuntimeException(rtrim("There was an error extracting the ZIP file, it is either corrupted or using an invalid format.\n"));
}
$zipArchive->close();
@ -117,15 +134,42 @@ class ZipDownloader extends ArchiveDownloader
* @param string $file File to extract
* @param string $path Path where to extract file
*/
protected function extract($file, $path)
public function extract($file, $path)
{
if (self::$hasSystemUnzip && !(class_exists('ZipArchive') && Platform::isWindows())) {
if ( $this->extractWithUnzip($file, $path) ) {
$resultZipArchive = NULL;
$resultUnzip = NULL;
if ( self::$hasZipArchive ) {
// zip module is present
$resultZipArchive = $this->extractWithZipArchive($file, $path);
if ($resultZipArchive === TRUE) {
return;
}
}
$this->extractWithZipArchive($file, $path);
if ( self::$hasSystemUnzip ) {
// we have unzip in the path
$isFallback=FALSE;
if ( $resultZipArchive !== NULL) {
$this->io->writeError("\nUnzip using ZipArchive failed, trying with unzip");
$isFallback=TRUE;
};
$resultUnzip = $this->extractWithSystemUnzip($file, $path, $isFallback);
if ( $resultUnzip === TRUE ) {
return ;
}
};
// extract functions return TRUE or an exception
if ( $resultZipArchive !== NULL ) {
// zipArchive failed
// unZip not present or failed too
throw $resultZipArchive;
} else {
// unZip failed
// zipArchive not available
throw $resultUnzip;
};
}
/**

89
tests/Composer/Test/Downloader/ZipDownloaderTest.php
View File

@ -25,10 +25,6 @@ class ZipDownloaderTest extends TestCase
public function setUp()
{
if (!class_exists('ZipArchive')) {
$this->markTestSkipped('zip extension missing');
}
$this->testDir = $this->getUniqueTmpDirectory();
}
@ -40,6 +36,10 @@ class ZipDownloaderTest extends TestCase
public function testErrorMessages()
{
if (!class_exists('ZipArchive')) {
$this->markTestSkipped('zip extension missing');
}
$packageMock = $this->getMock('Composer\Package\PackageInterface');
$packageMock->expects($this->any())
->method('getDistUrl')
@ -81,4 +81,85 @@ class ZipDownloaderTest extends TestCase
$this->assertContains('is not a zip archive', $e->getMessage());
}
}
/**
* @expectedException \Exception
* @expectedExceptionMessage ZipArchive Failed
*/
function testZipArchiveOnlyFailed() {
$downloader = new TestDownloader($this->getMock('Composer\IO\IOInterface'));
$e = new \Exception("ZipArchive Failed");
$downloader->setUp(TRUE, FALSE, $e, NULL);
$downloader->extract('testfile.zip', 'vendor/dir');
}
function testZipArchiveOnlyGood() {
$downloader = new TestDownloader($this->getMock('Composer\IO\IOInterface'));
$downloader->setUp(TRUE, FALSE, TRUE, NULL);
$downloader->extract('testfile.zip', 'vendor/dir');
}
/**
* @expectedException \Exception
* @expectedExceptionMessage SystemUnzip Failed
*/
function testSystemUnzipOnlyFailed() {
$this->setExpectedException(\Exception::class);
$downloader = new TestDownloader($this->getMock('Composer\IO\IOInterface'));
$e = new \Exception("SystemUnzip Failed");
$downloader->setUp(FALSE, TRUE, NULL, $e);
$downloader->extract('testfile.zip', 'vendor/dir');
}
function testSystemUnzipOnlyGood() {
$downloader = new TestDownloader($this->getMock('Composer\IO\IOInterface'));
$downloader->setUp(FALSE, TRUE, NULL, TRUE);
$downloader->extract('testfile.zip', 'vendor/dir');
}
function testSystemUnzipFallbackGood() {
$downloader = new TestDownloader($this->getMock('Composer\IO\IOInterface'));
$e = new \Exception("test");
$downloader->setUp(TRUE, TRUE, $e, TRUE);
$downloader->extract('testfile.zip', 'vendor/dir');
}
/**
* @expectedException \Exception
* @expectedExceptionMessage ZipArchive Failed
*/
function testSystemUnzipFallbackFailed() {
$this->setExpectedException(\Exception::class);
$downloader = new TestDownloader($this->getMock('Composer\IO\IOInterface'));
$e1 = new \Exception("ZipArchive Failed");
$e2 = new \Exception("SystemUnzip Failed");
$downloader->setUp(TRUE, TRUE, $e1, $e2);
$downloader->extract('testfile.zip', 'vendor/dir');
}
}
class TestDownloader extends ZipDownloader {
public function __construct($io)
{
$this->io = $io;
}
public function extract($file, $path) {
parent::extract($file, $path);
}
public function setUp($zipArchive, $systemUnzip, $zipArchiveResponse, $systemUnzipResponse) {
self::$hasZipArchive = $zipArchive;
self::$hasSystemUnzip = $systemUnzip;
$this->zipArchiveResponse = $zipArchiveResponse;
$this->systemUnzipResponse = $systemUnzipResponse;
}
protected function extractWithZipArchive($file, $path) {
return $this->zipArchiveResponse;
}
protected function extractWithSystemUnzip($file, $path, $fallback) {
return $this->systemUnzipResponse;
}
}