Coverage Report

Created: 2026-06-02 06:39

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/php-src/Zend/zend_interfaces.c
Line
Count
Source
1
/*
2
   +----------------------------------------------------------------------+
3
   | Zend Engine                                                          |
4
   +----------------------------------------------------------------------+
5
   | Copyright © Zend Technologies Ltd., a subsidiary company of          |
6
   |     Perforce Software, Inc., and Contributors.                       |
7
   +----------------------------------------------------------------------+
8
   | This source file is subject to the Modified BSD License that is      |
9
   | bundled with this package in the file LICENSE, and is available      |
10
   | through the World Wide Web at <https://www.php.net/license/>.        |
11
   |                                                                      |
12
   | SPDX-License-Identifier: BSD-3-Clause                                |
13
   +----------------------------------------------------------------------+
14
   | Authors: Marcus Boerger <helly@php.net>                              |
15
   +----------------------------------------------------------------------+
16
*/
17
18
#include "zend.h"
19
#include "zend_API.h"
20
#include "zend_interfaces.h"
21
#include "zend_exceptions.h"
22
#include "zend_interfaces_arginfo.h"
23
#include "zend_property_hooks.h"
24
25
ZEND_API zend_class_entry *zend_ce_traversable;
26
ZEND_API zend_class_entry *zend_ce_aggregate;
27
ZEND_API zend_class_entry *zend_ce_iterator;
28
ZEND_API zend_class_entry *zend_ce_arrayaccess;
29
ZEND_API zend_class_entry *zend_ce_serializable;
30
ZEND_API zend_class_entry *zend_ce_countable;
31
ZEND_API zend_class_entry *zend_ce_stringable;
32
ZEND_API zend_class_entry *zend_ce_internal_iterator;
33
34
static zend_object_handlers zend_internal_iterator_handlers;
35
36
/* {{{ zend_call_method
37
 Only returns the returned zval if retval_ptr != NULL */
38
ZEND_API zval* zend_call_method(zend_object *object, zend_class_entry *obj_ce, zend_function **fn_proxy, const char *function_name, size_t function_name_len, zval *retval_ptr, uint32_t param_count, zval* arg1, zval* arg2)
39
74
{
40
74
  zend_function *fn;
41
74
  zend_class_entry *called_scope;
42
74
  zval params[2];
43
44
74
  if (param_count > 0) {
45
24
    ZVAL_COPY_VALUE(&params[0], arg1);
46
24
  }
47
74
  if (param_count > 1) {
48
0
    ZVAL_COPY_VALUE(&params[1], arg2);
49
0
  }
50
51
74
  if (!obj_ce) {
52
0
    obj_ce = object ? object->ce : NULL;
53
0
  }
54
74
  if (!fn_proxy || !*fn_proxy) {
55
72
    if (EXPECTED(obj_ce)) {
56
72
      fn = zend_hash_str_find_ptr_lc(
57
72
        &obj_ce->function_table, function_name, function_name_len);
58
72
      if (UNEXPECTED(fn == NULL)) {
59
        /* error at c-level */
60
0
        zend_error_noreturn(E_CORE_ERROR, "Couldn't find implementation for method %s::%s", ZSTR_VAL(obj_ce->name), function_name);
61
0
      }
62
72
    } else {
63
0
      fn = zend_fetch_function_str(function_name, function_name_len);
64
0
      if (UNEXPECTED(fn == NULL)) {
65
        /* error at c-level */
66
0
        zend_error_noreturn(E_CORE_ERROR, "Couldn't find implementation for function %s", function_name);
67
0
      }
68
0
    }
69
72
    if (fn_proxy) {
70
9
      *fn_proxy = fn;
71
9
    }
72
72
  } else {
73
2
    fn = *fn_proxy;
74
2
  }
75
76
74
  if (object) {
77
74
    called_scope = object->ce;
78
74
  } else {
79
0
    called_scope = obj_ce;
80
0
  }
81
82
74
  zend_call_known_function(fn, object, called_scope, retval_ptr, param_count, params, NULL);
83
74
  return retval_ptr;
84
74
}
85
/* }}} */
86
87
/* iterator interface, c-level functions used by engine */
88
89
/* {{{ zend_user_it_new_iterator */
90
ZEND_API void zend_user_it_new_iterator(zend_class_entry *ce, zval *object, zval *retval)
91
84
{
92
84
  zend_call_known_instance_method_with_0_params(
93
84
    ce->iterator_funcs_ptr->zf_new_iterator, Z_OBJ_P(object), retval);
94
84
}
95
/* }}} */
96
97
/* {{{ zend_user_it_invalidate_current */
98
ZEND_API void zend_user_it_invalidate_current(zend_object_iterator *_iter)
99
770
{
100
770
  zend_user_iterator *iter = (zend_user_iterator*)_iter;
101
102
770
  if (!Z_ISUNDEF(iter->value)) {
103
216
    zval_ptr_dtor(&iter->value);
104
216
    ZVAL_UNDEF(&iter->value);
105
216
  }
106
770
}
107
/* }}} */
108
109
/* {{{ zend_user_it_dtor */
110
static void zend_user_it_dtor(zend_object_iterator *_iter)
111
265
{
112
265
  zend_user_iterator *iter = (zend_user_iterator*)_iter;
113
265
  zval *object = &iter->it.data;
114
115
265
  zend_user_it_invalidate_current(_iter);
116
265
  zval_ptr_dtor(object);
117
265
}
118
/* }}} */
119
120
/* {{{ zend_user_it_valid */
121
ZEND_API zend_result zend_user_it_valid(zend_object_iterator *_iter)
122
364
{
123
364
  if (_iter) {
124
364
    zend_user_iterator *iter = (zend_user_iterator*)_iter;
125
364
    zval *object = &iter->it.data;
126
364
    zval more;
127
128
364
    zend_call_known_instance_method_with_0_params(iter->ce->iterator_funcs_ptr->zf_valid, Z_OBJ_P(object), &more);
129
364
    bool result = i_zend_is_true(&more);
130
364
    zval_ptr_dtor(&more);
131
364
    return result ? SUCCESS : FAILURE;
132
364
  }
133
0
  return FAILURE;
134
364
}
135
/* }}} */
136
137
/* {{{ zend_user_it_get_current_data */
138
ZEND_API zval *zend_user_it_get_current_data(zend_object_iterator *_iter)
139
246
{
140
246
  zend_user_iterator *iter = (zend_user_iterator*)_iter;
141
246
  zval *object = &iter->it.data;
142
143
246
  if (Z_ISUNDEF(iter->value)) {
144
246
    zend_call_known_instance_method_with_0_params(iter->ce->iterator_funcs_ptr->zf_current, Z_OBJ_P(object), &iter->value);
145
246
  }
146
246
  return &iter->value;
147
246
}
148
/* }}} */
149
150
/* {{{ zend_user_it_get_current_key */
151
ZEND_API void zend_user_it_get_current_key(zend_object_iterator *_iter, zval *key)
152
132
{
153
132
  zend_user_iterator *iter = (zend_user_iterator*)_iter;
154
132
  zval *object = &iter->it.data;
155
132
  zend_call_known_instance_method_with_0_params(iter->ce->iterator_funcs_ptr->zf_key, Z_OBJ_P(object), key);
156
132
  if (UNEXPECTED(Z_ISREF_P(key))) {
157
3
    zend_unwrap_reference(key);
158
3
  }
159
132
}
160
/* }}} */
161
162
/* {{{ zend_user_it_move_forward */
163
ZEND_API void zend_user_it_move_forward(zend_object_iterator *_iter)
164
195
{
165
195
  zend_user_iterator *iter = (zend_user_iterator*)_iter;
166
195
  zval *object = &iter->it.data;
167
168
195
  zend_user_it_invalidate_current(_iter);
169
195
  zend_call_known_instance_method_with_0_params(iter->ce->iterator_funcs_ptr->zf_next, Z_OBJ_P(object), NULL);
170
195
}
171
/* }}} */
172
173
/* {{{ zend_user_it_rewind */
174
ZEND_API void zend_user_it_rewind(zend_object_iterator *_iter)
175
268
{
176
268
  zend_user_iterator *iter = (zend_user_iterator*)_iter;
177
268
  zval *object = &iter->it.data;
178
179
268
  zend_user_it_invalidate_current(_iter);
180
268
  zend_call_known_instance_method_with_0_params(iter->ce->iterator_funcs_ptr->zf_rewind, Z_OBJ_P(object), NULL);
181
268
}
182
/* }}} */
183
184
ZEND_API HashTable *zend_user_it_get_gc(zend_object_iterator *_iter, zval **table, int *n)
185
36
{
186
36
  zend_user_iterator *iter = (zend_user_iterator*)_iter;
187
36
  if (Z_ISUNDEF(iter->value)) {
188
36
    *table = &iter->it.data;
189
36
    *n = 1;
190
36
  } else {
191
0
    zend_get_gc_buffer *gc_buffer = zend_get_gc_buffer_create();
192
0
    zend_get_gc_buffer_add_zval(gc_buffer, &iter->it.data);
193
0
    zend_get_gc_buffer_add_zval(gc_buffer, &iter->value);
194
0
    zend_get_gc_buffer_use(gc_buffer, table, n);
195
0
  }
196
36
  return NULL;
197
36
}
198
199
static const zend_object_iterator_funcs zend_interface_iterator_funcs_iterator = {
200
  zend_user_it_dtor,
201
  zend_user_it_valid,
202
  zend_user_it_get_current_data,
203
  zend_user_it_get_current_key,
204
  zend_user_it_move_forward,
205
  zend_user_it_rewind,
206
  zend_user_it_invalidate_current,
207
  zend_user_it_get_gc,
208
};
209
210
/* {{{ zend_user_it_get_iterator */
211
/* by_ref is int due to Iterator API */
212
static zend_object_iterator *zend_user_it_get_iterator(zend_class_entry *ce, zval *object, int by_ref)
213
265
{
214
265
  zend_user_iterator *iterator;
215
216
265
  if (by_ref) {
217
0
    zend_throw_error(NULL, "An iterator cannot be used with foreach by reference");
218
0
    return NULL;
219
0
  }
220
221
265
  iterator = emalloc(sizeof(zend_user_iterator));
222
223
265
  zend_iterator_init((zend_object_iterator*)iterator);
224
225
265
  ZVAL_OBJ_COPY(&iterator->it.data, Z_OBJ_P(object));
226
265
  iterator->it.funcs = &zend_interface_iterator_funcs_iterator;
227
265
  iterator->ce = Z_OBJCE_P(object);
228
265
  ZVAL_UNDEF(&iterator->value);
229
265
  return (zend_object_iterator*)iterator;
230
265
}
231
/* }}} */
232
233
/* {{{ zend_user_it_get_new_iterator */
234
/* by_ref is int due to Iterator API */
235
ZEND_API zend_object_iterator *zend_user_it_get_new_iterator(zend_class_entry *ce, zval *object, int by_ref)
236
84
{
237
84
  zval iterator;
238
84
  zend_object_iterator *new_iterator;
239
84
  zend_class_entry *ce_it;
240
241
84
  zend_user_it_new_iterator(ce, object, &iterator);
242
84
  ce_it = (Z_TYPE(iterator) == IS_OBJECT) ? Z_OBJCE(iterator) : NULL;
243
244
84
  if (!ce_it || !ce_it->get_iterator || (ce_it->get_iterator == zend_user_it_get_new_iterator && Z_OBJ(iterator) == Z_OBJ_P(object))) {
245
9
    if (!EG(exception)) {
246
3
      zend_throw_exception_ex(NULL, 0, "Objects returned by %s::getIterator() must be traversable or implement interface Iterator", ce ? ZSTR_VAL(ce->name) : ZSTR_VAL(Z_OBJCE_P(object)->name));
247
3
    }
248
9
    zval_ptr_dtor(&iterator);
249
9
    return NULL;
250
9
  }
251
252
75
  new_iterator = ce_it->get_iterator(ce_it, &iterator, by_ref);
253
75
  zval_ptr_dtor(&iterator);
254
75
  return new_iterator;
255
84
}
256
/* }}} */
257
258
/* {{{ zend_implement_traversable */
259
static int zend_implement_traversable(zend_class_entry *interface, zend_class_entry *class_type)
260
253
{
261
  /* Abstract class can implement Traversable only, in which case the extending class must
262
   * implement Iterator or IteratorAggregate. */
263
253
  if (class_type->ce_flags & ZEND_ACC_EXPLICIT_ABSTRACT_CLASS) {
264
20
    return SUCCESS;
265
20
  }
266
267
  /* Check that class_type implements at least one of 'IteratorAggregate' or 'Iterator' */
268
233
  if (class_type->num_interfaces) {
269
233
    ZEND_ASSERT(class_type->ce_flags & ZEND_ACC_RESOLVED_INTERFACES);
270
444
    for (uint32_t i = 0; i < class_type->num_interfaces; i++) {
271
438
      if (class_type->interfaces[i] == zend_ce_aggregate || class_type->interfaces[i] == zend_ce_iterator) {
272
227
        return SUCCESS;
273
227
      }
274
438
    }
275
233
  }
276
6
  zend_error_noreturn(E_CORE_ERROR, "%s %s must implement interface %s as part of either %s or %s",
277
6
    zend_get_object_type_uc(class_type),
278
6
    ZSTR_VAL(class_type->name),
279
6
    ZSTR_VAL(zend_ce_traversable->name),
280
6
    ZSTR_VAL(zend_ce_iterator->name),
281
6
    ZSTR_VAL(zend_ce_aggregate->name));
282
0
  return FAILURE;
283
233
}
284
/* }}} */
285
286
/* {{{ zend_implement_aggregate */
287
static int zend_implement_aggregate(zend_class_entry *interface, zend_class_entry *class_type)
288
107
{
289
107
  if (zend_class_implements_interface(class_type, zend_ce_iterator)) {
290
3
    zend_error_noreturn(E_ERROR,
291
3
      "Class %s cannot implement both Iterator and IteratorAggregate at the same time",
292
3
      ZSTR_VAL(class_type->name));
293
3
  }
294
295
  /* Always initialize iterator_funcs_ptr. */
296
104
  ZEND_ASSERT(!class_type->iterator_funcs_ptr && "Iterator funcs already set?");
297
104
  zend_class_iterator_funcs *funcs_ptr = class_type->type == ZEND_INTERNAL_CLASS
298
104
    ? pemalloc(sizeof(zend_class_iterator_funcs), 1)
299
104
    : zend_arena_alloc(&CG(arena), sizeof(zend_class_iterator_funcs));
300
104
  class_type->iterator_funcs_ptr = funcs_ptr;
301
302
104
  memset(funcs_ptr, 0, sizeof(zend_class_iterator_funcs));
303
104
  funcs_ptr->zf_new_iterator = zend_hash_str_find_ptr(
304
104
    &class_type->function_table, "getiterator", sizeof("getiterator") - 1);
305
306
104
  if (class_type->get_iterator
307
28
   && class_type->get_iterator != zend_user_it_get_new_iterator
308
14
   && class_type->get_iterator != zend_hooked_object_get_iterator) {
309
    /* get_iterator was explicitly assigned for an internal class. */
310
10
    if (!class_type->parent || class_type->parent->get_iterator != class_type->get_iterator) {
311
0
      ZEND_ASSERT(class_type->type == ZEND_INTERNAL_CLASS);
312
0
      return SUCCESS;
313
0
    }
314
315
    /* The getIterator() method has not been overwritten, use inherited get_iterator(). */
316
10
    if (funcs_ptr->zf_new_iterator->common.scope != class_type) {
317
10
      return SUCCESS;
318
10
    }
319
320
    /* getIterator() has been overwritten, switch to zend_user_it_get_new_iterator. */
321
10
  }
322
323
94
  class_type->get_iterator = zend_user_it_get_new_iterator;
324
94
  return SUCCESS;
325
104
}
326
/* }}} */
327
328
/* {{{ zend_implement_iterator */
329
static int zend_implement_iterator(zend_class_entry *interface, zend_class_entry *class_type)
330
132
{
331
132
  if (zend_class_implements_interface(class_type, zend_ce_aggregate)) {
332
3
    zend_error_noreturn(E_ERROR,
333
3
      "Class %s cannot implement both Iterator and IteratorAggregate at the same time",
334
3
      ZSTR_VAL(class_type->name));
335
3
  }
336
337
129
  ZEND_ASSERT(!class_type->iterator_funcs_ptr && "Iterator funcs already set?");
338
129
  zend_class_iterator_funcs *funcs_ptr = class_type->type == ZEND_INTERNAL_CLASS
339
129
    ? pemalloc(sizeof(zend_class_iterator_funcs), 1)
340
129
    : zend_arena_alloc(&CG(arena), sizeof(zend_class_iterator_funcs));
341
129
  class_type->iterator_funcs_ptr = funcs_ptr;
342
343
129
  memset(funcs_ptr, 0, sizeof(zend_class_iterator_funcs));
344
129
  funcs_ptr->zf_rewind = zend_hash_str_find_ptr(
345
129
    &class_type->function_table, "rewind", sizeof("rewind") - 1);
346
129
  funcs_ptr->zf_valid = zend_hash_str_find_ptr(
347
129
    &class_type->function_table, "valid", sizeof("valid") - 1);
348
129
  funcs_ptr->zf_key = zend_hash_find_ptr(
349
129
    &class_type->function_table, ZSTR_KNOWN(ZEND_STR_KEY));
350
129
  funcs_ptr->zf_current = zend_hash_str_find_ptr(
351
129
    &class_type->function_table, "current", sizeof("current") - 1);
352
129
  funcs_ptr->zf_next = zend_hash_str_find_ptr(
353
129
    &class_type->function_table, "next", sizeof("next") - 1);
354
355
129
  if (class_type->get_iterator
356
69
   && class_type->get_iterator != zend_user_it_get_iterator
357
29
   && class_type->get_iterator != zend_hooked_object_get_iterator) {
358
22
    if (!class_type->parent || class_type->parent->get_iterator != class_type->get_iterator) {
359
      /* get_iterator was explicitly assigned for an internal class. */
360
0
      ZEND_ASSERT(class_type->type == ZEND_INTERNAL_CLASS);
361
0
      return SUCCESS;
362
0
    }
363
364
    /* None of the Iterator methods have been overwritten, use inherited get_iterator(). */
365
22
    if (funcs_ptr->zf_rewind->common.scope != class_type &&
366
20
        funcs_ptr->zf_valid->common.scope != class_type &&
367
20
        funcs_ptr->zf_key->common.scope != class_type &&
368
16
        funcs_ptr->zf_current->common.scope != class_type &&
369
14
        funcs_ptr->zf_next->common.scope != class_type) {
370
14
      return SUCCESS;
371
14
    }
372
373
    /* One of the Iterator methods has been overwritten,
374
     * switch to zend_user_it_get_iterator. */
375
22
  }
376
377
115
  class_type->get_iterator = zend_user_it_get_iterator;
378
115
  return SUCCESS;
379
129
}
380
/* }}} */
381
382
/* {{{ zend_implement_arrayaccess */
383
static int zend_implement_arrayaccess(zend_class_entry *interface, zend_class_entry *class_type)
384
203
{
385
203
  ZEND_ASSERT(!class_type->arrayaccess_funcs_ptr && "ArrayAccess funcs already set?");
386
203
  zend_class_arrayaccess_funcs *funcs_ptr = class_type->type == ZEND_INTERNAL_CLASS
387
203
    ? pemalloc(sizeof(zend_class_arrayaccess_funcs), 1)
388
203
    : zend_arena_alloc(&CG(arena), sizeof(zend_class_arrayaccess_funcs));
389
203
  class_type->arrayaccess_funcs_ptr = funcs_ptr;
390
391
203
  funcs_ptr->zf_offsetget = zend_hash_str_find_ptr(
392
203
    &class_type->function_table, "offsetget", sizeof("offsetget") - 1);
393
203
  funcs_ptr->zf_offsetexists = zend_hash_str_find_ptr(
394
203
    &class_type->function_table, "offsetexists", sizeof("offsetexists") - 1);
395
203
  funcs_ptr->zf_offsetset = zend_hash_str_find_ptr(
396
203
    &class_type->function_table, "offsetset", sizeof("offsetset") - 1);
397
203
  funcs_ptr->zf_offsetunset = zend_hash_str_find_ptr(
398
203
    &class_type->function_table, "offsetunset", sizeof("offsetunset") - 1);
399
400
203
  return SUCCESS;
401
203
}
402
/* }}} */
403
404
/* {{{ zend_user_serialize */
405
ZEND_API int zend_user_serialize(zval *object, unsigned char **buffer, size_t *buf_len, zend_serialize_data *data)
406
6
{
407
6
  zend_class_entry * ce = Z_OBJCE_P(object);
408
6
  zval retval;
409
6
  zend_result result;
410
411
6
  zend_call_method_with_0_params(
412
6
    Z_OBJ_P(object), Z_OBJCE_P(object), NULL, "serialize", &retval);
413
414
6
  if (Z_TYPE(retval) == IS_UNDEF) {
415
3
    result = FAILURE;
416
3
  } else {
417
3
    switch(Z_TYPE(retval)) {
418
0
    case IS_NULL:
419
      /* we could also make this '*buf_len = 0' but this allows to skip variables */
420
0
      return FAILURE;
421
3
    case IS_STRING:
422
3
      *buffer = (unsigned char*)estrndup(Z_STRVAL(retval), Z_STRLEN(retval));
423
3
      *buf_len = Z_STRLEN(retval);
424
3
      result = SUCCESS;
425
3
      break;
426
0
    default: /* failure */
427
0
      result = FAILURE;
428
0
      break;
429
3
    }
430
3
    zval_ptr_dtor(&retval);
431
3
  }
432
433
6
  if (result == FAILURE && !EG(exception)) {
434
0
    zend_throw_exception_ex(NULL, 0, "%s::serialize() must return a string or NULL", ZSTR_VAL(ce->name));
435
0
  }
436
6
  return result;
437
6
}
438
/* }}} */
439
440
/* {{{ zend_user_unserialize */
441
ZEND_API int zend_user_unserialize(zval *object, zend_class_entry *ce, const unsigned char *buf, size_t buf_len, zend_unserialize_data *data)
442
24
{
443
24
  zval zdata;
444
445
24
  if (UNEXPECTED(object_init_ex(object, ce) != SUCCESS)) {
446
0
    return FAILURE;
447
0
  }
448
449
24
  ZVAL_STRINGL(&zdata, (char*)buf, buf_len);
450
24
  zend_call_method_with_1_params(
451
24
    Z_OBJ_P(object), Z_OBJCE_P(object), NULL, "unserialize", NULL, &zdata);
452
24
  zval_ptr_dtor(&zdata);
453
454
24
  if (EG(exception)) {
455
12
    return FAILURE;
456
12
  } else {
457
12
    return SUCCESS;
458
12
  }
459
24
}
460
/* }}} */
461
462
/* {{{ zend_implement_serializable */
463
static int zend_implement_serializable(zend_class_entry *interface, zend_class_entry *class_type)
464
67
{
465
67
  if (class_type->parent
466
43
    && (class_type->parent->serialize || class_type->parent->unserialize)
467
43
    && !zend_class_implements_interface(class_type->parent, zend_ce_serializable)) {
468
0
    return FAILURE;
469
0
  }
470
67
  if (!class_type->serialize) {
471
24
    class_type->serialize = zend_user_serialize;
472
24
  }
473
67
  if (!class_type->unserialize) {
474
24
    class_type->unserialize = zend_user_unserialize;
475
24
  }
476
67
  if (!(class_type->ce_flags & ZEND_ACC_EXPLICIT_ABSTRACT_CLASS)
477
61
      && (!class_type->__serialize || !class_type->__unserialize)) {
478
18
    zend_error(E_DEPRECATED, "%s implements the Serializable interface, which is deprecated. Implement __serialize() and __unserialize() instead (or in addition, if support for old PHP versions is necessary)", ZSTR_VAL(class_type->name));
479
18
    if (EG(exception)) {
480
0
      zend_exception_uncaught_error(
481
0
        "During inheritance of %s, while implementing Serializable", ZSTR_VAL(class_type->name));
482
0
    }
483
18
  }
484
67
  return SUCCESS;
485
67
}
486
/* }}}*/
487
488
typedef struct {
489
  zend_object std;
490
  zend_object_iterator *iter;
491
  bool rewind_called;
492
} zend_internal_iterator;
493
494
14
static zend_object *zend_internal_iterator_create(zend_class_entry *ce) {
495
14
  zend_internal_iterator *intern = emalloc(sizeof(zend_internal_iterator));
496
14
  zend_object_std_init(&intern->std, ce);
497
14
  intern->iter = NULL;
498
14
  intern->rewind_called = false;
499
14
  return &intern->std;
500
14
}
501
502
9
ZEND_API zend_result zend_create_internal_iterator_zval(zval *return_value, zval *obj) {
503
9
  zend_class_entry *scope = EG(current_execute_data)->func->common.scope;
504
9
  ZEND_ASSERT(scope->get_iterator != zend_user_it_get_new_iterator);
505
9
  zend_object_iterator *iter = scope->get_iterator(Z_OBJCE_P(obj), obj, /* by_ref */ 0);
506
9
  if (!iter) {
507
0
    return FAILURE;
508
0
  }
509
510
9
  zend_internal_iterator *intern =
511
9
    (zend_internal_iterator *) zend_internal_iterator_create(zend_ce_internal_iterator);
512
9
  intern->iter = iter;
513
9
  intern->iter->index = 0;
514
9
  ZVAL_OBJ(return_value, &intern->std);
515
9
  return SUCCESS;
516
9
}
517
518
14
static void zend_internal_iterator_free(zend_object *obj) {
519
14
  zend_internal_iterator *intern = (zend_internal_iterator *) obj;
520
14
  if (intern->iter) {
521
9
    zend_iterator_dtor(intern->iter);
522
9
  }
523
14
  zend_object_std_dtor(&intern->std);
524
14
}
525
526
39
static zend_internal_iterator *zend_internal_iterator_fetch(zval *This) {
527
39
  zend_internal_iterator *intern = (zend_internal_iterator *) Z_OBJ_P(This);
528
39
  if (!intern->iter) {
529
0
    zend_throw_error(NULL, "The InternalIterator object has not been properly initialized");
530
0
    return NULL;
531
0
  }
532
39
  return intern;
533
39
}
534
535
/* Many iterators will not behave correctly if rewind() is not called, make sure it happens. */
536
39
static zend_result zend_internal_iterator_ensure_rewound(zend_internal_iterator *intern) {
537
39
  if (!intern->rewind_called) {
538
9
    zend_object_iterator *iter = intern->iter;
539
9
    intern->rewind_called = true;
540
9
    if (iter->funcs->rewind) {
541
9
      iter->funcs->rewind(iter);
542
9
      if (UNEXPECTED(EG(exception))) {
543
0
        return FAILURE;
544
0
      }
545
9
    }
546
9
  }
547
39
  return SUCCESS;
548
39
}
549
550
551
0
ZEND_METHOD(InternalIterator, __construct) {
552
0
  zend_throw_error(NULL, "Cannot manually construct InternalIterator");
553
0
}
554
555
12
ZEND_METHOD(InternalIterator, current) {
556
12
  ZEND_PARSE_PARAMETERS_NONE();
557
558
12
  zend_internal_iterator *intern = zend_internal_iterator_fetch(ZEND_THIS);
559
12
  if (!intern) {
560
0
    RETURN_THROWS();
561
0
  }
562
563
12
  if (zend_internal_iterator_ensure_rewound(intern) == FAILURE) {
564
0
    RETURN_THROWS();
565
0
  }
566
567
12
  zval *data = intern->iter->funcs->get_current_data(intern->iter);
568
12
  if (data) {
569
3
    RETURN_COPY_DEREF(data);
570
3
  }
571
12
}
572
573
12
ZEND_METHOD(InternalIterator, key) {
574
12
  ZEND_PARSE_PARAMETERS_NONE();
575
576
12
  zend_internal_iterator *intern = zend_internal_iterator_fetch(ZEND_THIS);
577
12
  if (!intern) {
578
0
    RETURN_THROWS();
579
0
  }
580
581
12
  if (zend_internal_iterator_ensure_rewound(intern) == FAILURE) {
582
0
    RETURN_THROWS();
583
0
  }
584
585
12
  if (intern->iter->funcs->get_current_key) {
586
12
    intern->iter->funcs->get_current_key(intern->iter, return_value);
587
12
  } else {
588
0
    RETURN_LONG(intern->iter->index);
589
0
  }
590
12
}
591
592
3
ZEND_METHOD(InternalIterator, next) {
593
3
  ZEND_PARSE_PARAMETERS_NONE();
594
595
3
  zend_internal_iterator *intern = zend_internal_iterator_fetch(ZEND_THIS);
596
3
  if (!intern) {
597
0
    RETURN_THROWS();
598
0
  }
599
600
3
  if (zend_internal_iterator_ensure_rewound(intern) == FAILURE) {
601
0
    RETURN_THROWS();
602
0
  }
603
604
  /* Advance index first to match foreach behavior. */
605
3
  intern->iter->index++;
606
3
  intern->iter->funcs->move_forward(intern->iter);
607
3
}
608
609
12
ZEND_METHOD(InternalIterator, valid) {
610
12
  ZEND_PARSE_PARAMETERS_NONE();
611
612
12
  zend_internal_iterator *intern = zend_internal_iterator_fetch(ZEND_THIS);
613
12
  if (!intern) {
614
0
    RETURN_THROWS();
615
0
  }
616
617
12
  if (zend_internal_iterator_ensure_rewound(intern) == FAILURE) {
618
0
    RETURN_THROWS();
619
0
  }
620
621
12
  RETURN_BOOL(intern->iter->funcs->valid(intern->iter) == SUCCESS);
622
12
}
623
624
0
ZEND_METHOD(InternalIterator, rewind) {
625
0
  ZEND_PARSE_PARAMETERS_NONE();
626
627
0
  zend_internal_iterator *intern = zend_internal_iterator_fetch(ZEND_THIS);
628
0
  if (!intern) {
629
0
    RETURN_THROWS();
630
0
  }
631
632
0
  intern->rewind_called = true;
633
0
  if (!intern->iter->funcs->rewind) {
634
    /* Allow calling rewind() if no iteration has happened yet,
635
     * even if the iterator does not support rewinding. */
636
0
    if (intern->iter->index != 0) {
637
0
      zend_throw_error(NULL, "Iterator does not support rewinding");
638
0
      RETURN_THROWS();
639
0
    }
640
0
    intern->iter->index = 0;
641
0
    return;
642
0
  }
643
644
0
  intern->iter->funcs->rewind(intern->iter);
645
0
  intern->iter->index = 0;
646
0
}
647
648
/* {{{ zend_register_interfaces */
649
ZEND_API void zend_register_interfaces(void)
650
2
{
651
2
  zend_ce_traversable = register_class_Traversable();
652
2
  zend_ce_traversable->interface_gets_implemented = zend_implement_traversable;
653
654
2
  zend_ce_aggregate = register_class_IteratorAggregate(zend_ce_traversable);
655
2
  zend_ce_aggregate->interface_gets_implemented = zend_implement_aggregate;
656
657
2
  zend_ce_iterator = register_class_Iterator(zend_ce_traversable);
658
2
  zend_ce_iterator->interface_gets_implemented = zend_implement_iterator;
659
660
2
  zend_ce_serializable = register_class_Serializable();
661
2
  zend_ce_serializable->interface_gets_implemented = zend_implement_serializable;
662
663
2
  zend_ce_arrayaccess = register_class_ArrayAccess();
664
2
  zend_ce_arrayaccess->interface_gets_implemented = zend_implement_arrayaccess;
665
666
2
  zend_ce_countable = register_class_Countable();
667
668
2
  zend_ce_stringable = register_class_Stringable();
669
670
2
  zend_ce_internal_iterator = register_class_InternalIterator(zend_ce_iterator);
671
2
  zend_ce_internal_iterator->create_object = zend_internal_iterator_create;
672
2
  zend_ce_internal_iterator->default_object_handlers = &zend_internal_iterator_handlers;
673
674
2
  memcpy(&zend_internal_iterator_handlers, zend_get_std_object_handlers(),
675
2
    sizeof(zend_object_handlers));
676
  zend_internal_iterator_handlers.clone_obj = NULL;
677
2
  zend_internal_iterator_handlers.free_obj = zend_internal_iterator_free;
678
2
}
679
/* }}} */