composer/src/Composer/Downloader/ZipDownloader.php

<?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\Config;
use Composer\Cache;
use Composer\EventDispatcher\EventDispatcher;
use Composer\Package\PackageInterface;
use Composer\Util\IniHelper;
use Composer\Util\Platform;
use Composer\Util\ProcessExecutor;
use Composer\Util\RemoteFilesystem;
use Composer\IO\IOInterface;
use Symfony\Component\Process\ExecutableFinder;
use ZipArchive;

/**
 * @author Jordi Boggiano <j.boggiano@seld.be>
 */
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)
    {
        $this->process = $process ?: new ProcessExecutor($io);
        parent::__construct($io, $config, $eventDispatcher, $cache, $rfs);
    }

    /**
     * {@inheritDoc}
     */
    public function download(PackageInterface $package, $path, $output = true)
    {
        if (null === self::$hasSystemUnzip) {
            $finder = new ExecutableFinder;
            self::$hasSystemUnzip = (bool) $finder->find('unzip');
        }

        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;

            throw new \RuntimeException($error);
        }

        return parent::download($package, $path, $output);
    }

    /**
     * extract $file to $path with "unzip" command
     *
     * @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|\Exception  True if succeed, an Exception if not
     */
    protected function extractWithSystemUnzip($file, $path, $isFallback)
    {
        $processError = null;
        // 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)) {
                return TRUE;
            }

            $processError = 'Failed to execute ' . $command . "\n\n" . $this->process->getErrorOutput();
        } catch (\Exception $e) {
            $processError = 'Failed to execute ' . $command . "\n\n" . $e->getMessage();
        }

        if ( $isFallback ) {
            $this->io->write($processError);
        }
        return new \RuntimeException($processError);
    }

    /**
     * extract $file to $path with ZipArchive
     *
     * @param string $file File to extract
     * @param string $path Path where to extract file
     * @return bool|\Exception True if succeed, an Exception if not
     */
    protected function extractWithZipArchive($file, $path)
    {
        $zipArchive = new ZipArchive();

        if (true !== ($retval = $zipArchive->open($file))) {
            return new \UnexpectedValueException(rtrim($this->getErrorMessage($retval, $file)."\n"), $retval);
        }

        $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();

        return TRUE;
    }

    /**
     * extract $file to $path
     *
     * @param string $file File to extract
     * @param string $path Path where to extract file
     */
    protected function extract($file, $path)
    {
        $resultZipArchive = NULL;
        $resultUnzip = NULL;

        if ( self::$hasZipArchive ) {
            // zip module is present
            $resultZipArchive = $this->extractWithZipArchive($file, $path);
            if ($resultZipArchive === TRUE) {
                return;
            }
        }

        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;
        };
    }

    /**
     * Give a meaningful error message to the user.
     *
     * @param  int    $retval
     * @param  string $file
     * @return string
     */
    protected function getErrorMessage($retval, $file)
    {
        switch ($retval) {
            case ZipArchive::ER_EXISTS:
                return sprintf("File '%s' already exists.", $file);
            case ZipArchive::ER_INCONS:
                return sprintf("Zip archive '%s' is inconsistent.", $file);
            case ZipArchive::ER_INVAL:
                return sprintf("Invalid argument (%s)", $file);
            case ZipArchive::ER_MEMORY:
                return sprintf("Malloc failure (%s)", $file);
            case ZipArchive::ER_NOENT:
                return sprintf("No such zip file: '%s'", $file);
            case ZipArchive::ER_NOZIP:
                return sprintf("'%s' is not a zip archive.", $file);
            case ZipArchive::ER_OPEN:
                return sprintf("Can't open zip file: %s", $file);
            case ZipArchive::ER_READ:
                return sprintf("Zip read error (%s)", $file);
            case ZipArchive::ER_SEEK:
                return sprintf("Zip seek error (%s)", $file);
            default:
                return sprintf("'%s' is not a valid zip archive, got error code: %s", $file, $retval);
        }
    }
}