File: php_propro_api.c

package info (click to toggle)
php-propro 2.0.1%2B1.0.2-1
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 260 kB
  • ctags: 106
  • sloc: ansic: 1,001; xml: 129; php: 18; makefile: 1
file content (590 lines) | stat: -rw-r--r-- 15,086 bytes parent folder | download | duplicates (3)
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
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
/*
    +--------------------------------------------------------------------+
    | PECL :: propro                                                     |
    +--------------------------------------------------------------------+
    | Redistribution and use in source and binary forms, with or without |
    | modification, are permitted provided that the conditions mentioned |
    | in the accompanying LICENSE file are met.                          |
    +--------------------------------------------------------------------+
    | Copyright (c) 2013 Michael Wallner <mike@php.net>                  |
    +--------------------------------------------------------------------+
*/


#ifdef HAVE_CONFIG_H
#	include "config.h"
#endif

#include <php.h>
#include <ext/standard/info.h>

#include "php_propro_api.h"

#if PHP_VERSION_ID < 50500
#undef SUCCESS
#undef FAILURE
typedef enum {
	SUCCESS = 0,
	FAILURE = -1
} ZEND_RESULT_CODE;
#endif

#define DEBUG_PROPRO 0

#if PHP_VERSION_ID < 50400
#	define object_properties_init(o, ce) \
	zend_hash_copy(((zend_object *) o)->properties, &(ce->default_properties), \
			(copy_ctor_func_t) zval_add_ref, NULL, sizeof(zval*))
#endif

php_property_proxy_t *php_property_proxy_init(zval *container,
		const char *member_str, size_t member_len TSRMLS_DC)
{
	php_property_proxy_t *proxy = ecalloc(1, sizeof(*proxy));

	Z_ADDREF_P(container);
	proxy->container = container;
	proxy->member_str = estrndup(member_str, member_len);
	proxy->member_len = member_len;

	return proxy;
}

void php_property_proxy_free(php_property_proxy_t **proxy)
{
	if (*proxy) {
		zval_ptr_dtor(&(*proxy)->container);
		efree((*proxy)->member_str);
		efree(*proxy);
		*proxy = NULL;
	}
}

static zend_class_entry *php_property_proxy_class_entry;
static zend_object_handlers php_property_proxy_object_handlers;

zend_class_entry *php_property_proxy_get_class_entry(void)
{
	return php_property_proxy_class_entry;
}

zend_object_value php_property_proxy_object_new(zend_class_entry *ce TSRMLS_DC)
{
	return php_property_proxy_object_new_ex(ce, NULL, NULL TSRMLS_CC);
}

static void php_property_proxy_object_free(void *object TSRMLS_DC)
{
	php_property_proxy_object_t *o = object;

#if DEBUG_PROPRO
	fprintf(stderr, "#PP %p free\n", o);
#endif

	if (o->proxy) {
		php_property_proxy_free(&o->proxy);
	}
	if (o->parent) {
		zend_objects_store_del_ref_by_handle_ex(o->parent->zv.handle,
				o->parent->zv.handlers TSRMLS_CC);
		o->parent = NULL;
	}
	zend_object_std_dtor((zend_object *) o TSRMLS_CC);
	efree(o);
}

zend_object_value php_property_proxy_object_new_ex(zend_class_entry *ce,
		php_property_proxy_t *proxy, php_property_proxy_object_t **ptr TSRMLS_DC)
{
	php_property_proxy_object_t *o;

	o = ecalloc(1, sizeof(*o));
	zend_object_std_init((zend_object *) o, ce TSRMLS_CC);
	object_properties_init((zend_object *) o, ce);

	if (ptr) {
		*ptr = o;
	}
	o->proxy = proxy;

	o->zv.handle = zend_objects_store_put(o, NULL,
			php_property_proxy_object_free, NULL TSRMLS_CC);
	o->zv.handlers = &php_property_proxy_object_handlers;

#if DEBUG_PROPRO
	fprintf(stderr, "#PP %p init\n", o);
#endif

	return o->zv;
}

#if DEBUG_PROPRO
/* we do not really care about TS when debugging */
static int level = 1;
static const char space[] = "                               ";
static const char *inoutstr[] = {"< return",""," > enter"};
static void _walk(php_property_proxy_object_t *obj TSRMLS_DC)
{
	if (obj) {
		_walk(obj->parent TSRMLS_CC);
		fprintf(stderr, ".%s", obj->proxy->member_str);
	}
}

static void debug_propro(int inout, const char *f, zval *object, zval *offset,
		zval *value TSRMLS_DC)
{
	php_property_proxy_object_t *obj;

	obj = zend_object_store_get_object(object TSRMLS_CC);
	fprintf(stderr, "#PP %p %s %s %s ", obj, &space[sizeof(space)-level],
			inoutstr[inout+1], f);

	level += inout;

	_walk(obj TSRMLS_CC);

	if (*f++=='d'
	&&	*f++=='i'
	&&	*f++=='m'
	) {
		char *offset_str = "[]";
		zval *o = offset;

		if (o) {
			convert_to_string_ex(&o);
			offset_str = Z_STRVAL_P(o);
		}

		fprintf(stderr, ".%s", offset_str);

		if (o && o != offset) {
			zval_ptr_dtor(&o);
		}
	}
	if (value) {
		const char *t[] = {
				"NULL",
				"int",
				"float",
				"bool",
				"Array",
				"Object",
				"string",
				"resource",
				"const",
				"const Array",
				"callable"
		};
		fprintf(stderr, " = (%s) ", t[Z_TYPE_P(value)&0xf]);
		zend_print_flat_zval_r(value TSRMLS_CC);
	}

	fprintf(stderr, "\n");
}
#else
#define debug_propro(l, f, obj, off, val)
#endif

static zval *get_parent_proxied_value(zval *object TSRMLS_DC);
static zval *get_proxied_value(zval *object TSRMLS_DC);
static zval *read_dimension(zval *object, zval *offset, int type TSRMLS_DC);
static ZEND_RESULT_CODE cast_proxied_value(zval *object, zval *return_value,
		int type TSRMLS_DC);
static void write_dimension(zval *object, zval *offset, zval *value TSRMLS_DC);
static void set_proxied_value(zval **object, zval *value TSRMLS_DC);

static zval *get_parent_proxied_value(zval *object TSRMLS_DC)
{
	zval *value = NULL;
	php_property_proxy_object_t *obj;

	obj = zend_object_store_get_object(object TSRMLS_CC);
	if (obj->proxy) {
		if (obj->parent) {
			zval *parent;

			MAKE_STD_ZVAL(parent);
			parent->type = IS_OBJECT;
			parent->value.obj = obj->parent->zv;
			zend_objects_store_add_ref_by_handle(
					obj->parent->zv.handle TSRMLS_CC);
			value = get_proxied_value(parent TSRMLS_CC);
			zval_ptr_dtor(&parent);
		}
	}

	return value;
}

static zval *get_proxied_value(zval *object TSRMLS_DC)
{
	zval **hash_value, *value = NULL;
	php_property_proxy_object_t *obj;
	ZEND_RESULT_CODE rv;

	obj = zend_object_store_get_object(object TSRMLS_CC);
	debug_propro(1, "get", object, NULL, NULL TSRMLS_CC);

	if (obj->proxy) {
		if (obj->parent) {
			zval *parent_value = get_parent_proxied_value(object TSRMLS_CC);

			if (parent_value && parent_value != obj->proxy->container) {
				Z_ADDREF_P(parent_value);
				zval_ptr_dtor(&obj->proxy->container);
				obj->proxy->container = parent_value;
			}
		}
		switch (Z_TYPE_P(obj->proxy->container)) {
		case IS_OBJECT:
			value = zend_read_property(Z_OBJCE_P(obj->proxy->container),
					obj->proxy->container, obj->proxy->member_str,
					obj->proxy->member_len, 0 TSRMLS_CC);
			break;

		case IS_ARRAY:
			rv = zend_symtable_find(Z_ARRVAL_P(obj->proxy->container),
					obj->proxy->member_str, obj->proxy->member_len + 1,
					(void *) &hash_value);

			if (SUCCESS == rv) {
				value = *hash_value;
			}
			break;
		}
	}

	debug_propro(-1, "get", object, NULL, value TSRMLS_CC);

	return value;
}

static ZEND_RESULT_CODE cast_proxied_value(zval *object, zval *return_value,
		int type TSRMLS_DC)
{
	zval *proxied_value;

	if ((proxied_value = get_proxied_value(object TSRMLS_CC))) {
		RETVAL_ZVAL(proxied_value, 1, 0);
		if (Z_TYPE_P(proxied_value) != type) {
			convert_to_explicit_type(return_value, type);
		}
		return SUCCESS;
	}

	return FAILURE;
}

static void set_proxied_value(zval **object, zval *value TSRMLS_DC)
{
	php_property_proxy_object_t *obj;

	obj = zend_object_store_get_object(*object TSRMLS_CC);
	debug_propro(1, "set", *object, NULL, value TSRMLS_CC);

	if (obj->proxy) {
		if (obj->parent) {
			zval *parent_value = get_parent_proxied_value(*object TSRMLS_CC);

			if (parent_value && parent_value != obj->proxy->container) {
				Z_ADDREF_P(parent_value);
				zval_ptr_dtor(&obj->proxy->container);
				obj->proxy->container = parent_value;
			}
		}

		switch (Z_TYPE_P(obj->proxy->container)) {
		case IS_OBJECT:
			zend_update_property(Z_OBJCE_P(obj->proxy->container),
					obj->proxy->container, obj->proxy->member_str,
					obj->proxy->member_len, value TSRMLS_CC);
			break;

		case IS_ARRAY:
			Z_ADDREF_P(value);
			zend_symtable_update(Z_ARRVAL_P(obj->proxy->container),
					obj->proxy->member_str, obj->proxy->member_len + 1,
					(void *) &value, sizeof(zval *), NULL);
			break;
		}

		if (obj->parent) {
			zval *zparent;
			MAKE_STD_ZVAL(zparent);
			zparent->type = IS_OBJECT;
			zparent->value.obj = obj->parent->zv;
			zend_objects_store_add_ref_by_handle(
					obj->parent->zv.handle TSRMLS_CC);
			set_proxied_value(&zparent, obj->proxy->container TSRMLS_CC);
			zval_ptr_dtor(&zparent);
		}
	}

	debug_propro(-1, "set", *object, NULL, NULL TSRMLS_CC);
}

static zval *read_dimension(zval *object, zval *offset, int type TSRMLS_DC)
{
	zval *value = NULL;
	zval *proxied_value;
	zval *o = offset;

	debug_propro(1, type == BP_VAR_R ? "dim_read" : "dim_read_ref", object,
			offset, NULL TSRMLS_CC);

	proxied_value = get_proxied_value(object TSRMLS_CC);
	convert_to_string_ex(&o);

	if (BP_VAR_R == type && proxied_value) {
		if (Z_TYPE_P(proxied_value) == IS_ARRAY) {
			zval **hash_value;
			ZEND_RESULT_CODE rv = zend_symtable_find(Z_ARRVAL_P(proxied_value),
					Z_STRVAL_P(o), Z_STRLEN_P(o), (void *) &hash_value);

			if (SUCCESS == rv) {
				Z_ADDREF_PP(hash_value);
				value = *hash_value;
			}
		}
	} else {
		php_property_proxy_t *proxy;
		php_property_proxy_object_t *proxy_obj;

		if (proxied_value) {
			convert_to_array(proxied_value);
			Z_ADDREF_P(proxied_value);
		} else {
			MAKE_STD_ZVAL(proxied_value);
			array_init(proxied_value);
			set_proxied_value(&object, proxied_value TSRMLS_CC);
		}

		proxy = php_property_proxy_init(proxied_value, Z_STRVAL_P(o),
				Z_STRLEN_P(o) TSRMLS_CC);
		zval_ptr_dtor(&proxied_value);
		MAKE_STD_ZVAL(value);
		Z_SET_REFCOUNT_P(value, 0);
		value->type = IS_OBJECT;
		value->value.obj = php_property_proxy_object_new_ex(
				php_property_proxy_get_class_entry(), proxy,
				&proxy_obj TSRMLS_CC);
		proxy_obj->parent = zend_object_store_get_object(object TSRMLS_CC);
		zend_objects_store_add_ref_by_handle(
				proxy_obj->parent->zv.handle TSRMLS_CC);
	}
	if (o && o != offset) {
		zval_ptr_dtor(&o);
	}

	debug_propro(-1, type == BP_VAR_R ? "dim_read" : "dim_read_ref", object,
			offset, value TSRMLS_CC);

	return value;
}

static int has_dimension(zval *object, zval *offset, int check_empty TSRMLS_DC)
{
	zval *proxied_value;
	int exists = 0;

	debug_propro(1, "dim_exists", object, offset, NULL TSRMLS_CC);

	proxied_value = get_proxied_value(object TSRMLS_CC);
	if (!proxied_value) {
		exists = 0;
	} else {
		zval *o = offset;

		convert_to_string_ex(&o);

		if (Z_TYPE_P(proxied_value) == IS_ARRAY) {
			zval **zentry;
			ZEND_RESULT_CODE rv = zend_symtable_find(Z_ARRVAL_P(proxied_value), Z_STRVAL_P(o), Z_STRLEN_P(o) + 1, (void *) &zentry);

			if (SUCCESS != rv) {
				exists = 0;
			} else {
				if (check_empty) {
					exists = Z_TYPE_PP(zentry) != IS_NULL;
				} else {
					exists = 1;
				}
			}
		}

		if (o != offset) {
			zval_ptr_dtor(&o);
		}
	}

	debug_propro(-1, "dim_exists", object, offset, NULL TSRMLS_CC);

	return exists;
}

static void write_dimension(zval *object, zval *offset, zval *value TSRMLS_DC)
{
	zval *proxied_value, *o = offset;

	debug_propro(1, "dim_write", object, offset, value TSRMLS_CC);

	proxied_value = get_proxied_value(object TSRMLS_CC);

	if (proxied_value) {
		convert_to_array(proxied_value);
		Z_ADDREF_P(proxied_value);
	} else {
		MAKE_STD_ZVAL(proxied_value);
		array_init(proxied_value);
	}

	if (Z_REFCOUNT_P(value) > 1) {
		SEPARATE_ZVAL(&value);
	}
	Z_ADDREF_P(value);

	if (o) {
		convert_to_string_ex(&o);
		zend_symtable_update(Z_ARRVAL_P(proxied_value), Z_STRVAL_P(o),
				Z_STRLEN_P(o) + 1, (void *) &value, sizeof(zval *), NULL);
	} else {
		zend_hash_next_index_insert(Z_ARRVAL_P(proxied_value), (void *) &value,
				sizeof(zval *), NULL);
	}

	if (o && o != offset) {
		zval_ptr_dtor(&o);
	}

	set_proxied_value(&object, proxied_value TSRMLS_CC);

	debug_propro(-1, "dim_write", object, offset, proxied_value TSRMLS_CC);

	zval_ptr_dtor(&proxied_value);
}

static void unset_dimension(zval *object, zval *offset TSRMLS_DC)
{
	zval *proxied_value;

	debug_propro(1, "dim_unset", object, offset, NULL TSRMLS_CC);

	proxied_value = get_proxied_value(object TSRMLS_CC);

	if (proxied_value && Z_TYPE_P(proxied_value) == IS_ARRAY) {
		zval *o = offset;
		ZEND_RESULT_CODE rv;

		convert_to_string_ex(&o);
		rv = zend_symtable_del(Z_ARRVAL_P(proxied_value), Z_STRVAL_P(o),
				Z_STRLEN_P(o) + 1);

		if (SUCCESS == rv) {
			set_proxied_value(&object, proxied_value TSRMLS_CC);
		}

		if (o != offset) {
			zval_ptr_dtor(&o);
		}
	}

	debug_propro(-1, "dim_unset", object, offset, proxied_value TSRMLS_CC);
}

ZEND_BEGIN_ARG_INFO_EX(ai_propro_construct, 0, 0, 2)
	ZEND_ARG_INFO(1, object)
	ZEND_ARG_INFO(0, member)
	ZEND_ARG_OBJ_INFO(0, parent, php\\PropertyProxy, 1)
ZEND_END_ARG_INFO();
static PHP_METHOD(propro, __construct) {
	zend_error_handling zeh;
	zval *container, *parent = NULL;
	char *member_str;
	int member_len;

	zend_replace_error_handling(EH_THROW, NULL, &zeh TSRMLS_CC);
	if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "zs|O!",
			&container, &member_str, &member_len, &parent,
			php_property_proxy_class_entry)) {
		php_property_proxy_object_t *obj;

		obj = zend_object_store_get_object(getThis() TSRMLS_CC);
		obj->proxy = php_property_proxy_init(container, member_str,
				member_len TSRMLS_CC);
		if (parent) {
			zend_objects_store_add_ref(parent TSRMLS_CC);
			obj->parent = zend_object_store_get_object(parent TSRMLS_CC);
		}
	}
	zend_restore_error_handling(&zeh TSRMLS_CC);
}

static const zend_function_entry php_property_proxy_method_entry[] = {
	PHP_ME(propro, __construct, ai_propro_construct, ZEND_ACC_PUBLIC)
	{0}
};

static PHP_MINIT_FUNCTION(propro)
{
	zend_class_entry ce = {0};

	INIT_NS_CLASS_ENTRY(ce, "php", "PropertyProxy",
			php_property_proxy_method_entry);
	php_property_proxy_class_entry = zend_register_internal_class_ex(&ce, NULL,
			NULL TSRMLS_CC);
	php_property_proxy_class_entry->create_object =
			php_property_proxy_object_new;
	php_property_proxy_class_entry->ce_flags |= ZEND_ACC_FINAL_CLASS;

	memcpy(&php_property_proxy_object_handlers, zend_get_std_object_handlers(),
			sizeof(zend_object_handlers));
	php_property_proxy_object_handlers.set = set_proxied_value;
	php_property_proxy_object_handlers.get = get_proxied_value;
	php_property_proxy_object_handlers.cast_object = cast_proxied_value;
	php_property_proxy_object_handlers.read_dimension = read_dimension;
	php_property_proxy_object_handlers.write_dimension = write_dimension;
	php_property_proxy_object_handlers.has_dimension = has_dimension;
	php_property_proxy_object_handlers.unset_dimension = unset_dimension;

	return SUCCESS;
}

PHP_MINFO_FUNCTION(propro)
{
	php_info_print_table_start();
	php_info_print_table_header(2, "Property proxy support", "enabled");
	php_info_print_table_row(2, "Extension version", PHP_PROPRO_VERSION);
	php_info_print_table_end();
}

static const zend_function_entry propro_functions[] = {
	{0}
};

zend_module_entry propro_module_entry = {
	STANDARD_MODULE_HEADER,
	"propro",
	propro_functions,
	PHP_MINIT(propro),
	NULL,
	NULL,
	NULL,
	PHP_MINFO(propro),
	PHP_PROPRO_VERSION,
	STANDARD_MODULE_PROPERTIES
};

#ifdef COMPILE_DL_PROPRO
ZEND_GET_MODULE(propro)
#endif


/*
 * Local variables:
 * tab-width: 4
 * c-basic-offset: 4
 * End:
 * vim600: noet sw=4 ts=4 fdm=marker
 * vim<600: noet sw=4 ts=4
 */