Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x
  2. RarDownloader.php

class RarDownloader

RAR archive downloader.

Based on previous work by Jordi Boggiano ({ @author Derrick Nelson <drrcknlsn@gmail.com>

Hierarchy

  • class \Composer\Downloader\FileDownloader implements \Composer\Downloader\DownloaderInterface, \Composer\Downloader\ChangeReportInterface
    • class \Composer\Downloader\ArchiveDownloader extends \Composer\Downloader\FileDownloader
      • class \Composer\Downloader\RarDownloader extends \Composer\Downloader\ArchiveDownloader

Expanded class hierarchy of RarDownloader

See also

ZipDownloader}).

File

vendor/composer/composer/src/Composer/Downloader/RarDownloader.php, line 29

Namespace

Composer\Downloader
View source
class RarDownloader extends ArchiveDownloader {
    protected function extract(PackageInterface $package, string $file, string $path) : PromiseInterface {
        $processError = null;
        // Try to use unrar on *nix
        if (!Platform::isWindows()) {
            $command = [
                'sh',
                '-c',
                'unrar x -- "$0" "$1" >/dev/null && chmod -R u+w "$1"',
                $file,
                $path,
            ];
            if (0 === $this->process
                ->execute($command, $ignoredOutput)) {
                return \React\Promise\resolve(null);
            }
            $processError = 'Failed to execute ' . implode(' ', $command) . "\n\n" . $this->process
                ->getErrorOutput();
        }
        if (!class_exists('RarArchive')) {
            // php.ini path is added to the error message to help users find the correct file
            $iniMessage = IniHelper::getMessage();
            $error = "Could not decompress the archive, enable the PHP rar extension or install unrar.\n" . $iniMessage . "\n" . $processError;
            if (!Platform::isWindows()) {
                $error = "Could not decompress the archive, enable the PHP rar extension.\n" . $iniMessage;
            }
            throw new \RuntimeException($error);
        }
        $rarArchive = RarArchive::open($file);
        if (false === $rarArchive) {
            throw new \UnexpectedValueException('Could not open RAR archive: ' . $file);
        }
        $entries = $rarArchive->getEntries();
        if (false === $entries) {
            throw new \RuntimeException('Could not retrieve RAR archive entries');
        }
        foreach ($entries as $entry) {
            if (false === $entry->extract($path)) {
                throw new \RuntimeException('Could not extract entry');
            }
        }
        $rarArchive->close();
        return \React\Promise\resolve(null);
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
ArchiveDownloader::$cleanupExecuted protected property
ArchiveDownloader::cleanup public function @inheritDoc Overrides FileDownloader::cleanup
ArchiveDownloader::getInstallOperationAppendix protected function @inheritDoc Overrides FileDownloader::getInstallOperationAppendix
ArchiveDownloader::install public function @inheritDoc Overrides FileDownloader::install
ArchiveDownloader::prepare public function @inheritDoc Overrides FileDownloader::prepare
FileDownloader::$additionalCleanupPaths private property @var array&lt;string, string[]&gt; Map of package name to list of paths
FileDownloader::$cache protected property @var ?Cache
FileDownloader::$config protected property @var Config
FileDownloader::$downloadMetadata public static property @private
@internal
FileDownloader::$eventDispatcher protected property @var ?EventDispatcher
FileDownloader::$filesystem protected property @var Filesystem
FileDownloader::$httpDownloader protected property @var HttpDownloader
FileDownloader::$io protected property @var IOInterface
FileDownloader::$lastCacheWrites private property
FileDownloader::$process protected property @var ProcessExecutor
FileDownloader::$responseHeaders public static property Collects response headers when running on GH Actions
FileDownloader::addCleanupPath protected function
FileDownloader::clearLastCacheWrite protected function
FileDownloader::download public function @inheritDoc Overrides DownloaderInterface::download 2
FileDownloader::getDistPath protected function
FileDownloader::getFileName protected function Gets file name for specific package
FileDownloader::getInstallationSource public function @inheritDoc Overrides DownloaderInterface::getInstallationSource
FileDownloader::getLocalChanges public function @inheritDoc Overrides ChangeReportInterface::getLocalChanges
FileDownloader::processUrl protected function Process the download url
FileDownloader::remove public function @inheritDoc Overrides DownloaderInterface::remove 1
FileDownloader::removeCleanupPath protected function
FileDownloader::update public function @inheritDoc Overrides DownloaderInterface::update
FileDownloader::__construct public function Constructor.
RarDownloader::extract protected function Extract file to directory Overrides ArchiveDownloader::extract

API Navigation

  • Drupal Core 11.1.x
  • Topics
  • Classes
  • Functions
  • Constants
  • Globals
  • Files
  • Namespaces
  • Deprecated
  • Services
RSS feed
Powered by Drupal