DownloadCommand.php

<?php

declare(strict_types=1);

namespace SPC\command;

use SPC\builder\traits\UnixSystemUtilTrait;
use SPC\exception\DownloaderException;
use SPC\exception\FileSystemException;
use SPC\exception\RuntimeException;
use SPC\exception\WrongUsageException;
use SPC\store\Config;
use SPC\store\Downloader;
use SPC\store\LockFile;
use SPC\util\DependencyUtil;
use SPC\util\SPCTarget;
use Symfony\Component\Console\Attribute\AsCommand;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;

#[AsCommand('download', 'Download required sources', ['fetch'])]
class DownloadCommand extends BaseCommand
{
    use UnixSystemUtilTrait;

    protected string $php_major_ver;

    public function configure(): void
    {
        $this->addArgument('sources', InputArgument::REQUIRED, 'The sources will be compiled, comma separated');
        $this->addOption('shallow-clone', null, null, 'Clone shallow');
        $this->addOption('with-openssl11', null, null, 'Use openssl 1.1');
        $this->addOption('with-php', null, InputOption::VALUE_REQUIRED, 'version in major.minor format (default 8.4)', '8.4');
        $this->addOption('clean', null, null, 'Clean old download cache and source before fetch');
        $this->addOption('all', 'A', null, 'Fetch all sources that static-php-cli needed');
        $this->addOption('custom-url', 'U', InputOption::VALUE_IS_ARRAY | InputOption::VALUE_REQUIRED, 'Specify custom source download url, e.g "php-src:https://downloads.php.net/~eric/php-8.3.0beta1.tar.gz"');
        $this->addOption('custom-git', 'G', InputOption::VALUE_IS_ARRAY | InputOption::VALUE_REQUIRED, 'Specify custom source git url, e.g "php-src:master:https://github.com/php/php-src.git"');
        $this->addOption('from-zip', 'Z', InputOption::VALUE_REQUIRED, 'Fetch from zip archive');
        $this->addOption('for-extensions', 'e', InputOption::VALUE_REQUIRED, 'Fetch by extensions, e.g "openssl,mbstring"');
        $this->addOption('for-libs', 'l', InputOption::VALUE_REQUIRED, 'Fetch by libraries, e.g "libcares,openssl,onig"');
        $this->addOption('without-suggestions', null, null, 'Do not fetch suggested sources when using --for-extensions');
        $this->addOption('ignore-cache-sources', null, InputOption::VALUE_OPTIONAL, 'Ignore some source caches, comma separated, e.g "php-src,curl,openssl"', false);
        $this->addOption('retry', 'R', InputOption::VALUE_REQUIRED, 'Set retry time when downloading failed (default: 0)', '0');
        $this->addOption('prefer-pre-built', 'P', null, 'Download pre-built libraries when available');
        $this->addOption('no-alt', null, null, 'Do not download alternative sources');
    }

    /**
     * @throws FileSystemException
     * @throws WrongUsageException
     */
    public function initialize(InputInterface $input, OutputInterface $output): void
    {
        // mode: --all
        if ($input->getOption('all')) {
            $input->setArgument('sources', implode(',', array_keys(Config::getSources())));
            parent::initialize($input, $output);
            return;
        }
        // mode: --clean and --from-zip
        if ($input->getOption('clean') || $input->getOption('from-zip')) {
            $input->setArgument('sources', '');
            parent::initialize($input, $output);
            return;
        }
        // mode: normal
        if (!empty($input->getArgument('sources'))) {
            $final_sources = array_map('trim', array_filter(explode(',', $input->getArgument('sources'))));
        } else {
            $final_sources = [];
        }
        // mode: --for-extensions
        if ($for_ext = $input->getOption('for-extensions')) {
            $ext = $this->parseExtensionList($for_ext);
            $sources = $this->calculateSourcesByExt($ext, !$input->getOption('without-suggestions'));
            $final_sources = array_merge($final_sources, array_diff($sources, $final_sources));
        }
        // mode: --for-libs
        if ($for_lib = $input->getOption('for-libs')) {
            $lib = array_map('trim', array_filter(explode(',', $for_lib)));
            $sources = $this->calculateSourcesByLib($lib, !$input->getOption('without-suggestions'));
            $final_sources = array_merge($final_sources, array_diff($sources, $final_sources));
        }
        if (!empty($final_sources)) {
            $input->setArgument('sources', implode(',', $final_sources));
        }
        parent::initialize($input, $output);
    }

    /**
     * @throws FileSystemException
     * @throws RuntimeException
     */
    public function handle(): int
    {
        try {
            if ($this->getOption('clean')) {
                return $this->_clean();
            }

            // --from-zip
            if ($path = $this->getOption('from-zip')) {
                return $this->downloadFromZip($path);
            }

            // Define PHP major version
            $ver = $this->php_major_ver = $this->getOption('with-php');
            define('SPC_BUILD_PHP_VERSION', $ver);
            if ($ver !== 'git' && !preg_match('/^\d+\.\d+$/', $ver)) {
                // If not git, we need to check the version format
                if (!preg_match('/^\d+\.\d+(\.\d+)?$/', $ver)) {
                    logger()->error("bad version arg: {$ver}, x.y or x.y.z required!");
                    return static::FAILURE;
                }
            }

            // retry
            $retry = intval($this->getOption('retry'));
            f_putenv('SPC_DOWNLOAD_RETRIES=' . $retry);

            // Use shallow-clone can reduce git resource download
            if ($this->getOption('shallow-clone')) {
                define('GIT_SHALLOW_CLONE', true);
            }

            // To read config
            Config::getSource('openssl');

            // use openssl 1.1
            if ($this->getOption('with-openssl11')) {
                logger()->debug('Using openssl 1.1');
                Config::$source['openssl']['regex'] = '/href="(?<file>openssl-(?<version>1.[^"]+)\.tar\.gz)\"/';
            }

            $chosen_sources = array_map('trim', array_filter(explode(',', $this->getArgument('sources'))));

            $sss = $this->getOption('ignore-cache-sources');
            if ($sss === false) {
                // false is no-any-ignores, that is, default.
                $force_all = false;
                $force_list = [];
            } elseif ($sss === null) {
                // null means all sources will be ignored, equals to --force-all (but we don't want to add too many options)
                $force_all = true;
                $force_list = [];
            } else {
                // ignore some sources
                $force_all = false;
                $force_list = array_map('trim', array_filter(explode(',', $this->getOption('ignore-cache-sources'))));
            }

            if ($this->getOption('all')) {
                logger()->notice('Downloading with --all option will take more times to download, we recommend you to download with --for-extensions option !');
            }

            // Process -U options
            $custom_urls = [];
            foreach ($this->input->getOption('custom-url') as $value) {
                [$source_name, $url] = explode(':', $value, 2);
                $custom_urls[$source_name] = $url;
            }
            // Process -G options
            $custom_gits = [];
            foreach ($this->input->getOption('custom-git') as $value) {
                [$source_name, $branch, $url] = explode(':', $value, 3);
                $custom_gits[$source_name] = [$branch, $url];
            }

            // If passing --prefer-pre-built option, we need to load pre-built library list from pre-built.json targeted releases
            if ($this->getOption('prefer-pre-built')) {
                $repo = Config::getPreBuilt('repo');
                $pre_built_libs = Downloader::getLatestGithubRelease($repo, [
                    'repo' => $repo,
                    'prefer-stable' => Config::getPreBuilt('prefer-stable'),
                ], false);
            } else {
                $pre_built_libs = [];
            }

            // Download them
            f_mkdir(DOWNLOAD_PATH);
            $cnt = count($chosen_sources);
            $ni = 0;
            foreach ($chosen_sources as $source) {
                ++$ni;
                if (isset($custom_urls[$source])) {
                    $config = Config::getSource($source);
                    $new_config = [
                        'type' => 'url',
                        'url' => $custom_urls[$source],
                    ];
                    if (isset($config['path'])) {
                        $new_config['path'] = $config['path'];
                    }
                    if (isset($config['filename'])) {
                        $new_config['filename'] = $config['filename'];
                    }
                    logger()->info("[{$ni}/{$cnt}] Downloading source {$source} from custom url: {$new_config['url']}");
                    Downloader::downloadSource($source, $new_config, true);
                } elseif (isset($custom_gits[$source])) {
                    $config = Config::getSource($source);
                    $new_config = [
                        'type' => 'git',
                        'rev' => $custom_gits[$source][0],
                        'url' => $custom_gits[$source][1],
                    ];
                    if (isset($config['path'])) {
                        $new_config['path'] = $config['path'];
                    }
                    logger()->info("[{$ni}/{$cnt}] Downloading source {$source} from custom git: {$new_config['url']}");
                    Downloader::downloadSource($source, $new_config, true);
                } else {
                    $config = Config::getSource($source);
                    // Prefer pre-built, we need to search pre-built library
                    if ($this->getOption('prefer-pre-built') && ($config['provide-pre-built'] ?? false) === true) {
                        // We need to replace pattern
                        $replace = [
                            '{name}' => $source,
                            '{arch}' => arch2gnu(php_uname('m')),
                            '{os}' => strtolower(PHP_OS_FAMILY),
                            '{libc}' => SPCTarget::getLibc() ?? 'default',
                            '{libcver}' => SPCTarget::getLibcVersion() ?? 'default',
                        ];
                        $find = str_replace(array_keys($replace), array_values($replace), Config::getPreBuilt('match-pattern'));
                        // find filename in asset list
                        if (($url = $this->findPreBuilt($pre_built_libs, $find)) !== null) {
                            logger()->info("[{$ni}/{$cnt}] Downloading pre-built content {$source}");
                            Downloader::downloadSource($source, ['type' => 'url', 'url' => $url], $force_all || in_array($source, $force_list), SPC_DOWNLOAD_PRE_BUILT);
                            continue;
                        }
                        logger()->warning("Pre-built content not found for {$source}, fallback to source download");
                    }
                    logger()->info("[{$ni}/{$cnt}] Downloading source {$source}");
                    try {
                        Downloader::downloadSource($source, $config, $force_all || in_array($source, $force_list));
                    } /* @noinspection PhpRedundantCatchClauseInspection */ catch (DownloaderException|RuntimeException $e) {
                        // if `--no-alt` option is set, we will not download alternative sources
                        if ($this->getOption('no-alt')) {
                            throw $e;
                        }
                        // if download failed, we will try to download alternative sources
                        logger()->warning("Download failed: {$e->getMessage()}");
                        $alt_sources = Config::getSource($source)['alt'] ?? null;
                        if ($alt_sources === null) {
                            logger()->warning("No alternative sources found for {$source}, using default alternative source");
                            $alt_config = array_merge($config, Downloader::getDefaultAlternativeSource($source));
                        } elseif ($alt_sources === false) {
                            throw new DownloaderException("No alternative sources found for {$source}, skipping alternative download");
                        } else {
                            logger()->notice("Trying to download alternative sources for {$source}");
                            $alt_config = array_merge($config, $alt_sources);
                        }
                        Downloader::downloadSource($source, $alt_config, $force_all || in_array($source, $force_list));
                    }
                }
            }
            $time = round(microtime(true) - START_TIME, 3);
            logger()->info('Download complete, used ' . $time . ' s !');
            return static::SUCCESS;
        } catch (DownloaderException $e) {
            logger()->error($e->getMessage());
            return static::FAILURE;
        } catch (WrongUsageException $e) {
            logger()->critical($e->getMessage());
            return static::FAILURE;
        }
    }

    /**
     * @throws RuntimeException
     * @throws WrongUsageException
     */
    private function downloadFromZip(string $path): int
    {
        if (!file_exists($path)) {
            logger()->critical('File ' . $path . ' not exist or not a zip archive.');
            return static::FAILURE;
        }
        // remove old download files first
        if (is_dir(DOWNLOAD_PATH)) {
            logger()->warning('You are doing some operations that not recoverable: removing directories below');
            logger()->warning(DOWNLOAD_PATH);
            logger()->alert('I will remove these dir after 5 seconds !');
            sleep(5);
            f_passthru((PHP_OS_FAMILY === 'Windows' ? 'rmdir /s /q ' : 'rm -rf ') . DOWNLOAD_PATH);
        }
        // unzip command check
        if (PHP_OS_FAMILY !== 'Windows' && !$this->findCommand('unzip')) {
            logger()->critical('Missing unzip command, you need to install it first !');
            logger()->critical('You can use "bin/spc doctor" command to check and install required tools');
            return static::FAILURE;
        }
        // create downloads
        try {
            if (PHP_OS_FAMILY !== 'Windows') {
                $abs_path = realpath($path);
                f_passthru('mkdir ' . DOWNLOAD_PATH . ' && cd ' . DOWNLOAD_PATH . ' && unzip ' . escapeshellarg($abs_path));
            } else {
                // Windows TODO
                throw new WrongUsageException('Windows currently does not support --from-zip !');
            }

            if (!file_exists(LockFile::LOCK_FILE)) {
                throw new RuntimeException('.lock.json not exist in "downloads/"');
            }
        } catch (RuntimeException $e) {
            logger()->critical('Extract failed: ' . $e->getMessage());
            return static::FAILURE;
        }
        logger()->info('Extract success');
        return static::SUCCESS;
    }

    /**
     * Calculate the sources by extensions
     *
     * @param  array               $extensions       extension list
     * @param  bool                $include_suggests include suggested libs and extensions (default: true)
     * @throws FileSystemException
     * @throws WrongUsageException
     */
    private function calculateSourcesByExt(array $extensions, bool $include_suggests = true): array
    {
        [$extensions, $libraries] = $include_suggests ? DependencyUtil::getExtsAndLibs($extensions, [], true, true) : DependencyUtil::getExtsAndLibs($extensions);
        $sources = [];
        foreach ($extensions as $extension) {
            if (Config::getExt($extension, 'type') === 'external') {
                $sources[] = Config::getExt($extension, 'source');
            }
        }
        foreach ($libraries as $library) {
            $source = Config::getLib($library, 'source');
            if ($source !== null) {
                $sources[] = $source;
            }
        }
        return array_values(array_unique($sources));
    }

    /**
     * Calculate the sources by libraries
     *
     * @param  array               $libs             library list
     * @param  bool                $include_suggests include suggested libs (default: true)
     * @throws FileSystemException
     * @throws WrongUsageException
     */
    private function calculateSourcesByLib(array $libs, bool $include_suggests = true): array
    {
        $libs = DependencyUtil::getLibs($libs, $include_suggests);
        $sources = [];
        foreach ($libs as $library) {
            $sources[] = Config::getLib($library, 'source');
        }
        return array_values(array_unique($sources));
    }

    /**
     * @param  array       $assets   Asset list from GitHub API
     * @param  string      $filename Match file name, e.g. pkg-config-aarch64-darwin.txz
     * @return null|string Return the download URL if found, otherwise null
     */
    private function findPreBuilt(array $assets, string $filename): ?string
    {
        logger()->debug("Finding pre-built asset {$filename}");
        foreach ($assets as $asset) {
            if ($asset['name'] === $filename) {
                return $asset['browser_download_url'];
            }
        }
        return null;
    }

    /**
     * @throws RuntimeException
     */
    private function _clean(): int
    {
        logger()->warning('You are doing some operations that not recoverable: removing directories below');
        logger()->warning(SOURCE_PATH);
        logger()->warning(DOWNLOAD_PATH);
        logger()->warning(BUILD_ROOT_PATH);
        logger()->alert('I will remove these dir after 5 seconds !');
        sleep(5);
        if (PHP_OS_FAMILY === 'Windows') {
            f_passthru('rmdir /s /q ' . SOURCE_PATH);
            f_passthru('rmdir /s /q ' . DOWNLOAD_PATH);
            f_passthru('rmdir /s /q ' . BUILD_ROOT_PATH);
        } else {
            f_passthru('rm -rf ' . SOURCE_PATH . '/*');
            f_passthru('rm -rf ' . DOWNLOAD_PATH . '/*');
            f_passthru('rm -rf ' . BUILD_ROOT_PATH . '/*');
        }
        return static::FAILURE;
    }
}