[odb_backend] implement foreach callback. slightly tricky

Author: chobie

example/odb_backend.php

@@ -60,12 +60,14 @@ class Pool
 
     },
     "foreach" => function($foreach_cb, &$payload) { // this payload was passed by git_odb_foreach callback.
+            echo "\e[32m# foreach (iterate all backends)\e[m\n";
             foreach (Pool::$pool as $oid => $value) {
                 $retval = $foreach_cb($oid, $payload);
                 if ($retval == GIT_EUSER) {
                     return $retval;
                 }
             }
+            return 0;
     },
     "writepack" => function() {
 
@@ -91,9 +93,8 @@ class Pool
 $obj = git_odb_read_prefix($odb, substr($oid, 0, 10));
 var_dump($obj);
 
-
 $payload = array();
 git_odb_foreach($odb, function($oid, &$payload) {
-    echo $oid . PHP_EOL;
+    echo ".";
 }, $payload);
 exit;

odb.c

@@ -933,28 +933,84 @@ static int php_git2_odb_backend_exists(git_odb_backend *backend, const git_oid *
 	return !retval;
 
 }
+
+static const zend_arg_info arginfo_git_odb_backend_foreach_callback[] = {
+	ZEND_ARG_INFO(0, oid)
+	ZEND_ARG_INFO(1, payload)
+};
+
+static void git_ex_cb(INTERNAL_FUNCTION_PARAMETERS)
+{
+	zval *payload, *this = getThis();
+	php_git2_odb_backend_foreach_callback *_callback;
+	char *oid;
+	int oid_len, retval = 0;
+	git_oid _oid;
+
+	if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC,
+		"sz", &oid, &oid_len, &payload) == FAILURE) {
+		return;
+	}
+
+	if (git_oid_fromstrn(&_oid, oid, oid_len) != GIT_OK) {
+		return;
+	}
+
+	_callback = (php_git2_odb_backend_foreach_callback*)zend_object_store_get_object(this TSRMLS_CC);
+	_callback->payload->payload = payload;
+	retval = _callback->callback(&_oid, _callback->payload);
+	RETURN_LONG(retval);
+}
+
 static int php_git2_odb_backend_foreach(git_odb_backend *backend, git_odb_foreach_cb cb, void *data)
 {
 	php_git2_t *result;
 	php_git2_odb_backend *php_backend = (php_git2_odb_backend*)backend;
-	zval *param_callback = NULL, *retval_ptr = NULL, *param_payload = (zval*)data;
+	zval *param_callback = NULL, *callback = NULL, *retval_ptr = NULL, *param_payload = (zval*)data;
 	php_git2_multi_cb_t *p = php_backend->multi;
+	zend_function function = {0};
+	php_git2_odb_backend_foreach_callback *_callback;
+	php_git2_cb_t *__cb = (php_git2_cb_t*)data;
 	int i = 0, retval = 0;
 	GIT2_TSRMLS_SET(p->tsrm_ls);
 
+	MAKE_STD_ZVAL(callback);
+	object_init_ex(callback, php_git2_odb_backend_foreach_callback_class_entry);
+	_callback = (php_git2_odb_backend_foreach_callback*)zend_object_store_get_object(callback TSRMLS_CC);
+	_callback->callback = cb;
+	_callback->payload = __cb;
+	Z_ADDREF_P(callback);
+
+	function.type = ZEND_INTERNAL_FUNCTION;
+	function.common.function_name = "callback";
+	function.common.fn_flags = ZEND_ACC_CLOSURE;
+	function.common.num_args = 2;
+	function.common.required_num_args = 2;
+	function.common.arg_info = &arginfo_git_odb_backend_foreach_callback;
+	function.common.scope = php_git2_odb_backend_foreach_callback_class_entry;
+	function.internal_function.type = ZEND_INTERNAL_FUNCTION;
+	function.internal_function.scope = php_git2_odb_backend_foreach_callback_class_entry;
+	function.internal_function.fn_flags = ZEND_ACC_CLOSURE;
+	function.internal_function.handler = git_ex_cb;
+	function.internal_function.module = &git2_module_entry;
+	function.internal_function.num_args = 2;
+	function.internal_function.required_num_args = 2;
+	function.internal_function.arg_info = &arginfo_git_odb_backend_foreach_callback;
+
 	MAKE_STD_ZVAL(param_callback);
-	// TODO(chobie): wrap git_odb_foreach_cb with closure
-	// see zend_create_closure
+    zend_create_closure(param_callback, &function, php_git2_odb_backend_foreach_callback_class_entry, callback TSRMLS_CC);
+    Z_ADDREF_P(__cb->payload);
 
 	if (php_git2_call_function_v(&p->callbacks[6].fci, &p->callbacks[6].fcc TSRMLS_CC, &retval_ptr, 2,
-		&param_callback, &param_payload)) {
+		&param_callback, &__cb->payload)) {
 		return GIT_EUSER;
 	}
 
 	retval = Z_LVAL_P(retval_ptr);
 	zval_ptr_dtor(&retval_ptr);
 	return retval;
 }
+
 static void php_git2_odb_backend_free(git_odb_backend *_backend)
 {
 }
@@ -1012,7 +1068,6 @@ PHP_FUNCTION(git_odb_backend_new)
 		php_git2_fcall_info_wrapper2(tmp, &foreach_fci, &foreach_fcc TSRMLS_CC);
 	}
 
-
 	Z_ADDREF_P(callbacks);
 	php_git2_multi_cb_init(&backend->multi, callbacks TSRMLS_CC, 8,
 		&read_fci, &read_fcc,

php_git2.c

@@ -70,6 +70,8 @@
 
 int git2_resource_handle;
 
+zend_class_entry *php_git2_odb_backend_foreach_callback_class_entry;
+
 void static destruct_git2(zend_rsrc_list_entry *rsrc TSRMLS_DC)
 {
 	php_git2_t *resource = (php_git2_t *)rsrc->ptr;
@@ -1016,10 +1018,31 @@ static PHP_GSHUTDOWN_FUNCTION(git2)
 {
 }
 
+
+static void php_git2_odb_backend_foreach_callback_free_storage(php_git2_odb_backend_foreach_callback *object TSRMLS_DC)
+{
+        zend_object_std_dtor(&object->zo TSRMLS_CC);
+        efree(object);
+}
+
+zend_object_value php_git2_odb_backend_foreach_callback_new(zend_class_entry *ce TSRMLS_DC)
+{
+        zend_object_value retval;
+        PHP_GIT2_STD_CREATE_OBJECT(php_git2_odb_backend_foreach_callback);
+        return retval;
+}
+
 PHP_MINIT_FUNCTION(git2)
 {
+	zend_class_entry ce;
 	REGISTER_INI_ENTRIES();
 
+
+	INIT_CLASS_ENTRY(ce, "Git2ODBBackendForeachCallback", 0);
+	php_git2_odb_backend_foreach_callback_class_entry = zend_register_internal_class(&ce TSRMLS_CC);
+	zend_register_class_alias_ex(ZEND_NS_NAME("Git2\\ODB\\Backend", "ForeachCallback"), sizeof(ZEND_NS_NAME("Git2\\ODB\\Backend", "ForeachCallback"))-1, php_git2_odb_backend_foreach_callback_class_entry TSRMLS_CC);
+	php_git2_odb_backend_foreach_callback_class_entry->create_object = php_git2_odb_backend_foreach_callback_new;
+
 	git2_resource_handle = zend_register_list_destructors_ex(destruct_git2, NULL, PHP_GIT2_RESOURCE_NAME, module_number);
 
 	REGISTER_LONG_CONSTANT("GIT_TYPE_REPOSITORY", PHP_GIT2_TYPE_REPOSITORY, CONST_CS | CONST_PERSISTENT);

php_git2.h

@@ -229,4 +229,12 @@ typedef struct php_git2_odb_backend {
 	php_git2_multi_cb_t *multi;
 } php_git2_odb_backend;
 
+typedef struct php_git2_odb_backend_foreach_callback {
+	zend_object zo;
+	git_odb_foreach_cb callback;
+	php_git2_cb_t *payload;
+} php_git2_odb_backend_foreach_callback;
+
+extern zend_class_entry *php_git2_odb_backend_foreach_callback_class_entry;
+
 #endif /* PHP_GIT2_H */

php_git2_priv.h

@@ -34,6 +34,35 @@ extern int git2_resource_handle;
 #define PHP_GIT2_LIST_INSERT(type, handle) zend_list_insert(type, handle)
 #endif
 
+#  if ZEND_MODULE_API_NO >= 20100525
+#  define PHP_GIT2_STD_CREATE_OBJECT(STRUCT_NAME) \
+        STRUCT_NAME *object;\
+        \
+        object = (STRUCT_NAME*)ecalloc(1, sizeof(*object));\
+        zend_object_std_init(&object->zo, ce TSRMLS_CC);\
+        object_properties_init(&object->zo, ce);\
+        \
+        retval.handle = zend_objects_store_put(object,\
+                (zend_objects_store_dtor_t)zend_objects_destroy_object,\
+                (zend_objects_free_object_storage_t) STRUCT_NAME##_free_storage ,\
+        NULL TSRMLS_CC);\
+        retval.handlers = zend_get_std_object_handlers();
+#  else
+#  define PHP_GIT2_STD_CREATE_OBJECT(STRUCT_NAME) \
+        STRUCT_NAME *object;\
+        zval *tmp = NULL;\
+        \
+        object = (STRUCT_NAME*)ecalloc(1, sizeof(*object));\
+        zend_object_std_init(&object->zo, ce TSRMLS_CC);\
+        zend_hash_copy(object->zo.properties, &ce->default_properties, (copy_ctor_func_t)zval_add_ref, (void *)&tmp, sizeof(zval *)); \
+        \
+        retval.handle = zend_objects_store_put(object,\
+                (zend_objects_store_dtor_t)zend_objects_destroy_object,\
+                (zend_objects_free_object_storage_t) STRUCT_NAME##_free_storage ,\
+        NULL TSRMLS_CC);\
+        retval.handlers = zend_get_std_object_handlers();
+#  endif
+
 #define PHP_GIT2_V(git2, type) git2->v.type
 #define GIT2_RVAL_P(git2) git2->resource_id
 #define GIT2_SHOULD_FREE(git2) git2->should_free_v