[3.0] Refactor extensions

.github/workflows/build-unix.yml

@@ -46,6 +46,10 @@ on:
         description: Prefer pre-built binaries (reduce build time)
         type: boolean
         default: true
+      with-suggested-libs:
+        description: Build with suggested libs
+        type: boolean
+        default: false
       debug:
         description: Show full build logs
         type: boolean
@@ -86,6 +90,10 @@ on:
         description: Prefer pre-built binaries (reduce build time)
         type: boolean
         default: true
+      with-suggested-libs:
+        description: Include suggested libs
+        type: boolean
+        default: false
       debug:
         description: Show full build logs
         type: boolean
@@ -157,6 +165,9 @@ jobs:
           if [ ${{ inputs.prefer-pre-built }} == true ]; then
               DOWN_CMD="$DOWN_CMD --prefer-pre-built"
           fi
+          if [ ${{ inputs.with-suggested-libs }} == true ]; then
+              BUILD_CMD="$BUILD_CMD --with-suggested-libs"
+          fi
           if [ ${{ inputs.build-cli }} == true ]; then
               BUILD_CMD="$BUILD_CMD --build-cli"
           fi
@@ -202,6 +213,14 @@ jobs:
 #        if: ${{ failure() }}
 #        uses: mxschmitt/action-tmate@v3
 
+      # Upload debug logs
+      - if: ${{ inputs.debug && failure() }}
+        name: "Upload build logs on failure"
+        uses: actions/upload-artifact@v4
+        with:
+          name: spc-logs-${{ inputs.php-version }}-${{ inputs.os }}
+          path: log/*.log
+
       # Upload cli executable
       - if: ${{ inputs.build-cli == true }}
         name: "Upload PHP cli SAPI"

README-zh.md

@@ -1,12 +1,12 @@
-# static-php-cli
+# StaticPHP
 
 [![English readme](https://img.shields.io/badge/README-English%20%F0%9F%87%AC%F0%9F%87%A7-moccasin?style=flat-square)](README.md)
 [![Chinese readme](https://img.shields.io/badge/README-%E4%B8%AD%E6%96%87%20%F0%9F%87%A8%F0%9F%87%B3-moccasin?style=flat-square)](README-zh.md)
 [![Releases](https://img.shields.io/packagist/v/crazywhalecc/static-php-cli?include_prereleases&label=Release&style=flat-square)](https://github.com/crazywhalecc/static-php-cli/releases)
 [![CI](https://img.shields.io/github/actions/workflow/status/crazywhalecc/static-php-cli/tests.yml?branch=main&label=Build%20Test&style=flat-square)](https://github.com/crazywhalecc/static-php-cli/actions/workflows/tests.yml)
 [![License](https://img.shields.io/badge/License-MIT-blue.svg?style=flat-square)](https://github.com/crazywhalecc/static-php-cli/blob/main/LICENSE)
 
-**static-php-cli** 是一个用于构建静态、独立 PHP 运行时的强大工具，支持众多流行扩展。
+**StaticPHP** 是一个用于构建静态编译可执行文件（包括 PHP、扩展等）的强大工具。
 
 ## 特性
 
@@ -80,7 +80,7 @@ download-options:
 
 ### 3. 静态 PHP 使用
 
-现在您可以将 static-php-cli 构建的二进制文件复制到另一台机器上，无需依赖即可运行：
+现在您可以将 StaticPHP 构建的二进制文件复制到另一台机器上，无需依赖即可运行：
 
 ```
 # php-cli
@@ -97,7 +97,7 @@ buildroot/bin/php-fpm -v
 
 ## 文档
 
-当前 README 包含基本用法。有关 static-php-cli 的所有功能，
+当前 README 包含基本用法。有关 StaticPHP 的所有功能，
 请访问 <https://static-php.dev>。
 
 ## 直接下载

README.md

@@ -1,13 +1,12 @@
-# static-php-cli
+# StaticPHP
 
 [![Chinese readme](https://img.shields.io/badge/README-%E4%B8%AD%E6%96%87%20%F0%9F%87%A8%F0%9F%87%B3-moccasin?style=flat-square)](README-zh.md)
 [![English readme](https://img.shields.io/badge/README-English%20%F0%9F%87%AC%F0%9F%87%A7-moccasin?style=flat-square)](README.md)
 [![Releases](https://img.shields.io/packagist/v/crazywhalecc/static-php-cli?include_prereleases&label=Release&style=flat-square)](https://github.com/crazywhalecc/static-php-cli/releases)
 [![CI](https://img.shields.io/github/actions/workflow/status/crazywhalecc/static-php-cli/tests.yml?branch=main&label=Build%20Test&style=flat-square)](https://github.com/crazywhalecc/static-php-cli/actions/workflows/tests.yml)
 [![License](https://img.shields.io/badge/License-MIT-blue.svg?style=flat-square)](https://github.com/crazywhalecc/static-php-cli/blob/main/LICENSE)
 
-**static-php-cli** is a powerful tool designed for building static, standalone PHP runtime
-with popular extensions.
+**StaticPHP** is a powerful tool designed for building portable executables including PHP, extensions, and more.
 
 ## Features
 
@@ -81,7 +80,7 @@ Run command:
 
 ### 3. Static PHP usage
 
-Now you can copy binaries built by static-php-cli to another machine and run with no dependencies:
+Now you can copy binaries built by StaticPHP to another machine and run with no dependencies:
 
 ```
 # php-cli
@@ -98,7 +97,7 @@ buildroot/bin/php-fpm -v
 
 ## Documentation
 
-The current README contains basic usage. For all the features of static-php-cli,
+The current README contains basic usage. For all the features of StaticPHP,
 see <https://static-php.dev> .
 
 ## Direct Download

config/lib.json

@@ -373,6 +373,15 @@
         ],
         "static-libs-windows": [
             "avif.lib"
+        ],
+        "lib-depends": [
+            "libaom"
+        ],
+        "lib-suggests": [
+            "libwebp",
+            "libjpeg",
+            "libxml2",
+            "libpng"
         ]
     },
     "libcares": {

config/pkg/ext/ext-apcu.yml

@@ -0,0 +1,11 @@
+ext-apcu:
+  type: php-extension
+  artifact:
+    source:
+      type: url
+      url: 'https://pecl.php.net/get/APCu'
+      extract: php-src/ext/apcu
+      filename: apcu.tgz
+    metadata:
+      license-files: [LICENSE]
+      license: PHP-3.01

config/source.json

@@ -526,7 +526,7 @@
     "libavif": {
         "type": "ghtar",
         "repo": "AOMediaCodec/libavif",
-        "provide-pre-built": true,
+        "provide-pre-built": false,
         "license": {
             "type": "file",
             "path": "LICENSE"

src/Package/Library/libacl.php

@@ -8,6 +8,7 @@
 use StaticPHP\Attribute\Package\BeforeStage;
 use StaticPHP\Attribute\Package\BuildFor;
 use StaticPHP\Attribute\Package\Library;
+use StaticPHP\Attribute\PatchDescription;
 use StaticPHP\Package\LibraryPackage;
 use StaticPHP\Runtime\Executor\UnixAutoconfExecutor;
 use StaticPHP\Util\FileSystem;
@@ -16,6 +17,7 @@
 class libacl
 {
     #[BeforeStage('php', [php::class, 'makeForUnix'], 'libacl')]
+    #[PatchDescription('Fix FPM_EXTRA_LIBS to avoid linking with acl on Unix')]
     public function patchBeforeMakePhpUnix(LibraryPackage $lib): void
     {
         $file_path = SOURCE_PATH . '/php-src/Makefile';

src/Package/Library/postgresql.php

@@ -27,8 +27,11 @@ class postgresql extends LibraryPackage
     #[PatchDescription('Patch to avoid explicit_bzero detection issues on some systems')]
     public function patchBeforePHPConfigure(TargetPackage $package): void
     {
-        shell()->cd($package->getSourceDir())
-            ->exec('sed -i.backup "s/ac_cv_func_explicit_bzero\" = xyes/ac_cv_func_explicit_bzero\" = x_fake_yes/" ./configure');
+        if (SystemTarget::getTargetOS() === 'Darwin') {
+            // on macOS, explicit_bzero is available but causes build failure due to detection issues, so we fake it as unavailable
+            shell()->cd($package->getSourceDir())
+                ->exec('sed -i.backup "s/ac_cv_func_explicit_bzero\" = xyes/ac_cv_func_explicit_bzero\" = x_fake_yes/" ./configure');
+        }
     }
 
     #[PatchBeforeBuild]

src/Package/Target/php.php

@@ -4,6 +4,7 @@
 
 namespace Package\Target;
 
+use Package\Target\php\frankenphp;
 use Package\Target\php\unix;
 use Package\Target\php\windows;
 use StaticPHP\Attribute\Package\BeforeStage;
@@ -42,6 +43,7 @@ class php extends TargetPackage
 {
     use unix;
     use windows;
+    use frankenphp;
 
     /** @var string[] Supported major PHP versions */
     public const array SUPPORTED_MAJOR_VERSIONS = ['7.4', '8.0', '8.1', '8.2', '8.3', '8.4', '8.5'];
@@ -119,6 +121,7 @@ public function init(TargetPackage $package): void
         $package->addBuildOption('with-config-file-scan-dir', null, InputOption::VALUE_REQUIRED, 'Set the directory to scan for .ini files after reading php.ini', PHP_OS_FAMILY === 'Windows' ? null : '/usr/local/etc/php/conf.d');
         $package->addBuildOption('with-hardcoded-ini', 'I', InputOption::VALUE_IS_ARRAY | InputOption::VALUE_REQUIRED, 'Patch PHP source code, inject hardcoded INI');
         $package->addBuildOption('enable-zts', null, null, 'Enable thread safe support');
+        $package->addBuildOption('no-smoke-test', null, InputOption::VALUE_OPTIONAL, 'Disable smoke test for specific SAPIs, or all if no value provided', false);
 
         // phpmicro build options
         if ($package->getName() === 'php' || $package->getName() === 'php-micro') {
@@ -198,6 +201,11 @@ public function resolveBuild(TargetPackage $package, PackageInstaller $installer
             $installer->addBuildPackage('php-embed');
         }
 
+        // frankenphp depends on embed SAPI (libphp.a)
+        if ($package->getName() === 'frankenphp') {
+            $installer->addBuildPackage('php-embed');
+        }
+
         return [...$extensions_pkg, ...$additional_packages];
     }
 
@@ -209,7 +217,7 @@ public function validate(Package $package): void
             if (!$package->getBuildOption('enable-zts')) {
                 throw new WrongUsageException('FrankenPHP SAPI requires ZTS enabled PHP, build with `--enable-zts`!');
             }
-            // frankenphp doesn't support windows, BSD is currently not supported by static-php-cli
+            // frankenphp doesn't support windows, BSD is currently not supported by StaticPHP
             if (!in_array(PHP_OS_FAMILY, ['Linux', 'Darwin'])) {
                 throw new WrongUsageException('FrankenPHP SAPI is only available on Linux and macOS!');
             }
@@ -272,10 +280,10 @@ public function beforeBuild(PackageBuilder $builder, Package $package): void
         // Patch StaticPHP version
         // detect patch (remove this when 8.3 deprecated)
         $file = FileSystem::readFile("{$package->getSourceDir()}/main/main.c");
-        if (!str_contains($file, 'static-php-cli.version')) {
+        if (!str_contains($file, 'StaticPHP.version')) {
             $version = SPC_VERSION;
-            logger()->debug('Inserting static-php-cli.version to php-src');
-            $file = str_replace('PHP_INI_BEGIN()', "PHP_INI_BEGIN()\n\tPHP_INI_ENTRY(\"static-php-cli.version\",\t\"{$version}\",\tPHP_INI_ALL,\tNULL)", $file);
+            logger()->debug('Inserting StaticPHP.version to php-src');
+            $file = str_replace('PHP_INI_BEGIN()', "PHP_INI_BEGIN()\n\tPHP_INI_ENTRY(\"StaticPHP.version\",\t\"{$version}\",\tPHP_INI_ALL,\tNULL)", $file);
             FileSystem::writeFile("{$package->getSourceDir()}/main/main.c", $file);
         }
 

src/Package/Target/php/frankenphp.php

@@ -7,6 +7,7 @@
 use Package\Target\php;
 use StaticPHP\Attribute\Package\Stage;
 use StaticPHP\Exception\SPCInternalException;
+use StaticPHP\Exception\ValidationException;
 use StaticPHP\Exception\WrongUsageException;
 use StaticPHP\Package\PackageBuilder;
 use StaticPHP\Package\PackageInstaller;
@@ -22,13 +23,14 @@
 trait frankenphp
 {
     #[Stage]
-    public function buildFrankenphpUnix(TargetPackage $package, PackageInstaller $installer, ToolchainInterface $toolchain, PackageBuilder $builder): void
+    public function buildFrankenphpForUnix(TargetPackage $package, PackageInstaller $installer, ToolchainInterface $toolchain, PackageBuilder $builder): void
     {
         if (getenv('GOROOT') === false) {
             throw new SPCInternalException('go-xcaddy is not initialized properly. GOROOT is not set.');
         }
 
         // process --with-frankenphp-app option
+        InteractiveTerm::setMessage('Building frankenphp: ' . ConsoleColor::yellow('processing --with-frankenphp-app option'));
         $package->runStage([$this, 'processFrankenphpApp']);
 
         // modules
@@ -88,6 +90,7 @@ public function buildFrankenphpUnix(TargetPackage $package, PackageInstaller $in
             'CGO_LDFLAGS' => "{$package->getLibExtraLdFlags()} {$staticFlags} {$config['ldflags']} {$libs}",
             'XCADDY_GO_BUILD_FLAGS' => '-buildmode=pie ' .
                 '-ldflags \"-linkmode=external ' . $extLdFlags . ' ' .
+                '-X \'github.com/caddyserver/caddy/v2/modules/caddyhttp.ServerHeader=FrankenPHP Caddy\' ' .
                 '-X \'github.com/caddyserver/caddy/v2.CustomVersion=FrankenPHP ' .
                 "v{$frankenphp_version} PHP {$libphp_version} Caddy'\\\" " .
                 "-tags={$muslTags}nobadger,nomysql,nopgx{$no_brotli}{$no_watcher}",
@@ -102,6 +105,29 @@ public function buildFrankenphpUnix(TargetPackage $package, PackageInstaller $in
         $package->setOutput('Binary path for FrankenPHP SAPI', BUILD_BIN_PATH . '/frankenphp');
     }
 
+    #[Stage]
+    public function smokeTestFrankenphpForUnix(): void
+    {
+        InteractiveTerm::setMessage('Running FrankenPHP smoke test');
+        $frankenphp = BUILD_BIN_PATH . '/frankenphp';
+        if (!file_exists($frankenphp)) {
+            throw new ValidationException(
+                "FrankenPHP binary not found: {$frankenphp}",
+                validation_module: 'FrankenPHP smoke test'
+            );
+        }
+        $prefix = PHP_OS_FAMILY === 'Darwin' ? 'DYLD_' : 'LD_';
+        [$ret, $output] = shell()
+            ->setEnv(["{$prefix}LIBRARY_PATH" => BUILD_LIB_PATH])
+            ->execWithResult("{$frankenphp} version");
+        if ($ret !== 0 || !str_contains(implode('', $output), 'FrankenPHP')) {
+            throw new ValidationException(
+                'FrankenPHP failed smoke test: ret[' . $ret . ']. out[' . implode('', $output) . ']',
+                validation_module: 'FrankenPHP smoke test'
+            );
+        }
+    }
+
     /**
      * Process the --with-frankenphp-app option
      * Creates app.tar and app.checksum in source/frankenphp directory
@@ -114,7 +140,6 @@ public function processFrankenphpApp(TargetPackage $package): void
         $frankenphpAppPath = $package->getBuildOption('with-frankenphp-app');
 
         if ($frankenphpAppPath) {
-            InteractiveTerm::setMessage('Building frankenphp: ' . ConsoleColor::yellow('processing --with-frankenphp-app option'));
             if (!is_dir($frankenphpAppPath)) {
                 throw new WrongUsageException("The path provided to --with-frankenphp-app is not a valid directory: {$frankenphpAppPath}");
             }