1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299
use std::{ffi::CString, mem::MaybeUninit};
use crate::{
builders::FunctionBuilder,
class::{ConstructorMeta, ConstructorResult, RegisteredClass},
convert::IntoZval,
error::{Error, Result},
exception::PhpException,
ffi::{
zend_declare_class_constant, zend_declare_property, zend_do_implement_interface,
zend_register_internal_class_ex,
},
flags::{ClassFlags, MethodFlags, PropertyFlags},
types::{ZendClassObject, ZendObject, ZendStr, Zval},
zend::{ClassEntry, ExecuteData, FunctionEntry},
zend_fastcall,
};
/// Builder for registering a class in PHP.
pub struct ClassBuilder {
name: String,
ce: ClassEntry,
extends: Option<&'static ClassEntry>,
interfaces: Vec<&'static ClassEntry>,
methods: Vec<FunctionEntry>,
object_override: Option<unsafe extern "C" fn(class_type: *mut ClassEntry) -> *mut ZendObject>,
properties: Vec<(String, Zval, PropertyFlags)>,
constants: Vec<(String, Zval)>,
}
impl ClassBuilder {
/// Creates a new class builder, used to build classes
/// to be exported to PHP.
///
/// # Parameters
///
/// * `name` - The name of the class.
pub fn new<T: Into<String>>(name: T) -> Self {
Self {
name: name.into(),
// SAFETY: A zeroed class entry is in an initialized state, as it is a raw C type
// whose fields do not have a drop implementation.
ce: unsafe { MaybeUninit::zeroed().assume_init() },
extends: None,
interfaces: vec![],
methods: vec![],
object_override: None,
properties: vec![],
constants: vec![],
}
}
/// Sets the class builder to extend another class.
///
/// # Parameters
///
/// * `parent` - The parent class to extend.
pub fn extends(mut self, parent: &'static ClassEntry) -> Self {
self.extends = Some(parent);
self
}
/// Implements an interface on the class.
///
/// # Parameters
///
/// * `interface` - Interface to implement on the class.
///
/// # Panics
///
/// Panics when the given class entry `interface` is not an interface.
pub fn implements(mut self, interface: &'static ClassEntry) -> Self {
assert!(
interface.is_interface(),
"Given class entry was not an interface."
);
self.interfaces.push(interface);
self
}
/// Adds a method to the class.
///
/// # Parameters
///
/// * `func` - The function entry to add to the class.
/// * `flags` - Flags relating to the function. See [`MethodFlags`].
pub fn method(mut self, mut func: FunctionEntry, flags: MethodFlags) -> Self {
func.flags |= flags.bits();
self.methods.push(func);
self
}
/// Adds a property to the class. The initial type of the property is given
/// by the type of the given default. Note that the user can change the
/// type.
///
/// # Parameters
///
/// * `name` - The name of the property to add to the class.
/// * `default` - The default value of the property.
/// * `flags` - Flags relating to the property. See [`PropertyFlags`].
///
/// # Panics
///
/// Function will panic if the given `default` cannot be converted into a
/// [`Zval`].
pub fn property<T: Into<String>>(
mut self,
name: T,
default: impl IntoZval,
flags: PropertyFlags,
) -> Self {
let default = match default.into_zval(true) {
Ok(default) => default,
Err(_) => panic!("Invalid default value for property `{}`.", name.into()),
};
self.properties.push((name.into(), default, flags));
self
}
/// Adds a constant to the class. The type of the constant is defined by the
/// type of the given default.
///
/// Returns a result containing the class builder if the constant was
/// successfully added.
///
/// # Parameters
///
/// * `name` - The name of the constant to add to the class.
/// * `value` - The value of the constant.
pub fn constant<T: Into<String>>(mut self, name: T, value: impl IntoZval) -> Result<Self> {
let value = value.into_zval(true)?;
self.constants.push((name.into(), value));
Ok(self)
}
/// Sets the flags for the class.
///
/// # Parameters
///
/// * `flags` - Flags relating to the class. See [`ClassFlags`].
pub fn flags(mut self, flags: ClassFlags) -> Self {
self.ce.ce_flags = flags.bits();
self
}
/// Overrides the creation of the Zend object which will represent an
/// instance of this class.
///
/// # Parameters
///
/// * `T` - The type which will override the Zend object. Must implement
/// [`RegisteredClass`]
/// which can be derived using the [`php_class`](crate::php_class) attribute
/// macro.
///
/// # Panics
///
/// Panics if the class name associated with `T` is not the same as the
/// class name specified when creating the builder.
pub fn object_override<T: RegisteredClass>(mut self) -> Self {
extern "C" fn create_object<T: RegisteredClass>(_: *mut ClassEntry) -> *mut ZendObject {
// SAFETY: After calling this function, PHP will always call the constructor
// defined below, which assumes that the object is uninitialized.
let obj = unsafe { ZendClassObject::<T>::new_uninit() };
obj.into_raw().get_mut_zend_obj()
}
zend_fastcall! {
extern fn constructor<T: RegisteredClass>(ex: &mut ExecuteData, _: &mut Zval) {
let ConstructorMeta { constructor, .. } = match T::CONSTRUCTOR {
Some(c) => c,
None => {
PhpException::default("You cannot instantiate this class from PHP.".into())
.throw()
.expect("Failed to throw exception when constructing class");
return;
}
};
let this = match constructor(ex) {
ConstructorResult::Ok(this) => this,
ConstructorResult::Exception(e) => {
e.throw()
.expect("Failed to throw exception while constructing class");
return;
}
ConstructorResult::ArgError => return,
};
let this_obj = match ex.get_object::<T>() {
Some(obj) => obj,
None => {
PhpException::default("Failed to retrieve reference to `this` object.".into())
.throw()
.expect("Failed to throw exception while constructing class");
return;
}
};
this_obj.initialize(this);
}
}
debug_assert_eq!(
self.name.as_str(),
T::CLASS_NAME,
"Class name in builder does not match class name in `impl RegisteredClass`."
);
self.object_override = Some(create_object::<T>);
self.method(
{
let mut func = FunctionBuilder::new("__construct", constructor::<T>);
if let Some(ConstructorMeta { build_fn, .. }) = T::CONSTRUCTOR {
func = build_fn(func);
}
func.build().expect("Failed to build constructor function")
},
MethodFlags::Public,
)
}
/// Builds the class, returning a reference to the class entry.
///
/// # Errors
///
/// Returns an [`Error`] variant if the class could not be registered.
pub fn build(mut self) -> Result<&'static mut ClassEntry> {
self.ce.name = ZendStr::new_interned(&self.name, true).into_raw();
self.methods.push(FunctionEntry::end());
let func = Box::into_raw(self.methods.into_boxed_slice()) as *const FunctionEntry;
self.ce.info.internal.builtin_functions = func;
let class = unsafe {
zend_register_internal_class_ex(
&mut self.ce,
match self.extends {
Some(ptr) => (ptr as *const _) as *mut _,
None => std::ptr::null_mut(),
},
)
.as_mut()
.ok_or(Error::InvalidPointer)?
};
// disable serialization if the class has an associated object
if self.object_override.is_some() {
cfg_if::cfg_if! {
if #[cfg(any(php81, php82))] {
class.ce_flags |= ClassFlags::NotSerializable.bits();
} else {
class.serialize = Some(crate::ffi::zend_class_serialize_deny);
class.unserialize = Some(crate::ffi::zend_class_unserialize_deny);
}
}
}
for iface in self.interfaces {
unsafe {
zend_do_implement_interface(
class,
iface as *const crate::ffi::_zend_class_entry
as *mut crate::ffi::_zend_class_entry,
)
};
}
for (name, mut default, flags) in self.properties {
unsafe {
zend_declare_property(
class,
CString::new(name.as_str())?.as_ptr(),
name.len() as _,
&mut default,
flags.bits() as _,
);
}
}
for (name, value) in self.constants {
let value = Box::into_raw(Box::new(value));
unsafe {
zend_declare_class_constant(
class,
CString::new(name.as_str())?.as_ptr(),
name.len(),
value,
)
};
}
if let Some(object_override) = self.object_override {
class.__bindgen_anon_2.create_object = Some(object_override);
}
Ok(class)
}
}