Add example mini-curl and optional parameters support.

jmjoy · jmjoy · commit 6dd741cedc75 · 2020-11-24T21:27:01.000+08:00
diff --git a/Cargo.toml b/Cargo.toml
@@ -10,4 +10,5 @@ members = [
     # internal
     "examples/hello",
     "examples/hello-class",
+    "examples/mini-curl",
 ]
diff --git a/examples/hello-class/Cargo.toml b/examples/hello-class/Cargo.toml
@@ -4,6 +4,7 @@ version = "0.2.0"
 authors = ["jmjoy <918734043@qq.com>"]
 edition = "2018"
 publish = false
+license = "Unlicense"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
diff --git a/examples/hello-class/src/lib.rs b/examples/hello-class/src/lib.rs
@@ -23,13 +23,13 @@ static HELLO_CLASS_ENABLE: ModuleGlobals<bool> = ModuleGlobals::new(false);
 static HELLO_CLASS_DESCRIPTION: ModuleGlobals<*const c_char> = ModuleGlobals::new(null());
 
 static INI_ENTRIES: IniEntries<2> = IniEntries::new([
-    HELLO_CLASS_ENABLE.create_ini_entry_def(
+    HELLO_CLASS_ENABLE.create_ini_entry(
         "hello_class.enable",
         "1",
         Some(OnUpdateBool),
         PHP_INI_SYSTEM,
     ),
-    HELLO_CLASS_DESCRIPTION.create_ini_entry_def(
+    HELLO_CLASS_DESCRIPTION.create_ini_entry(
         "hello_class.description",
         "",
         Some(OnUpdateString),
@@ -93,8 +93,11 @@ fn module_info(module: &ModuleEntry) {
     }
 }
 
-static ARG_INFO_HELLO_CLASS_SAY_HELLO: MultiInternalArgInfo<1> =
-    MultiInternalArgInfo::new([create_zend_arg_info(c_str_ptr!("prefix"), false)], false);
+static ARG_INFO_HELLO_CLASS_SAY_HELLO: MultiInternalArgInfo<1> = MultiInternalArgInfo::new(
+    1,
+    false,
+    [create_zend_arg_info(c_str_ptr!("prefix"), false)],
+);
 
 static HELLO_CLASS_METHODS: FunctionEntries<1> = FunctionEntries::new([zend_function_entry {
     fname: c_str_ptr!("sayHello"),
diff --git a/examples/hello/Cargo.toml b/examples/hello/Cargo.toml
@@ -4,6 +4,7 @@ version = "0.2.0"
 authors = ["jmjoy <918734043@qq.com>"]
 edition = "2018"
 publish = false
+license = "Unlicense"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
diff --git a/examples/hello/src/lib.rs b/examples/hello/src/lib.rs
@@ -18,7 +18,7 @@ use phper::{
 
 static SIMPLE_ENABLE: ModuleGlobals<bool> = ModuleGlobals::new(false);
 
-static INI_ENTRIES: IniEntries<1> = IniEntries::new([SIMPLE_ENABLE.create_ini_entry_def(
+static INI_ENTRIES: IniEntries<1> = IniEntries::new([SIMPLE_ENABLE.create_ini_entry(
     "hello.enable",
     "1",
     Some(OnUpdateBool),
@@ -73,7 +73,7 @@ pub fn say_hello(execute_data: &mut ExecuteData) -> impl SetVal {
 }
 
 static ARG_INFO_SAY_HELLO: MultiInternalArgInfo<1> =
-    MultiInternalArgInfo::new([create_zend_arg_info(c_str_ptr!("name"), false)], false);
+    MultiInternalArgInfo::new(1, false, [create_zend_arg_info(c_str_ptr!("name"), false)]);
 
 static FUNCTION_ENTRIES: FunctionEntries<1> = FunctionEntries::new([zend_function_entry {
     fname: c_str_ptr!("say_hello"),
diff --git a/examples/mini-curl/Cargo.toml b/examples/mini-curl/Cargo.toml
@@ -0,0 +1,22 @@
+[package]
+name = "mini_curl"
+version = "0.2.0"
+authors = ["jmjoy <918734043@qq.com>"]
+edition = "2018"
+publish = false
+license = "Unlicense"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[lib]
+crate-type = ["cdylib"]
+
+[dependencies]
+curl = "0.4.34"
+phper = { version = "0.2", path = "../../phper" }
+
+[dev-dependencies]
+phper-test = { version = "0.2", path = "../../phper-test" }
+
+[build-dependencies]
+phper-build = { version = "0.2", path = "../../phper-build" }
diff --git a/examples/mini-curl/Makefile.toml b/examples/mini-curl/Makefile.toml
@@ -0,0 +1,30 @@
+[env]
+PHP_CONFIG = "php-config"
+TARGET_DIR = "${CARGO_MAKE_WORKING_DIRECTORY}/../../target"
+
+[env.development]
+TARGET_BUILD_DIR = "${TARGET_DIR}/debug"
+BUILD_ARGS = "--"
+TEST_ARGS = "--"
+
+[env.production]
+TARGET_BUILD_DIR = "${TARGET_DIR}/release"
+BUILD_ARGS = "--release"
+TEST_ARGS = "--release"
+
+[tasks.build]
+command = "cargo"
+args = ["build", "${BUILD_ARGS}"]
+
+[tasks.test]
+command = "cargo"
+args = ["test", "${TEST_ARGS}", "--", "--nocapture"]
+
+[tasks.install]
+dependencies = ["build"]
+script = [
+    """
+    cp ${TARGET_BUILD_DIR}/lib${CARGO_MAKE_CRATE_NAME}.so `${PHP_CONFIG} --extension-dir`/${CARGO_MAKE_CRATE_NAME}.so && \
+    echo Installing shared extensions:     `${PHP_CONFIG} --extension-dir`
+    """
+]
diff --git a/examples/mini-curl/build.rs b/examples/mini-curl/build.rs
@@ -0,0 +1,3 @@
+fn main() {
+    phper_build::register_configures();
+}
diff --git a/examples/mini-curl/src/lib.rs b/examples/mini-curl/src/lib.rs
@@ -0,0 +1,106 @@
+use phper::{
+    c_str_ptr, php_fn, php_function, php_minfo, php_minfo_function, php_minit, php_minit_function,
+    php_mshutdown, php_mshutdown_function, php_rinit, php_rinit_function, php_rshutdown,
+    php_rshutdown_function,
+    sys::{php_info_print_table_end, php_info_print_table_start, PHP_INI_SYSTEM},
+    zend::{
+        api::{FunctionEntries, FunctionEntryBuilder},
+        compile::{create_zend_arg_info, MultiInternalArgInfo},
+        ini::{create_ini_entry, IniEntries},
+        modules::{create_zend_module_entry, ModuleArgs, ModuleEntry},
+        types::{ClassEntry, ExecuteData, ReturnValue, SetVal},
+    },
+    zend_get_module,
+};
+use std::ptr::null;
+
+static MINI_CURL_CE: ClassEntry = ClassEntry::new();
+
+static INI_ENTRIES: IniEntries<1> =
+    IniEntries::new([create_ini_entry("curl.cainfo", "", PHP_INI_SYSTEM)]);
+
+#[php_minit_function]
+fn module_init(args: ModuleArgs) -> bool {
+    args.register_ini_entries(&INI_ENTRIES);
+    MINI_CURL_CE.init("MiniCurl", &MINI_CURL_METHODS);
+    true
+}
+
+#[php_mshutdown_function]
+fn module_shutdown(args: ModuleArgs) -> bool {
+    args.unregister_ini_entries();
+    true
+}
+
+#[php_rinit_function]
+fn request_init(_args: ModuleArgs) -> bool {
+    true
+}
+
+#[php_rshutdown_function]
+fn request_shutdown(_args: ModuleArgs) -> bool {
+    true
+}
+
+#[php_minfo_function]
+fn module_info(__module: &ModuleEntry) {
+    unsafe {
+        php_info_print_table_start();
+        php_info_print_table_end();
+    }
+}
+
+static ARG_INFO_VOID: MultiInternalArgInfo<0> = MultiInternalArgInfo::new(0, false, []);
+
+static ARG_INFO_MINI_CURL_CONSTRUCT: MultiInternalArgInfo<1> =
+    MultiInternalArgInfo::new(0, false, [create_zend_arg_info(c_str_ptr!("url"), false)]);
+
+static MINI_CURL_METHODS: FunctionEntries<2> = FunctionEntries::new([
+    FunctionEntryBuilder::new(
+        c_str_ptr!("__construct"),
+        Some(php_fn!(mini_curl_construct)),
+    )
+    .arg_info(&ARG_INFO_MINI_CURL_CONSTRUCT)
+    .build(),
+    FunctionEntryBuilder::new(c_str_ptr!("__destruct"), Some(php_fn!(mini_curl_destruct)))
+        .arg_info(&ARG_INFO_VOID)
+        .build(),
+]);
+
+#[php_function]
+pub fn mini_curl_construct(execute_data: &mut ExecuteData) -> impl SetVal {
+    match execute_data
+        .parse_parameters_optional("")
+        .map(|_url: &str| {})
+    {
+        Some(_) => ReturnValue::Bool(true),
+        None => ReturnValue::Bool(false),
+    }
+}
+
+#[php_function]
+pub fn mini_curl_destruct(execute_data: &mut ExecuteData) -> impl SetVal {
+    if execute_data.parse_parameters::<()>().is_none() {
+        return ReturnValue::Bool(false);
+    }
+
+    ReturnValue::Null
+}
+
+static MODULE_ENTRY: ModuleEntry = ModuleEntry::new(create_zend_module_entry(
+    c_str_ptr!(env!("CARGO_PKG_NAME")),
+    c_str_ptr!(env!("CARGO_PKG_VERSION")),
+    null(),
+    Some(php_minit!(module_init)),
+    Some(php_mshutdown!(module_shutdown)),
+    Some(php_rinit!(request_init)),
+    Some(php_rshutdown!(request_shutdown)),
+    Some(php_minfo!(module_info)),
+    None,
+    None,
+));
+
+#[zend_get_module]
+pub fn get_module() -> &'static ModuleEntry {
+    &MODULE_ENTRY
+}
diff --git a/examples/mini-curl/tests/integration.rs b/examples/mini-curl/tests/integration.rs
@@ -0,0 +1,17 @@
+use phper_test::test_php_scripts;
+use std::{env, path::Path};
+
+#[test]
+fn test_php() {
+    test_php_scripts(
+        Path::new(env!("CARGO_MANIFEST_DIR"))
+            .join("..")
+            .join("..")
+            .join("target"),
+        env!("CARGO_PKG_NAME"),
+        &[Path::new(env!("CARGO_MANIFEST_DIR"))
+            .join("tests")
+            .join("php")
+            .join("test.php")],
+    );
+}
diff --git a/examples/mini-curl/tests/php/test.php b/examples/mini-curl/tests/php/test.php
@@ -0,0 +1,13 @@
+<?php
+
+ini_set("display_errors", "On");
+ini_set("display_startup_errors", "On");
+error_reporting(E_ALL);
+
+new MiniCurl("http://httpbin.org/ip");
+
+function assert_eq($left, $right) {
+    if ($left !== $right) {
+        throw new Exception("left != right,\n left: {$left},\n right: {$right};");
+    }
+}
diff --git a/phper-alloc/src/lib.rs b/phper-alloc/src/lib.rs
@@ -8,6 +8,7 @@ use std::{
 };
 
 pub type EBox<T> = Box<T, Allocator>;
+pub type EVec<T> = Vec<T, Allocator>;
 
 pub struct Allocator {
     #[cfg(phper_debug)]
diff --git a/phper/src/zend/api.rs b/phper/src/zend/api.rs
@@ -1,11 +1,15 @@
 use crate::{
-    sys::{zend_function_entry, zend_ini_entry_def},
-    zend::ini::Mh,
+    sys::{zend_function_entry, zend_ini_entry_def, zend_internal_arg_info, zif_handler},
+    zend::{
+        compile::MultiInternalArgInfo,
+        ini::{create_ini_entry_ex, Mh},
+    },
 };
 use std::{
     cell::Cell,
     mem::{size_of, transmute},
-    ptr::null_mut,
+    os::raw::c_char,
+    ptr::null,
 };
 
 const fn function_entry_end() -> zend_function_entry {
@@ -27,34 +31,20 @@ impl<T: 'static> ModuleGlobals<T> {
         self.inner.as_ptr()
     }
 
-    pub const fn create_ini_entry_def(
-        &'static self,
+    pub const fn create_ini_entry(
+        &self,
         name: &str,
         default_value: &str,
         on_modify: Option<Mh>,
         modifiable: u32,
     ) -> zend_ini_entry_def {
-        #[cfg(any(phper_php_version = "7.4", phper_php_version = "7.3"))]
-        let (modifiable, name_length) = (modifiable as std::os::raw::c_uchar, name.len() as u16);
-        #[cfg(any(
-            phper_php_version = "7.2",
-            phper_php_version = "7.1",
-            phper_php_version = "7.0",
-        ))]
-        let (modifiable, name_length) = (modifiable as std::os::raw::c_int, name.len() as u32);
-
-        zend_ini_entry_def {
-            name: name.as_ptr().cast(),
+        create_ini_entry_ex(
+            name,
+            default_value,
             on_modify,
-            mh_arg1: 0 as *mut _,
-            mh_arg2: self.as_ptr().cast(),
-            mh_arg3: null_mut(),
-            value: default_value.as_ptr().cast(),
-            displayer: None,
             modifiable,
-            name_length,
-            value_length: default_value.len() as u32,
-        }
+            self.as_ptr().cast(),
+        )
     }
 }
 
@@ -86,3 +76,48 @@ impl<const N: usize> FunctionEntries<N> {
 }
 
 unsafe impl<const N: usize> Sync for FunctionEntries<N> {}
+
+pub struct FunctionEntryBuilder {
+    fname: *const c_char,
+    handler: zif_handler,
+    arg_info: *const zend_internal_arg_info,
+    num_args: u32,
+    flags: u32,
+}
+
+impl FunctionEntryBuilder {
+    pub const fn new(fname: *const c_char, handler: zif_handler) -> Self {
+        Self {
+            fname,
+            handler,
+            arg_info: null(),
+            num_args: 0,
+            flags: 0,
+        }
+    }
+
+    pub const fn arg_info<const N: usize>(
+        self,
+        arg_info: &'static MultiInternalArgInfo<N>,
+    ) -> Self {
+        Self {
+            arg_info: arg_info.as_ptr(),
+            num_args: arg_info.len() as u32,
+            ..self
+        }
+    }
+
+    pub const fn flags(self, flags: u32) -> Self {
+        Self { flags, ..self }
+    }
+
+    pub const fn build(self) -> zend_function_entry {
+        zend_function_entry {
+            fname: self.fname,
+            handler: self.handler,
+            arg_info: self.arg_info,
+            num_args: self.num_args,
+            flags: self.flags,
+        }
+    }
+}
diff --git a/phper/src/zend/compile.rs b/phper/src/zend/compile.rs
diff --git a/phper/src/zend/ini.rs b/phper/src/zend/ini.rs
diff --git a/phper/src/zend/types.rs b/phper/src/zend/types.rs

Original file line number	Diff line number	Diff line change
`@@ -10,4 +10,5 @@ members = [`
`10`	`10`	`# internal`
`11`	`11`	`"examples/hello",`
`12`	`12`	`"examples/hello-class",`
	`13`	`+ "examples/mini-curl",`
`13`	`14`	`]`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+fn main() {`
	`2`	`+ phper_build::register_configures();`
	`3`	`+}`