static-php-cli/src/SPC/builder/Extension.php

<?php

declare(strict_types=1);

namespace SPC\builder;

use SPC\exception\FileSystemException;
use SPC\exception\RuntimeException;
use SPC\store\Config;

class Extension
{
    protected array $dependencies = [];

    /**
     * @throws RuntimeException
     * @throws FileSystemException
     */
    public function __construct(protected string $name, protected BuilderBase $builder)
    {
        $ext_type = Config::getExt($this->name, 'type');
        $unix_only = Config::getExt($this->name, 'unix-only', false);
        $windows_only = Config::getExt($this->name, 'windows-only', false);
        if (PHP_OS_FAMILY !== 'Windows' && $windows_only) {
            throw new RuntimeException("{$ext_type} extension {$name} is not supported on Linux and macOS platform");
        }
        if (PHP_OS_FAMILY === 'Windows' && $unix_only) {
            throw new RuntimeException("{$ext_type} extension {$name} is not supported on Windows platform");
        }
    }

    /**
     * 获取开启该扩展的 PHP 编译添加的参数
     *
     * @throws FileSystemException|RuntimeException
     */
    public function getConfigureArg(): string
    {
        $arg = $this->getEnableArg();
        switch (PHP_OS_FAMILY) {
            case 'Windows':
                $arg .= $this->getWindowsConfigureArg();
                break;
            case 'Darwin':
            case 'Linux':
                $arg .= $this->getUnixConfigureArg();
                break;
        }
        return $arg;
    }

    /**
     * 根据 ext 的 arg-type 获取对应开启的参数，一般都是 --enable-xxx 和 --with-xxx
     *
     * @throws FileSystemException
     * @throws RuntimeException
     */
    public function getEnableArg(): string
    {
        $_name = str_replace('_', '-', $this->name);
        return match ($arg_type = Config::getExt($this->name, 'arg-type', 'enable')) {
            'enable' => '--enable-' . $_name,
            'with' => '--with-' . $_name,
            'none', 'custom' => '',
            default => throw new RuntimeException("argType does not accept {$arg_type}, use [enable/with] ."),
        };
    }

    /**
     * 导出当前扩展依赖的所有 lib 库生成的 .a 静态编译库文件，以字符串形式导出，用空格分割
     */
    public function getLibFilesString(): string
    {
        $ret = array_map(
            fn ($x) => $x->getStaticLibFiles(),
            $this->getLibraryDependencies(recursive: true)
        );
        return implode(' ', $ret);
    }

    /**
     * 检查下依赖就行了，作用是导入依赖给 Extension 对象，今后可以对库依赖进行选择性处理
     *
     * @throws RuntimeException
     * @throws FileSystemException
     */
    public function checkDependency(): static
    {
        foreach (Config::getExt($this->name, 'lib-depends', []) as $name) {
            $this->addLibraryDependency($name);
        }
        foreach (Config::getExt($this->name, 'lib-suggests', []) as $name) {
            $this->addLibraryDependency($name, true);
        }
        foreach (Config::getExt($this->name, 'ext-depends', []) as $name) {
            $this->addExtensionDependency($name);
        }
        foreach (Config::getExt($this->name, 'ext-suggests', []) as $name) {
            $this->addExtensionDependency($name, true);
        }
        return $this;
    }

    public function getExtensionDependency(): array
    {
        return array_filter($this->dependencies, fn ($x) => $x instanceof Extension);
    }

    public function getName(): string
    {
        return $this->name;
    }

    /**
     * @throws RuntimeException
     */
    protected function addLibraryDependency(string $name, bool $optional = false): void
    {
        $depLib = $this->builder->getLib($name);
        if (!$depLib) {
            if (!$optional) {
                throw new RuntimeException("extension {$this->name} requires library {$name}");
            }
            logger()->info("enabling {$this->name} without library {$name}");
        } else {
            $this->dependencies[] = $depLib;
        }
    }

    /**
     * @throws RuntimeException
     */
    protected function addExtensionDependency(string $name, bool $optional = false): void
    {
        $depExt = $this->builder->getExt($name);
        if (!$depExt) {
            if (!$optional) {
                throw new RuntimeException("{$this->name} requires extension {$name}");
            }
            logger()->info("enabling {$this->name} without extension {$name}");
        } else {
            $this->dependencies[] = $depExt;
        }
    }

    private function getWindowsConfigureArg(): string
    {
        $arg = '';
        switch ($this->name) {
            case 'redis':
                // $arg = '--enable-redis';
                // if ($this->builder->getLib('zstd')) {
                //     $arg .= ' --enable-redis-zstd --with-libzstd ';
                // }
                break;
            case 'xml':
            case 'soap':
            case 'xmlreader':
            case 'xmlwriter':
            case 'dom':
                $arg .= ' --with-libxml ';
                break;
            case 'swow':
                if ($this->builder->getLib('openssl')) {
                    $arg .= ' --enable-swow-ssl';
                }
                if ($this->builder->getLib('curl')) {
                    $arg .= ' --enable-swow-curl';
                }
                break;
        }
        return $arg;
    }

    private function getUnixConfigureArg(): string
    {
        $arg = '';
        switch ($this->name) {
            /*case 'event':
                $arg = ' --with-event-core --with-event-libevent-dir="' . BUILD_ROOT_PATH . '"';
                if ($this->builder->getLib('openssl')) {
                    $arg .= ' --with-event-openssl --with-openssl-dir="' . BUILD_ROOT_PATH . '"';
                }
                break;*/
            case 'mbstring':
                $arg = ' --disable-mbregex ONIG_CFLAGS=-I"' . BUILD_ROOT_PATH . '" ' .
                'ONIG_LIBS="' . $this->getLibFilesString() . '" ';
                break;
            case 'gmp':
                $arg = ' --with-gmp="' . BUILD_ROOT_PATH . '" ';
                break;
            case 'sqlite3':
                $arg = ' --with-sqlite3="' . BUILD_ROOT_PATH . '" ' .
                'SQLITE_CFLAGS=-I"' . BUILD_INCLUDE_PATH . '" ' .
                'SQLITE_LIBS="' . $this->getLibFilesString() . '" ';
                break;
            case 'redis':
                $arg = ' --enable-redis --disable-redis-session';
                if ($this->builder->getLib('zstd')) {
                    $arg .= ' --enable-redis-zstd --with-libzstd="' . BUILD_ROOT_PATH . '" ';
                }
                break;
            case 'yaml':
                $arg .= ' --with-yaml="' . BUILD_ROOT_PATH . '" ';
                break;
            case 'zstd':
                $arg .= ' --with-libzstd';
                break;
            case 'bz2':
                $arg = ' --with-bz2="' . BUILD_ROOT_PATH . '" ';
                break;
            case 'openssl':
                $arg .= ' ' .
                    'OPENSSL_CFLAGS=-I"' . BUILD_INCLUDE_PATH . '" ' .
                    'OPENSSL_LIBS="' . $this->getLibFilesString() . '" ';
                break;
            case 'curl':
                $arg .= ' ' .
                    'CURL_CFLAGS=-I"' . BUILD_INCLUDE_PATH . '" ' .
                    'CURL_LIBS="' . $this->getLibFilesString() . '" ';
                break;
            case 'gd':
                if ($this->builder->getLib('freetype')) {
                    $arg .= ' --with-freetype ' .
                    'FREETYPE2_CFLAGS=-I"' . BUILD_INCLUDE_PATH . '/freetype2" ' .
                    'FREETYPE2_LIBS="' . $this->getLibFilesString() . '" ';
                }
                $arg .= ' ' .
                    'PNG_CFLAGS=-I"' . BUILD_INCLUDE_PATH . '" ' .
                    'PNG_LIBS="' . $this->getLibFilesString() . '" ';
                break;
                // TODO: other libraries
            case 'phar':
            case 'zlib':
                $arg .= ' ' .
                    'ZLIB_CFLAGS=-I"' . BUILD_INCLUDE_PATH . '" ' .
                    'ZLIB_LIBS="' . $this->getLibFilesString() . '" ';
                break;
            case 'xml': // xml may use expat
                if ($this->getLibraryDependencies()['expat'] ?? null) {
                    $arg .= ' --with-expat="' . BUILD_ROOT_PATH . '" ' .
                        'EXPAT_CFLAGS=-I"' . BUILD_INCLUDE_PATH . '" ' .
                        'EXPAT_LIBS="' . $this->getLibFilesString() . '" ';
                    break;
                }
                // no break
            case 'soap':
            case 'xmlreader':
            case 'xmlwriter':
            case 'dom':
                $arg .= ' --with-libxml="' . BUILD_ROOT_PATH . '" ' .
                    'LIBXML_CFLAGS=-I"' . realpath('include/libxml2') . '" ' .
                    'LIBXML_LIBS="' . $this->getLibFilesString() . '" ';
                break;
            case 'ffi':
                $arg .= ' ' .
                    'FFI_CFLAGS=-I"' . BUILD_INCLUDE_PATH . '" ' .
                    'FFI_LIBS="' . $this->getLibFilesString() . '" ';
                break;
            case 'zip':
                $arg .= ' ' .
                    'LIBZIP_CFLAGS=-I"' . BUILD_INCLUDE_PATH . '" ' .
                    'LIBZIP_LIBS="' . $this->getLibFilesString() . '" ';
                break;
            case 'mbregex':
                $arg .= ' ' .
                    'ONIG_CFLAGS=-I"' . BUILD_INCLUDE_PATH . '" ' .
                    'ONIG_LIBS="' . $this->getLibFilesString() . '" ';
                break;
            case 'swow':
                $arg .= $this->builder->getLib('openssl') ? ' --enable-swow-ssl' : ' --disable-swow-ssl';
                $arg .= $this->builder->getLib('curl') ? ' --enable-swow-curl' : ' --disable-swow-curl';
                break;
            case 'swoole':
                if ($this->builder->getLib('openssl')) {
                    $arg .= ' --enable-openssl';
                } else {
                    $arg .= ' --disable-openssl --without-openssl';
                }
        }
        return $arg;
    }

    private function getLibraryDependencies(bool $recursive = false): array
    {
        $ret = array_filter($this->dependencies, fn ($x) => $x instanceof LibraryBase);
        if (!$recursive) {
            return $ret;
        }

        $deps = [];

        $added = 1;
        while ($added !== 0) {
            $added = 0;
            foreach ($ret as $depName => $dep) {
                foreach ($dep->getDependencies(true) as $depdepName => $depdep) {
                    if (!in_array($depdepName, array_keys($deps), true)) {
                        $deps[$depdepName] = $depdep;
                        ++$added;
                    }
                }
                if (!in_array($depName, array_keys($deps), true)) {
                    $deps[$depName] = $dep;
                }
            }
        }

        return $deps;
    }
}