1/*
2   +----------------------------------------------------------------------+
3   | Zend Engine                                                          |
4   +----------------------------------------------------------------------+
5   | Copyright (c) 1998-2014 Zend Technologies Ltd. (http://www.zend.com) |
6   +----------------------------------------------------------------------+
7   | This source file is subject to version 2.00 of the Zend license,     |
8   | that is bundled with this package in the file LICENSE, and is        |
9   | available through the world-wide-web at the following url:           |
10   | http://www.zend.com/license/2_00.txt.                                |
11   | If you did not receive a copy of the Zend license and are unable to  |
12   | obtain it through the world-wide-web, please send a note to          |
13   | license@zend.com so we can mail you a copy immediately.              |
14   +----------------------------------------------------------------------+
15   | Authors: Christian Seiler <chris_se@gmx.net>                         |
16   |          Dmitry Stogov <dmitry@zend.com>                             |
17   |          Marcus Boerger <helly@php.net>                              |
18   +----------------------------------------------------------------------+
19*/
20
21/* $Id$ */
22
23#include "zend.h"
24#include "zend_API.h"
25#include "zend_closures.h"
26#include "zend_exceptions.h"
27#include "zend_interfaces.h"
28#include "zend_objects.h"
29#include "zend_objects_API.h"
30#include "zend_globals.h"
31
32#define ZEND_CLOSURE_PRINT_NAME "Closure object"
33
34#define ZEND_CLOSURE_PROPERTY_ERROR() \
35    zend_error(E_RECOVERABLE_ERROR, "Closure object cannot have properties")
36
37typedef struct _zend_closure {
38    zend_object    std;
39    zend_function  func;
40    zval           this_ptr;
41    HashTable     *debug_info;
42} zend_closure;
43
44/* non-static since it needs to be referenced */
45ZEND_API zend_class_entry *zend_ce_closure;
46static zend_object_handlers closure_handlers;
47
48ZEND_METHOD(Closure, __invoke) /* {{{ */
49{
50    zend_function *func = EX(func);
51    zval *arguments;
52
53    arguments = emalloc(sizeof(zval) * ZEND_NUM_ARGS());
54    if (zend_get_parameters_array_ex(ZEND_NUM_ARGS(), arguments) == FAILURE) {
55        efree(arguments);
56        zend_error(E_RECOVERABLE_ERROR, "Cannot get arguments for calling closure");
57        RETVAL_FALSE;
58    } else if (call_user_function_ex(CG(function_table), NULL, getThis(), return_value, ZEND_NUM_ARGS(), arguments, 1, NULL) == FAILURE) {
59        RETVAL_FALSE;
60    }
61    efree(arguments);
62
63    /* destruct the function also, then - we have allocated it in get_method */
64    zend_string_release(func->internal_function.function_name);
65    efree(func);
66}
67/* }}} */
68
69/* {{{ proto mixed Closure::call(object $to [, mixed $parameter] [, mixed $...] )
70   Call closure, binding to a given object with its class as the scope */
71ZEND_METHOD(Closure, call)
72{
73    zval *zclosure, *newthis, closure_result;
74    zend_closure *closure;
75    zend_fcall_info fci;
76    zend_fcall_info_cache fci_cache;
77    zval *my_params;
78    int my_param_count = 0;
79    zend_function my_function;
80
81    if (zend_parse_parameters(ZEND_NUM_ARGS(), "o*", &newthis, &my_params, &my_param_count) == FAILURE) {
82        return;
83    }
84
85    zclosure = getThis();
86    closure = (zend_closure *)Z_OBJ_P(zclosure);
87
88    if (closure->func.common.fn_flags & ZEND_ACC_STATIC) {
89        zend_error(E_WARNING, "Cannot bind an instance to a static closure");
90        return;
91    }
92
93    if (closure->func.type == ZEND_INTERNAL_FUNCTION) {
94        /* verify that we aren't binding internal function to a wrong object */
95        if ((closure->func.common.fn_flags & ZEND_ACC_STATIC) == 0 &&
96                !instanceof_function(Z_OBJCE_P(newthis), closure->func.common.scope)) {
97            zend_error(E_WARNING, "Cannot bind function %s::%s to object of class %s", closure->func.common.scope->name->val, closure->func.common.function_name->val, Z_OBJCE_P(newthis)->name->val);
98            return;
99        }
100    }
101
102    /* This should never happen as closures will always be callable */
103    if (zend_fcall_info_init(zclosure, 0, &fci, &fci_cache, NULL, NULL) != SUCCESS) {
104        ZEND_ASSERT(0);
105    }
106
107    fci.retval = &closure_result;
108    fci.params = my_params;
109    fci.param_count = my_param_count;
110    fci.object = fci_cache.object = Z_OBJ_P(newthis);
111    fci_cache.initialized = 1;
112
113    my_function = *fci_cache.function_handler;
114    /* use scope of passed object */
115    my_function.common.scope = Z_OBJCE_P(newthis);
116    fci_cache.function_handler = &my_function;
117
118    if (zend_call_function(&fci, &fci_cache) == SUCCESS && Z_TYPE(closure_result) != IS_UNDEF) {
119        ZVAL_COPY_VALUE(return_value, &closure_result);
120    }
121}
122/* }}} */
123
124/* {{{ proto Closure Closure::bind(Closure $old, object $to [, mixed $scope = "static" ] )
125   Create a closure from another one and bind to another object and scope */
126ZEND_METHOD(Closure, bind)
127{
128    zval *newthis, *zclosure, *scope_arg = NULL;
129    zend_closure *closure;
130    zend_class_entry *ce;
131
132    if (zend_parse_method_parameters(ZEND_NUM_ARGS(), getThis(), "Oo!|z", &zclosure, zend_ce_closure, &newthis, &scope_arg) == FAILURE) {
133        RETURN_NULL();
134    }
135
136    closure = (zend_closure *)Z_OBJ_P(zclosure);
137
138    if ((newthis != NULL) && (closure->func.common.fn_flags & ZEND_ACC_STATIC)) {
139        zend_error(E_WARNING, "Cannot bind an instance to a static closure");
140    }
141
142    if (scope_arg != NULL) { /* scope argument was given */
143        if (Z_TYPE_P(scope_arg) == IS_OBJECT) {
144            ce = Z_OBJCE_P(scope_arg);
145        } else if (Z_TYPE_P(scope_arg) == IS_NULL) {
146            ce = NULL;
147        } else {
148            zend_string *class_name = zval_get_string(scope_arg);
149            if (zend_string_equals_literal(class_name, "static")) {
150                ce = closure->func.common.scope;
151            } else if ((ce = zend_lookup_class_ex(class_name, NULL, 1)) == NULL) {
152                zend_error(E_WARNING, "Class '%s' not found", class_name->val);
153                zend_string_release(class_name);
154                RETURN_NULL();
155            }
156            zend_string_release(class_name);
157        }
158    } else { /* scope argument not given; do not change the scope by default */
159        ce = closure->func.common.scope;
160    }
161
162    zend_create_closure(return_value, &closure->func, ce, newthis);
163}
164/* }}} */
165
166static zend_function *zend_closure_get_constructor(zend_object *object) /* {{{ */
167{
168    zend_error(E_RECOVERABLE_ERROR, "Instantiation of 'Closure' is not allowed");
169    return NULL;
170}
171/* }}} */
172
173static int zend_closure_compare_objects(zval *o1, zval *o2) /* {{{ */
174{
175    return (Z_OBJ_P(o1) != Z_OBJ_P(o2));
176}
177/* }}} */
178
179ZEND_API zend_function *zend_get_closure_invoke_method(zend_object *object) /* {{{ */
180{
181    zend_closure *closure = (zend_closure *)object;
182    zend_function *invoke = (zend_function*)emalloc(sizeof(zend_function));
183
184    invoke->common = closure->func.common;
185    /* TODO: return ZEND_INTERNAL_FUNCTION, but arg_info representation is suitable for ZEND_USER_FUNCTION ??? */
186    invoke->type = ZEND_INTERNAL_FUNCTION;
187    invoke->internal_function.fn_flags = ZEND_ACC_PUBLIC | ZEND_ACC_CALL_VIA_HANDLER | (closure->func.common.fn_flags & ZEND_ACC_RETURN_REFERENCE);
188    invoke->internal_function.handler = ZEND_MN(Closure___invoke);
189    invoke->internal_function.module = 0;
190    invoke->internal_function.scope = zend_ce_closure;
191    invoke->internal_function.function_name = zend_string_init(ZEND_INVOKE_FUNC_NAME, sizeof(ZEND_INVOKE_FUNC_NAME)-1, 0);
192    return invoke;
193}
194/* }}} */
195
196ZEND_API const zend_function *zend_get_closure_method_def(zval *obj) /* {{{ */
197{
198    zend_closure *closure = (zend_closure *)Z_OBJ_P(obj);
199    return &closure->func;
200}
201/* }}} */
202
203ZEND_API zval* zend_get_closure_this_ptr(zval *obj) /* {{{ */
204{
205    zend_closure *closure = (zend_closure *)Z_OBJ_P(obj);
206    return &closure->this_ptr;
207}
208/* }}} */
209
210static zend_function *zend_closure_get_method(zend_object **object, zend_string *method, const zval *key) /* {{{ */
211{
212    zend_string *lc_name;
213
214    lc_name = zend_string_alloc(method->len, 0);
215    zend_str_tolower_copy(lc_name->val, method->val, method->len);
216    if (zend_string_equals_literal(method, ZEND_INVOKE_FUNC_NAME)) {
217        zend_string_free(lc_name);
218        return zend_get_closure_invoke_method(*object);
219    }
220    zend_string_free(lc_name);
221    return std_object_handlers.get_method(object, method, key);
222}
223/* }}} */
224
225static zval *zend_closure_read_property(zval *object, zval *member, int type, void **cache_slot, zval *rv) /* {{{ */
226{
227    ZEND_CLOSURE_PROPERTY_ERROR();
228    return &EG(uninitialized_zval);
229}
230/* }}} */
231
232static void zend_closure_write_property(zval *object, zval *member, zval *value, void **cache_slot) /* {{{ */
233{
234    ZEND_CLOSURE_PROPERTY_ERROR();
235}
236/* }}} */
237
238static zval *zend_closure_get_property_ptr_ptr(zval *object, zval *member, int type, void **cache_slot) /* {{{ */
239{
240    ZEND_CLOSURE_PROPERTY_ERROR();
241    return NULL;
242}
243/* }}} */
244
245static int zend_closure_has_property(zval *object, zval *member, int has_set_exists, void **cache_slot) /* {{{ */
246{
247    if (has_set_exists != 2) {
248        ZEND_CLOSURE_PROPERTY_ERROR();
249    }
250    return 0;
251}
252/* }}} */
253
254static void zend_closure_unset_property(zval *object, zval *member, void **cache_slot) /* {{{ */
255{
256    ZEND_CLOSURE_PROPERTY_ERROR();
257}
258/* }}} */
259
260static void zend_closure_free_storage(zend_object *object) /* {{{ */
261{
262    zend_closure *closure = (zend_closure *)object;
263
264    zend_object_std_dtor(&closure->std);
265
266    if (closure->func.type == ZEND_USER_FUNCTION) {
267        zend_execute_data *ex = EG(current_execute_data);
268        while (ex) {
269            if (ex->func == &closure->func) {
270                zend_error(E_ERROR, "Cannot destroy active lambda function");
271            }
272            ex = ex->prev_execute_data;
273        }
274        destroy_op_array(&closure->func.op_array);
275    }
276
277    if (closure->debug_info != NULL) {
278        zend_hash_destroy(closure->debug_info);
279        efree(closure->debug_info);
280    }
281
282    if (Z_TYPE(closure->this_ptr) != IS_UNDEF) {
283        zval_ptr_dtor(&closure->this_ptr);
284    }
285}
286/* }}} */
287
288static zend_object *zend_closure_new(zend_class_entry *class_type) /* {{{ */
289{
290    zend_closure *closure;
291
292    closure = emalloc(sizeof(zend_closure));
293    memset(closure, 0, sizeof(zend_closure));
294
295    zend_object_std_init(&closure->std, class_type);
296    closure->std.handlers = &closure_handlers;
297
298    return (zend_object*)closure;
299}
300/* }}} */
301
302static zend_object *zend_closure_clone(zval *zobject) /* {{{ */
303{
304    zend_closure *closure = (zend_closure *)Z_OBJ_P(zobject);
305    zval result;
306
307    zend_create_closure(&result, &closure->func, closure->func.common.scope, &closure->this_ptr);
308    return Z_OBJ(result);
309}
310/* }}} */
311
312int zend_closure_get_closure(zval *obj, zend_class_entry **ce_ptr, zend_function **fptr_ptr, zend_object **obj_ptr) /* {{{ */
313{
314    zend_closure *closure;
315
316    if (Z_TYPE_P(obj) != IS_OBJECT) {
317        return FAILURE;
318    }
319
320    closure = (zend_closure *)Z_OBJ_P(obj);
321    *fptr_ptr = &closure->func;
322
323    if (Z_TYPE(closure->this_ptr) != IS_UNDEF) {
324        if (obj_ptr) {
325            *obj_ptr = Z_OBJ(closure->this_ptr);
326        }
327        *ce_ptr = Z_OBJCE(closure->this_ptr);
328    } else {
329        if (obj_ptr) {
330            *obj_ptr = NULL;
331        }
332        *ce_ptr = closure->func.common.scope;
333    }
334    return SUCCESS;
335}
336/* }}} */
337
338static HashTable *zend_closure_get_debug_info(zval *object, int *is_temp) /* {{{ */
339{
340    zend_closure *closure = (zend_closure *)Z_OBJ_P(object);
341    zval val;
342    struct _zend_arg_info *arg_info = closure->func.common.arg_info;
343
344    *is_temp = 0;
345
346    if (closure->debug_info == NULL) {
347        ALLOC_HASHTABLE(closure->debug_info);
348        zend_hash_init(closure->debug_info, 8, NULL, ZVAL_PTR_DTOR, 0);
349    }
350    if (closure->debug_info->u.v.nApplyCount == 0) {
351        if (closure->func.type == ZEND_USER_FUNCTION && closure->func.op_array.static_variables) {
352            HashTable *static_variables = closure->func.op_array.static_variables;
353            ZVAL_NEW_ARR(&val);
354            zend_array_dup(Z_ARRVAL(val), static_variables);
355            zend_hash_str_update(closure->debug_info, "static", sizeof("static")-1, &val);
356        }
357
358        if (Z_TYPE(closure->this_ptr) != IS_UNDEF) {
359            Z_ADDREF(closure->this_ptr);
360            zend_hash_str_update(closure->debug_info, "this", sizeof("this")-1, &closure->this_ptr);
361        }
362
363        if (arg_info) {
364            uint32_t i, num_args, required = closure->func.common.required_num_args;
365
366            array_init(&val);
367
368            num_args = closure->func.common.num_args;
369            if (closure->func.common.fn_flags & ZEND_ACC_VARIADIC) {
370                num_args++;
371            }
372            for (i = 0; i < num_args; i++) {
373                zend_string *name;
374                zval info;
375                if (arg_info->name) {
376                    name = zend_strpprintf(0, "%s$%s",
377                            arg_info->pass_by_reference ? "&" : "",
378                            arg_info->name->val);
379                } else {
380                    name = zend_strpprintf(0, "%s$param%d",
381                            arg_info->pass_by_reference ? "&" : "",
382                            i + 1);
383                }
384                ZVAL_NEW_STR(&info, zend_strpprintf(0, "%s", i >= required ? "<optional>" : "<required>"));
385                zend_hash_update(Z_ARRVAL(val), name, &info);
386                zend_string_release(name);
387                arg_info++;
388            }
389            zend_hash_str_update(closure->debug_info, "parameter", sizeof("parameter")-1, &val);
390        }
391    }
392
393    return closure->debug_info;
394}
395/* }}} */
396
397static HashTable *zend_closure_get_gc(zval *obj, zval **table, int *n) /* {{{ */
398{
399    zend_closure *closure = (zend_closure *)Z_OBJ_P(obj);
400
401    if (closure->debug_info != NULL) {
402        zend_hash_destroy(closure->debug_info);
403        efree(closure->debug_info);
404        closure->debug_info = NULL;
405    }
406
407    *table = Z_TYPE(closure->this_ptr) != IS_NULL ? &closure->this_ptr : NULL;
408    *n = Z_TYPE(closure->this_ptr) != IS_NULL ? 1 : 0;
409    return (closure->func.type == ZEND_USER_FUNCTION) ?
410        closure->func.op_array.static_variables : NULL;
411}
412/* }}} */
413
414/* {{{ proto Closure::__construct()
415   Private constructor preventing instantiation */
416ZEND_METHOD(Closure, __construct)
417{
418    zend_error(E_RECOVERABLE_ERROR, "Instantiation of 'Closure' is not allowed");
419}
420/* }}} */
421
422ZEND_BEGIN_ARG_INFO_EX(arginfo_closure_bindto, 0, 0, 1)
423    ZEND_ARG_INFO(0, newthis)
424    ZEND_ARG_INFO(0, newscope)
425ZEND_END_ARG_INFO()
426
427ZEND_BEGIN_ARG_INFO_EX(arginfo_closure_bind, 0, 0, 2)
428    ZEND_ARG_INFO(0, closure)
429    ZEND_ARG_INFO(0, newthis)
430    ZEND_ARG_INFO(0, newscope)
431ZEND_END_ARG_INFO()
432
433ZEND_BEGIN_ARG_INFO_EX(arginfo_closure_call, 0, 0, 1)
434    ZEND_ARG_INFO(0, newthis)
435    ZEND_ARG_VARIADIC_INFO(0, parameters)
436ZEND_END_ARG_INFO()
437
438static const zend_function_entry closure_functions[] = {
439    ZEND_ME(Closure, __construct, NULL, ZEND_ACC_PRIVATE)
440    ZEND_ME(Closure, bind, arginfo_closure_bind, ZEND_ACC_PUBLIC|ZEND_ACC_STATIC)
441    ZEND_MALIAS(Closure, bindTo, bind, arginfo_closure_bindto, ZEND_ACC_PUBLIC)
442    ZEND_ME(Closure, call, arginfo_closure_call, ZEND_ACC_PUBLIC)
443    ZEND_FE_END
444};
445
446void zend_register_closure_ce(void) /* {{{ */
447{
448    zend_class_entry ce;
449
450    INIT_CLASS_ENTRY(ce, "Closure", closure_functions);
451    zend_ce_closure = zend_register_internal_class(&ce);
452    zend_ce_closure->ce_flags |= ZEND_ACC_FINAL;
453    zend_ce_closure->create_object = zend_closure_new;
454    zend_ce_closure->serialize = zend_class_serialize_deny;
455    zend_ce_closure->unserialize = zend_class_unserialize_deny;
456
457    memcpy(&closure_handlers, zend_get_std_object_handlers(), sizeof(zend_object_handlers));
458    closure_handlers.free_obj = zend_closure_free_storage;
459    closure_handlers.clone_obj = NULL;
460    closure_handlers.get_constructor = zend_closure_get_constructor;
461    closure_handlers.get_method = zend_closure_get_method;
462    closure_handlers.write_property = zend_closure_write_property;
463    closure_handlers.read_property = zend_closure_read_property;
464    closure_handlers.get_property_ptr_ptr = zend_closure_get_property_ptr_ptr;
465    closure_handlers.has_property = zend_closure_has_property;
466    closure_handlers.unset_property = zend_closure_unset_property;
467    closure_handlers.compare_objects = zend_closure_compare_objects;
468    closure_handlers.clone_obj = zend_closure_clone;
469    closure_handlers.get_debug_info = zend_closure_get_debug_info;
470    closure_handlers.get_closure = zend_closure_get_closure;
471    closure_handlers.get_gc = zend_closure_get_gc;
472}
473/* }}} */
474
475ZEND_API void zend_create_closure(zval *res, zend_function *func, zend_class_entry *scope, zval *this_ptr) /* {{{ */
476{
477    zend_closure *closure;
478
479    object_init_ex(res, zend_ce_closure);
480
481    closure = (zend_closure *)Z_OBJ_P(res);
482
483    closure->func = *func;
484    closure->func.common.prototype = NULL;
485
486    if ((scope == NULL) && this_ptr && (Z_TYPE_P(this_ptr) != IS_UNDEF)) {
487        /* use dummy scope if we're binding an object without specifying a scope */
488        /* maybe it would be better to create one for this purpose */
489        scope = zend_ce_closure;
490    }
491
492    if (closure->func.type == ZEND_USER_FUNCTION) {
493        if (closure->func.op_array.static_variables) {
494            HashTable *static_variables = closure->func.op_array.static_variables;
495
496            ALLOC_HASHTABLE(closure->func.op_array.static_variables);
497            zend_hash_init(closure->func.op_array.static_variables, zend_hash_num_elements(static_variables), NULL, ZVAL_PTR_DTOR, 0);
498            zend_hash_apply_with_arguments(static_variables, zval_copy_static_var, 1, closure->func.op_array.static_variables);
499        }
500        closure->func.op_array.run_time_cache = NULL;
501        (*closure->func.op_array.refcount)++;
502    } else {
503        /* verify that we aren't binding internal function to a wrong scope */
504        if(func->common.scope != NULL) {
505            if(scope && !instanceof_function(scope, func->common.scope)) {
506                zend_error(E_WARNING, "Cannot bind function %s::%s to scope class %s", func->common.scope->name->val, func->common.function_name->val, scope->name->val);
507                scope = NULL;
508            }
509            if(scope && this_ptr && (func->common.fn_flags & ZEND_ACC_STATIC) == 0 &&
510                    !instanceof_function(Z_OBJCE_P(this_ptr), closure->func.common.scope)) {
511                zend_error(E_WARNING, "Cannot bind function %s::%s to object of class %s", func->common.scope->name->val, func->common.function_name->val, Z_OBJCE_P(this_ptr)->name->val);
512                scope = NULL;
513                this_ptr = NULL;
514            }
515        } else {
516            /* if it's a free function, we won't set scope & this since they're meaningless */
517            this_ptr = NULL;
518            scope = NULL;
519        }
520    }
521
522    ZVAL_UNDEF(&closure->this_ptr);
523    /* Invariants:
524     * If the closure is unscoped, it has no bound object.
525     * The the closure is scoped, it's either static or it's bound */
526    closure->func.common.scope = scope;
527    if (scope) {
528        closure->func.common.fn_flags |= ZEND_ACC_PUBLIC;
529        if (this_ptr && Z_TYPE_P(this_ptr) == IS_OBJECT && (closure->func.common.fn_flags & ZEND_ACC_STATIC) == 0) {
530            ZVAL_COPY(&closure->this_ptr, this_ptr);
531        } else {
532            closure->func.common.fn_flags |= ZEND_ACC_STATIC;
533        }
534    }
535}
536/* }}} */
537
538/*
539 * Local variables:
540 * tab-width: 4
541 * c-basic-offset: 4
542 * indent-tabs-mode: t
543 * End:
544 */
545