feat: add helpers to create PHP extensions (#1644)

* feat: add helpers to create PHP extensions

* cs

* feat: GoString

* test

* add test for RegisterExtension

* cs

* optimize includes

* fix

Author: dunglas

ext.go

@@ -0,0 +1,29 @@
+package frankenphp
+
+//#include "frankenphp.h"
+import "C"
+import (
+	"sync"
+	"unsafe"
+)
+
+var (
+	extensions   []*C.zend_module_entry
+	registerOnce sync.Once
+)
+
+// RegisterExtension registers a new PHP extension.
+func RegisterExtension(me unsafe.Pointer) {
+	extensions = append(extensions, (*C.zend_module_entry)(me))
+}
+
+func registerExtensions() {
+	if len(extensions) == 0 {
+		return
+	}
+
+	registerOnce.Do(func() {
+		C.register_extensions(extensions[0], C.int(len(extensions)))
+		extensions = nil
+	})
+}

frankenphp.c

@@ -1182,3 +1182,34 @@ int frankenphp_reset_opcache(void) {
 }
 
 int frankenphp_get_current_memory_limit() { return PG(memory_limit); }
+
+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) {
+  if (original_php_register_internal_extensions_func != NULL &&
+      original_php_register_internal_extensions_func() != SUCCESS) {
+    return FAILURE;
+  }
+
+  for (int i = 0; i < modules_len; i++) {
+    if (zend_register_internal_module(&modules[i]) == NULL) {
+      return FAILURE;
+    }
+  }
+
+  modules = NULL;
+  modules_len = 0;
+
+  return SUCCESS;
+}
+
+void register_extensions(zend_module_entry *m, int len) {
+  modules = m;
+  modules_len = len;
+
+  original_php_register_internal_extensions_func =
+      php_register_internal_extensions_func;
+  php_register_internal_extensions_func = register_internal_extensions;
+}

frankenphp.go

@@ -226,6 +226,8 @@ func Init(options ...Option) error {
 	// Docker/Moby has a similar hack: https://github.com/moby/moby/blob/d828b032a87606ae34267e349bf7f7ccb1f6495a/cmd/dockerd/docker.go#L87-L90
 	signal.Ignore(syscall.SIGPIPE)
 
+	registerExtensions()
+
 	opt := &opt{}
 	for _, o := range options {
 		if err := o(opt); err != nil {

frankenphp.h

@@ -2,6 +2,7 @@
 #define _FRANKENPPHP_H
 
 #include <Zend/zend_types.h>
+#include <Zend/zend_modules.h>
 #include <stdbool.h>
 #include <stdint.h>
 
@@ -92,4 +93,6 @@ void frankenphp_register_bulk(
     ht_key_value_pair auth_type, ht_key_value_pair remote_ident,
     ht_key_value_pair request_uri);
 
+void register_extensions(zend_module_entry *m, int len);
+
 #endif

internal/testext/ext_test.go

@@ -0,0 +1,7 @@
+package testext
+
+import "testing"
+
+func TestRegisterExtension(t *testing.T) {
+	testRegisterExtension(t)
+}

internal/testext/extension.h

@@ -0,0 +1,9 @@
+#ifndef _EXTENSIONS_H
+#define _EXTENSIONS_H
+
+#include <php.h>
+
+extern zend_module_entry module1_entry;
+extern zend_module_entry module2_entry;
+
+#endif

internal/testext/extensions.c

@@ -0,0 +1,26 @@
+#include <php.h>
+#include <zend_exceptions.h>
+
+#include "_cgo_export.h"
+
+zend_module_entry module1_entry = {STANDARD_MODULE_HEADER,
+                                   "ext1",
+                                   NULL, /* Functions */
+                                   NULL, /* MINIT */
+                                   NULL, /* MSHUTDOWN */
+                                   NULL, /* RINIT */
+                                   NULL, /* RSHUTDOWN */
+                                   NULL, /* MINFO */
+                                   "0.1.0",
+                                   STANDARD_MODULE_PROPERTIES};
+
+zend_module_entry module2_entry = {STANDARD_MODULE_HEADER,
+                                   "ext2",
+                                   NULL, /* Functions */
+                                   NULL, /* MINIT */
+                                   NULL, /* MSHUTDOWN */
+                                   NULL, /* RINIT */
+                                   NULL, /* RSHUTDOWN */
+                                   NULL, /* MINFO */
+                                   "0.1.0",
+                                   STANDARD_MODULE_PROPERTIES};

internal/testext/exttest.go

@@ -0,0 +1,36 @@
+package testext
+
+//#include "extension.h"
+import "C"
+import (
+	"github.com/dunglas/frankenphp"
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+	"io"
+	"net/http/httptest"
+	"testing"
+	"unsafe"
+)
+
+func testRegisterExtension(t *testing.T) {
+	frankenphp.RegisterExtension(unsafe.Pointer(&C.module1_entry))
+	frankenphp.RegisterExtension(unsafe.Pointer(&C.module2_entry))
+
+	err := frankenphp.Init()
+	require.Nil(t, err)
+	defer frankenphp.Shutdown()
+
+	req := httptest.NewRequest("GET", "http://example.com/index.php", nil)
+	w := httptest.NewRecorder()
+
+	req, err = frankenphp.NewRequestWithContext(req, frankenphp.WithRequestDocumentRoot("./testdata", false))
+	assert.NoError(t, err)
+
+	err = frankenphp.ServeHTTP(w, req)
+	assert.NoError(t, err)
+
+	resp := w.Result()
+	body, _ := io.ReadAll(resp.Body)
+	assert.Contains(t, string(body), "ext1")
+	assert.Contains(t, string(body), "ext2")
+}

internal/testext/testdata/index.php

@@ -0,0 +1,3 @@
+<?php
+
+print_r(get_loaded_extensions());

types.go

@@ -0,0 +1,16 @@
+package frankenphp
+
+//#include <zend.h>
+import "C"
+import "unsafe"
+
+// EXPERIMENTAL: GoString converts a zend_string to a Go string without copy.
+func GoString(s unsafe.Pointer) string {
+	if s == nil {
+		return ""
+	}
+
+	zendStr := (*C.zend_string)(s)
+
+	return C.GoStringN((*C.char)(unsafe.Pointer(&zendStr.val)), C.int(zendStr.len))
+}