feat: Windows support

Author: Kévin Dunglas

caddy/frankenphp/cbrotli.go

@@ -0,0 +1,5 @@
+//go:build !nobrotli
+
+package main
+
+import _ "github.com/dunglas/caddy-cbrotli"

caddy/frankenphp/main.go

@@ -5,7 +5,6 @@ import (
 
 	// plug in Caddy modules here.
 	_ "github.com/caddyserver/caddy/v2/modules/standard"
-	_ "github.com/dunglas/caddy-cbrotli"
 	_ "github.com/dunglas/frankenphp/caddy"
 	_ "github.com/dunglas/mercure/caddy"
 	_ "github.com/dunglas/vulcain/caddy"

caddy/php-cli.go

@@ -1,3 +1,5 @@
+//go:build !windows
+
 package caddy
 
 import (

cgi.go

@@ -8,8 +8,8 @@ package frankenphp
 // #cgo noescape frankenphp_register_variables_from_request_info
 // #cgo noescape frankenphp_register_variable_safe
 // #cgo noescape frankenphp_register_single
-// #include <php_variables.h>
 // #include "frankenphp.h"
+// #include <php_variables.h>
 import "C"
 import (
 	"context"

cgo.go

@@ -1,9 +1,11 @@
 package frankenphp
 
 // #cgo darwin pkg-config: libxml-2.0
-// #cgo CFLAGS: -Wall -Werror
+// #cgo unix CFLAGS: -Wall -Werror
 // #cgo linux CFLAGS: -D_GNU_SOURCE
-// #cgo LDFLAGS: -lphp -lm -lutil
+// #cgo unix LDFLAGS: -lphp -lm -lutil
 // #cgo linux LDFLAGS: -ldl -lresolv
 // #cgo darwin LDFLAGS: -Wl,-rpath,/usr/local/lib -liconv -ldl
+// #cgo windows CFLAGS: -D_WINDOWS -DWINDOWS=1 -DZEND_WIN32=1 -DPHP_WIN32=1 -DWIN32 -D_MBCS -D_USE_MATH_DEFINES -DNDebug -DNDEBUG -DZEND_DEBUG=0 -DZTS=1 -DFD_SETSIZE=256
+// #cgo windows LDFLAGS: -lpthreadVC3
 import "C"

cli.go

@@ -0,0 +1,35 @@
+//go:build !windows
+
+// TODO: ignored on Windows for now (even if it should work with a custom PHP build),
+// because static builds of the embed SAPI aren't available yet and php.exe is ship with
+// the standard PHP distribution.
+
+package frankenphp
+
+// #include "frankenphp.h"
+import "C"
+import "unsafe"
+
+// ExecuteScriptCLI executes the PHP script passed as parameter.
+// It returns the exit status code of the script.
+func ExecuteScriptCLI(script string, args []string) int {
+	// Ensure extensions are registered before CLI execution
+	registerExtensions()
+
+	cScript := C.CString(script)
+	defer C.free(unsafe.Pointer(cScript))
+
+	argc, argv := convertArgs(args)
+	defer freeArgs(argv)
+
+	return int(C.frankenphp_execute_script_cli(cScript, argc, (**C.char)(unsafe.Pointer(&argv[0])), false))
+}
+
+func ExecutePHPCode(phpCode string) int {
+	// Ensure extensions are registered before CLI execution
+	registerExtensions()
+
+	cCode := C.CString(phpCode)
+	defer C.free(unsafe.Pointer(cCode))
+	return int(C.frankenphp_execute_script_cli(cCode, 0, nil, true))
+}

cli_test.go

@@ -0,0 +1,55 @@
+//go:build !windows
+
+package frankenphp_test
+
+import (
+	"errors"
+	"os"
+	"os/exec"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestExecuteScriptCLI(t *testing.T) {
+	if _, err := os.Stat("internal/testcli/testcli"); err != nil {
+		t.Skip("internal/testcli/testcli has not been compiled, run `cd internal/testcli/ && go build`")
+	}
+
+	cmd := exec.Command("internal/testcli/testcli", "testdata/command.php", "foo", "bar")
+	stdoutStderr, err := cmd.CombinedOutput()
+	assert.Error(t, err)
+
+	var exitError *exec.ExitError
+	if errors.As(err, &exitError) {
+		assert.Equal(t, 3, exitError.ExitCode())
+	}
+
+	stdoutStderrStr := string(stdoutStderr)
+
+	assert.Contains(t, stdoutStderrStr, `"foo"`)
+	assert.Contains(t, stdoutStderrStr, `"bar"`)
+	assert.Contains(t, stdoutStderrStr, "From the CLI")
+}
+
+func TestExecuteCLICode(t *testing.T) {
+	if _, err := os.Stat("internal/testcli/testcli"); err != nil {
+		t.Skip("internal/testcli/testcli has not been compiled, run `cd internal/testcli/ && go build`")
+	}
+
+	cmd := exec.Command("internal/testcli/testcli", "-r", "echo 'Hello World';")
+	stdoutStderr, err := cmd.CombinedOutput()
+	assert.NoError(t, err)
+
+	stdoutStderrStr := string(stdoutStderr)
+	assert.Equal(t, stdoutStderrStr, `Hello World`)
+}
+
+func ExampleExecuteScriptCLI() {
+	if len(os.Args) <= 1 {
+		log.Println("Usage: my-program script.php")
+		os.Exit(1)
+	}
+
+	os.Exit(frankenphp.ExecuteScriptCLI(os.Args[1], os.Args))
+}

ext.go

@@ -1,6 +1,6 @@
 package frankenphp
 
-//#include "frankenphp.h"
+// #include "frankenphp.h"
 import "C"
 import (
 	"sync"

frankenphp.c

@@ -1,14 +1,18 @@
+#include "frankenphp.h"
 #include <SAPI.h>
 #include <Zend/zend_alloc.h>
 #include <Zend/zend_exceptions.h>
 #include <Zend/zend_interfaces.h>
-#include <Zend/zend_types.h>
 #include <errno.h>
 #include <ext/spl/spl_exceptions.h>
 #include <ext/standard/head.h>
 #include <inttypes.h>
 #include <php.h>
+#ifdef PHP_WIN32
+#include <config.w32.h>
+#else
 #include <php_config.h>
+#endif
 #include <php_ini.h>
 #include <php_main.h>
 #include <php_output.h>
@@ -19,7 +23,9 @@
 #include <stdint.h>
 #include <stdio.h>
 #include <stdlib.h>
+#ifndef ZEND_WIN32
 #include <unistd.h>
+#endif
 #if defined(__linux__)
 #include <sys/prctl.h>
 #elif defined(__FreeBSD__) || defined(__OpenBSD__)
@@ -205,7 +211,7 @@ bool frankenphp_shutdown_dummy_request(void) {
   return true;
 }
 
-PHPAPI void get_full_env(zval *track_vars_array) {
+void get_full_env(zval *track_vars_array) {
   go_getfullenv(thread_index, track_vars_array);
 }
 
@@ -959,6 +965,7 @@ static void *php_thread(void *arg) {
 }
 
 static void *php_main(void *arg) {
+#ifndef ZEND_WIN32
   /*
    * SIGPIPE must be masked in non-Go threads:
    * https://pkg.go.dev/os/signal#hdr-Go_programs_that_use_cgo_or_SWIG
@@ -971,6 +978,7 @@ static void *php_main(void *arg) {
     perror("failed to block SIGPIPE");
     exit(EXIT_FAILURE);
   }
+#endif
 
   set_thread_name("php-main");
 
@@ -1188,6 +1196,7 @@ static void sapi_cli_register_variables(zval *track_vars_array) /* {{{ */
 }
 /* }}} */
 
+#ifndef ZEND_WIN32
 static void *execute_script_cli(void *arg) {
   void *exit_status;
   bool eval = (bool)arg;
@@ -1249,6 +1258,7 @@ int frankenphp_execute_script_cli(char *script, int argc, char **argv,
 
   return (intptr_t)exit_status;
 }
+#endif
 
 int frankenphp_reset_opcache(void) {
   zend_function *opcache_reset =
@@ -1266,7 +1276,7 @@ static zend_module_entry *modules = NULL;
 static int modules_len = 0;
 static int (*original_php_register_internal_extensions_func)(void) = NULL;
 
-PHPAPI int register_internal_extensions(void) {
+int register_internal_extensions(void) {
   if (original_php_register_internal_extensions_func != NULL &&
       original_php_register_internal_extensions_func() != SUCCESS) {
     return FAILURE;

frankenphp.go

@@ -14,10 +14,10 @@ package frankenphp
 
 // #include <stdlib.h>
 // #include <stdint.h>
+// #include "frankenphp.h"
 // #include <php_variables.h>
 // #include <zend_llist.h>
 // #include <SAPI.h>
-// #include "frankenphp.h"
 import "C"
 import (
 	"bytes"
@@ -753,30 +753,6 @@ func go_is_context_done(threadIndex C.uintptr_t) C.bool {
 	return C.bool(phpThreads[threadIndex].frankenPHPContext().isDone)
 }
 
-// ExecuteScriptCLI executes the PHP script passed as parameter.
-// It returns the exit status code of the script.
-func ExecuteScriptCLI(script string, args []string) int {
-	// Ensure extensions are registered before CLI execution
-	registerExtensions()
-
-	cScript := C.CString(script)
-	defer C.free(unsafe.Pointer(cScript))
-
-	argc, argv := convertArgs(args)
-	defer freeArgs(argv)
-
-	return int(C.frankenphp_execute_script_cli(cScript, argc, (**C.char)(unsafe.Pointer(&argv[0])), false))
-}
-
-func ExecutePHPCode(phpCode string) int {
-	// Ensure extensions are registered before CLI execution
-	registerExtensions()
-
-	cCode := C.CString(phpCode)
-	defer C.free(unsafe.Pointer(cCode))
-	return int(C.frankenphp_execute_script_cli(cCode, 0, nil, true))
-}
-
 func convertArgs(args []string) (C.int, []*C.char) {
 	argc := C.int(len(args))
 	argv := make([]*C.char, argc)