Add helper to get the sapi name

Useful to determine if the context is CLI / FPM etc

Author: joehoyle

allowed_bindings.rs

@@ -248,5 +248,6 @@ bind! {
     tsrm_get_ls_cache,
     executor_globals_offset,
     zend_atomic_bool_store,
+    sapi_module,
     zend_interrupt_function
 }

docsrs_bindings.rs

@@ -323,6 +323,28 @@ extern "C" {
 extern "C" {
     pub fn __zend_malloc(len: usize) -> *mut ::std::os::raw::c_void;
 }
+#[repr(C)]
+#[derive(Debug, Copy, Clone)]
+pub struct _zend_llist_element {
+    pub next: *mut _zend_llist_element,
+    pub prev: *mut _zend_llist_element,
+    pub data: [::std::os::raw::c_char; 1usize],
+}
+pub type zend_llist_element = _zend_llist_element;
+pub type llist_dtor_func_t =
+    ::std::option::Option<unsafe extern "C" fn(arg1: *mut ::std::os::raw::c_void)>;
+#[repr(C)]
+#[derive(Debug, Copy, Clone)]
+pub struct _zend_llist {
+    pub head: *mut zend_llist_element,
+    pub tail: *mut zend_llist_element,
+    pub count: usize,
+    pub size: usize,
+    pub dtor: llist_dtor_func_t,
+    pub persistent: ::std::os::raw::c_uchar,
+    pub traverse_ptr: *mut zend_llist_element,
+}
+pub type zend_llist = _zend_llist;
 pub type zend_string_init_interned_func_t = ::std::option::Option<
     unsafe extern "C" fn(
         str_: *const ::std::os::raw::c_char,
@@ -473,6 +495,29 @@ pub struct _zend_class_arrayaccess_funcs {
 pub type zend_class_arrayaccess_funcs = _zend_class_arrayaccess_funcs;
 #[repr(C)]
 #[derive(Debug, Copy, Clone)]
+pub struct stat {
+    pub st_dev: dev_t,
+    pub st_mode: mode_t,
+    pub st_nlink: nlink_t,
+    pub st_ino: __darwin_ino64_t,
+    pub st_uid: uid_t,
+    pub st_gid: gid_t,
+    pub st_rdev: dev_t,
+    pub st_atimespec: timespec,
+    pub st_mtimespec: timespec,
+    pub st_ctimespec: timespec,
+    pub st_birthtimespec: timespec,
+    pub st_size: off_t,
+    pub st_blocks: blkcnt_t,
+    pub st_blksize: blksize_t,
+    pub st_flags: __uint32_t,
+    pub st_gen: __uint32_t,
+    pub st_lspare: __int32_t,
+    pub st_qspare: [__int64_t; 2usize],
+}
+pub type zend_stat_t = stat;
+#[repr(C)]
+#[derive(Debug, Copy, Clone)]
 pub struct _zend_serialize_data {
     _unused: [u8; 0],
 }
@@ -1514,3 +1559,127 @@ extern "C" {
 extern "C" {
     pub static mut zend_ce_stringable: *mut zend_class_entry;
 }
+#[repr(C)]
+#[derive(Debug, Copy, Clone)]
+pub struct sapi_header_struct {
+    pub header: *mut ::std::os::raw::c_char,
+    pub header_len: usize,
+}
+#[repr(C)]
+#[derive(Debug, Copy, Clone)]
+pub struct sapi_headers_struct {
+    pub headers: zend_llist,
+    pub http_response_code: ::std::os::raw::c_int,
+    pub send_default_content_type: ::std::os::raw::c_uchar,
+    pub mimetype: *mut ::std::os::raw::c_char,
+    pub http_status_line: *mut ::std::os::raw::c_char,
+}
+pub type sapi_module_struct = _sapi_module_struct;
+extern "C" {
+    pub static mut sapi_module: sapi_module_struct;
+}
+pub const sapi_header_op_enum_SAPI_HEADER_REPLACE: sapi_header_op_enum = 0;
+pub const sapi_header_op_enum_SAPI_HEADER_ADD: sapi_header_op_enum = 1;
+pub const sapi_header_op_enum_SAPI_HEADER_DELETE: sapi_header_op_enum = 2;
+pub const sapi_header_op_enum_SAPI_HEADER_DELETE_ALL: sapi_header_op_enum = 3;
+pub const sapi_header_op_enum_SAPI_HEADER_SET_STATUS: sapi_header_op_enum = 4;
+pub type sapi_header_op_enum = ::std::os::raw::c_uint;
+#[repr(C)]
+#[derive(Debug, Copy, Clone)]
+pub struct _sapi_module_struct {
+    pub name: *mut ::std::os::raw::c_char,
+    pub pretty_name: *mut ::std::os::raw::c_char,
+    pub startup: ::std::option::Option<
+        unsafe extern "C" fn(sapi_module: *mut _sapi_module_struct) -> ::std::os::raw::c_int,
+    >,
+    pub shutdown: ::std::option::Option<
+        unsafe extern "C" fn(sapi_module: *mut _sapi_module_struct) -> ::std::os::raw::c_int,
+    >,
+    pub activate: ::std::option::Option<unsafe extern "C" fn() -> ::std::os::raw::c_int>,
+    pub deactivate: ::std::option::Option<unsafe extern "C" fn() -> ::std::os::raw::c_int>,
+    pub ub_write: ::std::option::Option<
+        unsafe extern "C" fn(str_: *const ::std::os::raw::c_char, str_length: usize) -> usize,
+    >,
+    pub flush:
+        ::std::option::Option<unsafe extern "C" fn(server_context: *mut ::std::os::raw::c_void)>,
+    pub get_stat: ::std::option::Option<unsafe extern "C" fn() -> *mut zend_stat_t>,
+    pub getenv: ::std::option::Option<
+        unsafe extern "C" fn(
+            name: *const ::std::os::raw::c_char,
+            name_len: usize,
+        ) -> *mut ::std::os::raw::c_char,
+    >,
+    pub sapi_error: ::std::option::Option<
+        unsafe extern "C" fn(
+            type_: ::std::os::raw::c_int,
+            error_msg: *const ::std::os::raw::c_char,
+            ...
+        ),
+    >,
+    pub header_handler: ::std::option::Option<
+        unsafe extern "C" fn(
+            sapi_header: *mut sapi_header_struct,
+            op: sapi_header_op_enum,
+            sapi_headers: *mut sapi_headers_struct,
+        ) -> ::std::os::raw::c_int,
+    >,
+    pub send_headers: ::std::option::Option<
+        unsafe extern "C" fn(sapi_headers: *mut sapi_headers_struct) -> ::std::os::raw::c_int,
+    >,
+    pub send_header: ::std::option::Option<
+        unsafe extern "C" fn(
+            sapi_header: *mut sapi_header_struct,
+            server_context: *mut ::std::os::raw::c_void,
+        ),
+    >,
+    pub read_post: ::std::option::Option<
+        unsafe extern "C" fn(buffer: *mut ::std::os::raw::c_char, count_bytes: usize) -> usize,
+    >,
+    pub read_cookies: ::std::option::Option<unsafe extern "C" fn() -> *mut ::std::os::raw::c_char>,
+    pub register_server_variables:
+        ::std::option::Option<unsafe extern "C" fn(track_vars_array: *mut zval)>,
+    pub log_message: ::std::option::Option<
+        unsafe extern "C" fn(
+            message: *const ::std::os::raw::c_char,
+            syslog_type_int: ::std::os::raw::c_int,
+        ),
+    >,
+    pub get_request_time:
+        ::std::option::Option<unsafe extern "C" fn(request_time: *mut f64) -> zend_result>,
+    pub terminate_process: ::std::option::Option<unsafe extern "C" fn()>,
+    pub php_ini_path_override: *mut ::std::os::raw::c_char,
+    pub default_post_reader: ::std::option::Option<unsafe extern "C" fn()>,
+    pub treat_data: ::std::option::Option<
+        unsafe extern "C" fn(
+            arg: ::std::os::raw::c_int,
+            str_: *mut ::std::os::raw::c_char,
+            destArray: *mut zval,
+        ),
+    >,
+    pub executable_location: *mut ::std::os::raw::c_char,
+    pub php_ini_ignore: ::std::os::raw::c_int,
+    pub php_ini_ignore_cwd: ::std::os::raw::c_int,
+    pub get_fd: ::std::option::Option<
+        unsafe extern "C" fn(fd: *mut ::std::os::raw::c_int) -> ::std::os::raw::c_int,
+    >,
+    pub force_http_10: ::std::option::Option<unsafe extern "C" fn() -> ::std::os::raw::c_int>,
+    pub get_target_uid:
+        ::std::option::Option<unsafe extern "C" fn(arg1: *mut uid_t) -> ::std::os::raw::c_int>,
+    pub get_target_gid:
+        ::std::option::Option<unsafe extern "C" fn(arg1: *mut gid_t) -> ::std::os::raw::c_int>,
+    pub input_filter: ::std::option::Option<
+        unsafe extern "C" fn(
+            arg: ::std::os::raw::c_int,
+            var: *const ::std::os::raw::c_char,
+            val: *mut *mut ::std::os::raw::c_char,
+            val_len: usize,
+            new_val_len: *mut usize,
+        ) -> ::std::os::raw::c_uint,
+    >,
+    pub ini_defaults:
+        ::std::option::Option<unsafe extern "C" fn(configuration_hash: *mut HashTable)>,
+    pub phpinfo_as_text: ::std::os::raw::c_int,
+    pub ini_entries: *mut ::std::os::raw::c_char,
+    pub additional_functions: *const zend_function_entry,
+    pub input_filter_init: ::std::option::Option<unsafe extern "C" fn() -> ::std::os::raw::c_uint>,
+}

src/wrapper.h

@@ -20,6 +20,7 @@
 #include "zend_exceptions.h"
 #include "zend_inheritance.h"
 #include "zend_interfaces.h"
+#include "SAPI.h"
 
 zend_string *ext_php_rs_zend_string_init(const char *str, size_t len, bool persistent);
 void ext_php_rs_zend_string_release(zend_string *zs);

src/zend/mod.rs

@@ -9,7 +9,10 @@ mod globals;
 mod handlers;
 mod module;
 
-use crate::{error::Result, ffi::php_printf};
+use crate::{
+    error::Result,
+    ffi::{php_printf, sapi_module},
+};
 use std::ffi::CString;
 
 pub use _type::ZendType;
@@ -42,3 +45,9 @@ pub fn printf(message: &str) -> Result<()> {
     };
     Ok(())
 }
+
+/// Get the name of the SAPI module.
+pub fn php_sapi_name() -> String {
+    let c_str = unsafe { std::ffi::CStr::from_ptr(sapi_module.name) };
+    c_str.to_str().expect("Unable to parse CStr").to_string()
+}