1
0
Fork 0

Added downloader for simple files and refactor FileDownloader into ArchiveDownloader

pull/249/head
Martin Hasoň 2012-02-17 23:10:02 +01:00
parent 0e6cf61b67
commit f1618df349
6 changed files with 139 additions and 53 deletions

View File

@ -0,0 +1,99 @@
<?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\Downloader;
use Composer\IO\IOInterface;
use Composer\Package\PackageInterface;
use Composer\Util\Filesystem;
use Composer\Util\RemoteFilesystem;
/**
* Base downloader for archives
*
* @author Kirill chEbba Chebunin <iam@chebba.org>
* @author Jordi Boggiano <j.boggiano@seld.be>
* @author François Pluchino <francois.pluchino@opendisplay.com>
*/
abstract class ArchiveDownloader extends FileDownloader
{
/**
* {@inheritDoc}
*/
public function download(PackageInterface $package, $path)
{
parent::download($package, $path);
$fileName = $this->getFileName($package, $path);
$this->io->write(' Unpacking archive');
$this->extract($fileName, $path);
$this->io->write(' Cleaning up');
unlink($fileName);
// If we have only a one dir inside it suppose to be a package itself
$contentDir = glob($path . '/*');
if (1 === count($contentDir)) {
$contentDir = $contentDir[0];
// Rename the content directory to avoid error when moving up
// a child folder with the same name
$temporaryName = md5(time().rand());
rename($contentDir, $temporaryName);
$contentDir = $temporaryName;
foreach (array_merge(glob($contentDir . '/.*'), glob($contentDir . '/*')) as $file) {
if (trim(basename($file), '.')) {
rename($file, $path . '/' . basename($file));
}
}
rmdir($contentDir);
}
$this->io->write('');
}
/**
* {@inheritdoc}
*/
protected function getFileName(PackageInterface $package, $path)
{
return rtrim($path.'/'.md5($path.spl_object_hash($package)).'.'.pathinfo($package->getDistUrl(), PATHINFO_EXTENSION), '.');
}
/**
* {@inheritdoc}
*/
protected function processUrl($url)
{
if (!extension_loaded('openssl') && (0 === strpos($url, 'https:') || 0 === strpos($url, 'http://github.com'))) {
// bypass https for github if openssl is disabled
if (preg_match('{^https?://(github.com/[^/]+/[^/]+/(zip|tar)ball/[^/]+)$}i', $url, $match)) {
$url = 'http://nodeload.'.$match[1];
} else {
throw new \RuntimeException('You must enable the openssl extension to download files via https');
}
}
return $url;
}
/**
* Extract file to directory
*
* @param string $file Extracted file
* @param string $path Directory
*
* @throws \UnexpectedValueException If can not extract downloaded file to path
*/
abstract protected function extract($file, $path);
}

View File

@ -18,13 +18,13 @@ use Composer\Util\Filesystem;
use Composer\Util\RemoteFilesystem; use Composer\Util\RemoteFilesystem;
/** /**
* Base downloader for file packages * Base downloader for files
* *
* @author Kirill chEbba Chebunin <iam@chebba.org> * @author Kirill chEbba Chebunin <iam@chebba.org>
* @author Jordi Boggiano <j.boggiano@seld.be> * @author Jordi Boggiano <j.boggiano@seld.be>
* @author François Pluchino <francois.pluchino@opendisplay.com> * @author François Pluchino <francois.pluchino@opendisplay.com>
*/ */
abstract class FileDownloader implements DownloaderInterface class FileDownloader implements DownloaderInterface
{ {
protected $io; protected $io;
@ -63,18 +63,11 @@ abstract class FileDownloader implements DownloaderInterface
} }
} }
$fileName = rtrim($path.'/'.md5(time().rand()).'.'.pathinfo($url, PATHINFO_EXTENSION), '.'); $fileName = $this->getFileName($package, $path);
$this->io->write(" - Package <info>" . $package->getName() . "</info> (<comment>" . $package->getPrettyVersion() . "</comment>)"); $this->io->write(" - Package <info>" . $package->getName() . "</info> (<comment>" . $package->getPrettyVersion() . "</comment>)");
if (!extension_loaded('openssl') && (0 === strpos($url, 'https:') || 0 === strpos($url, 'http://github.com'))) { $url = $this->processUrl($url);
// bypass https for github if openssl is disabled
if (preg_match('{^https?://(github.com/[^/]+/[^/]+/(zip|tar)ball/[^/]+)$}i', $url, $match)) {
$url = 'http://nodeload.'.$match[1];
} else {
throw new \RuntimeException('You must enable the openssl extension to download files via https');
}
}
$rfs = new RemoteFilesystem($this->io); $rfs = new RemoteFilesystem($this->io);
$rfs->copy($package->getSourceUrl(), $url, $fileName); $rfs->copy($package->getSourceUrl(), $url, $fileName);
@ -86,32 +79,7 @@ abstract class FileDownloader implements DownloaderInterface
} }
if ($checksum && hash_file('sha1', $fileName) !== $checksum) { if ($checksum && hash_file('sha1', $fileName) !== $checksum) {
throw new \UnexpectedValueException('The checksum verification of the archive failed (downloaded from '.$url.')'); throw new \UnexpectedValueException('The checksum verification of the file failed (downloaded from '.$url.')');
}
$this->io->write(' Unpacking archive');
$this->extract($fileName, $path);
$this->io->write(' Cleaning up');
unlink($fileName);
// If we have only a one dir inside it suppose to be a package itself
$contentDir = glob($path . '/*');
if (1 === count($contentDir)) {
$contentDir = $contentDir[0];
// Rename the content directory to avoid error when moving up
// a child folder with the same name
$temporaryName = md5(time().rand());
rename($contentDir, $temporaryName);
$contentDir = $temporaryName;
foreach (array_merge(glob($contentDir . '/.*'), glob($contentDir . '/*')) as $file) {
if (trim(basename($file), '.')) {
rename($file, $path . '/' . basename($file));
}
}
rmdir($contentDir);
} }
$this->io->write(''); $this->io->write('');
@ -122,8 +90,7 @@ abstract class FileDownloader implements DownloaderInterface
*/ */
public function update(PackageInterface $initial, PackageInterface $target, $path) public function update(PackageInterface $initial, PackageInterface $target, $path)
{ {
$fs = new Filesystem(); $this->remove($initial, $path);
$fs->removeDirectory($path);
$this->download($target, $path); $this->download($target, $path);
} }
@ -137,12 +104,31 @@ abstract class FileDownloader implements DownloaderInterface
} }
/** /**
* Extract file to directory * Gets file name for specific package
* *
* @param string $file Extracted file * @param PackageInterface $package package instance
* @param string $path Directory * @param string $path download path
* * @return string file name
* @throws \UnexpectedValueException If can not extract downloaded file to path
*/ */
protected abstract function extract($file, $path); protected function getFileName(PackageInterface $package, $path)
{
return $path.'/'.pathinfo($package->getDistUrl(), PATHINFO_BASENAME);
}
/**
* Process the download url
*
* @param string $url download url
* @return string url
*
* @throws \RuntimeException If any problem with the url
*/
protected function processUrl($url)
{
if (!extension_loaded('openssl') && (0 === strpos($url, 'https:') || 0 === strpos($url, 'http://github.com'))) {
throw new \RuntimeException('You must enable the openssl extension to download files via https');
}
return $url;
}
} }

View File

@ -19,7 +19,7 @@ use Composer\Package\PackageInterface;
* *
* @author Kirill chEbba Chebunin <iam@chebba.org> * @author Kirill chEbba Chebunin <iam@chebba.org>
*/ */
class PharDownloader extends FileDownloader class PharDownloader extends ArchiveDownloader
{ {
/** /**
* {@inheritDoc} * {@inheritDoc}

View File

@ -19,7 +19,7 @@ use Composer\Package\PackageInterface;
* *
* @author Kirill chEbba Chebunin <iam@chebba.org> * @author Kirill chEbba Chebunin <iam@chebba.org>
*/ */
class TarDownloader extends FileDownloader class TarDownloader extends ArchiveDownloader
{ {
/** /**
* {@inheritDoc} * {@inheritDoc}

View File

@ -19,7 +19,7 @@ use Composer\IO\IOInterface;
/** /**
* @author Jordi Boggiano <j.boggiano@seld.be> * @author Jordi Boggiano <j.boggiano@seld.be>
*/ */
class ZipDownloader extends FileDownloader class ZipDownloader extends ArchiveDownloader
{ {
protected $process; protected $process;

View File

@ -141,13 +141,14 @@ class Factory
protected function createDownloadManager(IOInterface $io) protected function createDownloadManager(IOInterface $io)
{ {
$dm = new Downloader\DownloadManager(); $dm = new Downloader\DownloadManager();
$dm->setDownloader('git', new Downloader\GitDownloader($io)); $dm->setDownloader('git', new Downloader\GitDownloader($io));
$dm->setDownloader('svn', new Downloader\SvnDownloader($io)); $dm->setDownloader('svn', new Downloader\SvnDownloader($io));
$dm->setDownloader('hg', new Downloader\HgDownloader($io)); $dm->setDownloader('hg', new Downloader\HgDownloader($io));
$dm->setDownloader('pear', new Downloader\PearDownloader($io)); $dm->setDownloader('pear', new Downloader\PearDownloader($io));
$dm->setDownloader('zip', new Downloader\ZipDownloader($io)); $dm->setDownloader('zip', new Downloader\ZipDownloader($io));
$dm->setDownloader('tar', new Downloader\TarDownloader($io)); $dm->setDownloader('tar', new Downloader\TarDownloader($io));
$dm->setDownloader('phar', new Downloader\PharDownloader($io)); $dm->setDownloader('phar', new Downloader\PharDownloader($io));
$dm->setDownloader('file', new Downloader\FileDownloader($io));
return $dm; return $dm;
} }