1 /*
2 +----------------------------------------------------------------------+
3 | Zend Engine |
4 +----------------------------------------------------------------------+
5 | Copyright (c) 1998-2018 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: Andi Gutmans <andi@zend.com> |
16 | Zeev Suraski <zeev@zend.com> |
17 +----------------------------------------------------------------------+
18 */
19
20 /* $Id$ */
21
22 #include "zend.h"
23 #include "zend_constants.h"
24 #include "zend_exceptions.h"
25 #include "zend_execute.h"
26 #include "zend_variables.h"
27 #include "zend_operators.h"
28 #include "zend_globals.h"
29 #include "zend_API.h"
30
free_zend_constant(zval * zv)31 void free_zend_constant(zval *zv)
32 {
33 zend_constant *c = Z_PTR_P(zv);
34
35 if (!(c->flags & CONST_PERSISTENT)) {
36 zval_ptr_dtor(&c->value);
37 } else {
38 zval_internal_dtor(&c->value);
39 }
40 if (c->name) {
41 zend_string_release(c->name);
42 }
43 pefree(c, c->flags & CONST_PERSISTENT);
44 }
45
46
copy_zend_constant(zval * zv)47 static void copy_zend_constant(zval *zv)
48 {
49 zend_constant *c = Z_PTR_P(zv);
50
51 Z_PTR_P(zv) = pemalloc(sizeof(zend_constant), c->flags & CONST_PERSISTENT);
52 memcpy(Z_PTR_P(zv), c, sizeof(zend_constant));
53
54 c = Z_PTR_P(zv);
55 c->name = zend_string_copy(c->name);
56 if (!(c->flags & CONST_PERSISTENT)) {
57 zval_copy_ctor(&c->value);
58 } else {
59 if (Z_TYPE(c->value) == IS_STRING) {
60 Z_STR(c->value) = zend_string_dup(Z_STR(c->value), 1);
61 }
62 }
63 }
64
65
zend_copy_constants(HashTable * target,HashTable * source)66 void zend_copy_constants(HashTable *target, HashTable *source)
67 {
68 zend_hash_copy(target, source, copy_zend_constant);
69 }
70
71
clean_module_constant(zval * el,void * arg)72 static int clean_module_constant(zval *el, void *arg)
73 {
74 zend_constant *c = (zend_constant *)Z_PTR_P(el);
75 int module_number = *(int *)arg;
76
77 if (c->module_number == module_number) {
78 return 1;
79 } else {
80 return 0;
81 }
82 }
83
84
clean_module_constants(int module_number)85 void clean_module_constants(int module_number)
86 {
87 zend_hash_apply_with_argument(EG(zend_constants), clean_module_constant, (void *) &module_number);
88 }
89
90
zend_startup_constants(void)91 int zend_startup_constants(void)
92 {
93 EG(zend_constants) = (HashTable *) malloc(sizeof(HashTable));
94
95 zend_hash_init(EG(zend_constants), 128, NULL, ZEND_CONSTANT_DTOR, 1);
96 return SUCCESS;
97 }
98
99
100
zend_register_standard_constants(void)101 void zend_register_standard_constants(void)
102 {
103 REGISTER_MAIN_LONG_CONSTANT("E_ERROR", E_ERROR, CONST_PERSISTENT | CONST_CS);
104 REGISTER_MAIN_LONG_CONSTANT("E_RECOVERABLE_ERROR", E_RECOVERABLE_ERROR, CONST_PERSISTENT | CONST_CS);
105 REGISTER_MAIN_LONG_CONSTANT("E_WARNING", E_WARNING, CONST_PERSISTENT | CONST_CS);
106 REGISTER_MAIN_LONG_CONSTANT("E_PARSE", E_PARSE, CONST_PERSISTENT | CONST_CS);
107 REGISTER_MAIN_LONG_CONSTANT("E_NOTICE", E_NOTICE, CONST_PERSISTENT | CONST_CS);
108 REGISTER_MAIN_LONG_CONSTANT("E_STRICT", E_STRICT, CONST_PERSISTENT | CONST_CS);
109 REGISTER_MAIN_LONG_CONSTANT("E_DEPRECATED", E_DEPRECATED, CONST_PERSISTENT | CONST_CS);
110 REGISTER_MAIN_LONG_CONSTANT("E_CORE_ERROR", E_CORE_ERROR, CONST_PERSISTENT | CONST_CS);
111 REGISTER_MAIN_LONG_CONSTANT("E_CORE_WARNING", E_CORE_WARNING, CONST_PERSISTENT | CONST_CS);
112 REGISTER_MAIN_LONG_CONSTANT("E_COMPILE_ERROR", E_COMPILE_ERROR, CONST_PERSISTENT | CONST_CS);
113 REGISTER_MAIN_LONG_CONSTANT("E_COMPILE_WARNING", E_COMPILE_WARNING, CONST_PERSISTENT | CONST_CS);
114 REGISTER_MAIN_LONG_CONSTANT("E_USER_ERROR", E_USER_ERROR, CONST_PERSISTENT | CONST_CS);
115 REGISTER_MAIN_LONG_CONSTANT("E_USER_WARNING", E_USER_WARNING, CONST_PERSISTENT | CONST_CS);
116 REGISTER_MAIN_LONG_CONSTANT("E_USER_NOTICE", E_USER_NOTICE, CONST_PERSISTENT | CONST_CS);
117 REGISTER_MAIN_LONG_CONSTANT("E_USER_DEPRECATED", E_USER_DEPRECATED, CONST_PERSISTENT | CONST_CS);
118
119 REGISTER_MAIN_LONG_CONSTANT("E_ALL", E_ALL, CONST_PERSISTENT | CONST_CS);
120
121 REGISTER_MAIN_LONG_CONSTANT("DEBUG_BACKTRACE_PROVIDE_OBJECT", DEBUG_BACKTRACE_PROVIDE_OBJECT, CONST_PERSISTENT | CONST_CS);
122 REGISTER_MAIN_LONG_CONSTANT("DEBUG_BACKTRACE_IGNORE_ARGS", DEBUG_BACKTRACE_IGNORE_ARGS, CONST_PERSISTENT | CONST_CS);
123 /* true/false constants */
124 {
125 REGISTER_MAIN_BOOL_CONSTANT("TRUE", 1, CONST_PERSISTENT | CONST_CT_SUBST);
126 REGISTER_MAIN_BOOL_CONSTANT("FALSE", 0, CONST_PERSISTENT | CONST_CT_SUBST);
127 REGISTER_MAIN_BOOL_CONSTANT("ZEND_THREAD_SAFE", ZTS_V, CONST_PERSISTENT | CONST_CS);
128 REGISTER_MAIN_BOOL_CONSTANT("ZEND_DEBUG_BUILD", ZEND_DEBUG, CONST_PERSISTENT | CONST_CS);
129 }
130 REGISTER_MAIN_NULL_CONSTANT("NULL", CONST_PERSISTENT | CONST_CT_SUBST);
131 }
132
133
zend_shutdown_constants(void)134 int zend_shutdown_constants(void)
135 {
136 zend_hash_destroy(EG(zend_constants));
137 free(EG(zend_constants));
138 return SUCCESS;
139 }
140
zend_register_null_constant(const char * name,size_t name_len,int flags,int module_number)141 ZEND_API void zend_register_null_constant(const char *name, size_t name_len, int flags, int module_number)
142 {
143 zend_constant c;
144
145 ZVAL_NULL(&c.value);
146 c.flags = flags;
147 c.name = zend_string_init(name, name_len, flags & CONST_PERSISTENT);
148 c.module_number = module_number;
149 zend_register_constant(&c);
150 }
151
zend_register_bool_constant(const char * name,size_t name_len,zend_bool bval,int flags,int module_number)152 ZEND_API void zend_register_bool_constant(const char *name, size_t name_len, zend_bool bval, int flags, int module_number)
153 {
154 zend_constant c;
155
156 ZVAL_BOOL(&c.value, bval);
157 c.flags = flags;
158 c.name = zend_string_init(name, name_len, flags & CONST_PERSISTENT);
159 c.module_number = module_number;
160 zend_register_constant(&c);
161 }
162
zend_register_long_constant(const char * name,size_t name_len,zend_long lval,int flags,int module_number)163 ZEND_API void zend_register_long_constant(const char *name, size_t name_len, zend_long lval, int flags, int module_number)
164 {
165 zend_constant c;
166
167 ZVAL_LONG(&c.value, lval);
168 c.flags = flags;
169 c.name = zend_string_init(name, name_len, flags & CONST_PERSISTENT);
170 c.module_number = module_number;
171 zend_register_constant(&c);
172 }
173
174
zend_register_double_constant(const char * name,size_t name_len,double dval,int flags,int module_number)175 ZEND_API void zend_register_double_constant(const char *name, size_t name_len, double dval, int flags, int module_number)
176 {
177 zend_constant c;
178
179 ZVAL_DOUBLE(&c.value, dval);
180 c.flags = flags;
181 c.name = zend_string_init(name, name_len, flags & CONST_PERSISTENT);
182 c.module_number = module_number;
183 zend_register_constant(&c);
184 }
185
186
zend_register_stringl_constant(const char * name,size_t name_len,char * strval,size_t strlen,int flags,int module_number)187 ZEND_API void zend_register_stringl_constant(const char *name, size_t name_len, char *strval, size_t strlen, int flags, int module_number)
188 {
189 zend_constant c;
190
191 ZVAL_NEW_STR(&c.value, zend_string_init(strval, strlen, flags & CONST_PERSISTENT));
192 c.flags = flags;
193 c.name = zend_string_init(name, name_len, flags & CONST_PERSISTENT);
194 c.module_number = module_number;
195 zend_register_constant(&c);
196 }
197
198
zend_register_string_constant(const char * name,size_t name_len,char * strval,int flags,int module_number)199 ZEND_API void zend_register_string_constant(const char *name, size_t name_len, char *strval, int flags, int module_number)
200 {
201 zend_register_stringl_constant(name, name_len, strval, strlen(strval), flags, module_number);
202 }
203
zend_get_special_constant(const char * name,size_t name_len)204 static zend_constant *zend_get_special_constant(const char *name, size_t name_len)
205 {
206 zend_constant *c;
207 static char haltoff[] = "__COMPILER_HALT_OFFSET__";
208
209 if (!EG(current_execute_data)) {
210 return NULL;
211 } else if (name_len == sizeof("__COMPILER_HALT_OFFSET__")-1 &&
212 !memcmp(name, "__COMPILER_HALT_OFFSET__", sizeof("__COMPILER_HALT_OFFSET__")-1)) {
213 const char *cfilename;
214 zend_string *haltname;
215 size_t clen;
216
217 cfilename = zend_get_executed_filename();
218 clen = strlen(cfilename);
219 /* check for __COMPILER_HALT_OFFSET__ */
220 haltname = zend_mangle_property_name(haltoff,
221 sizeof("__COMPILER_HALT_OFFSET__") - 1, cfilename, clen, 0);
222 c = zend_hash_find_ptr(EG(zend_constants), haltname);
223 zend_string_free(haltname);
224 return c;
225 } else {
226 return NULL;
227 }
228 }
229
zend_verify_const_access(zend_class_constant * c,zend_class_entry * scope)230 ZEND_API int zend_verify_const_access(zend_class_constant *c, zend_class_entry *scope) /* {{{ */
231 {
232 if (Z_ACCESS_FLAGS(c->value) & ZEND_ACC_PUBLIC) {
233 return 1;
234 } else if (Z_ACCESS_FLAGS(c->value) & ZEND_ACC_PRIVATE) {
235 return (c->ce == scope);
236 } else {
237 ZEND_ASSERT(Z_ACCESS_FLAGS(c->value) & ZEND_ACC_PROTECTED);
238 return zend_check_protected(c->ce, scope);
239 }
240 }
241 /* }}} */
242
zend_get_constant_str(const char * name,size_t name_len)243 ZEND_API zval *zend_get_constant_str(const char *name, size_t name_len)
244 {
245 zend_constant *c;
246 ALLOCA_FLAG(use_heap)
247
248 if ((c = zend_hash_str_find_ptr(EG(zend_constants), name, name_len)) == NULL) {
249 char *lcname = do_alloca(name_len + 1, use_heap);
250 zend_str_tolower_copy(lcname, name, name_len);
251 if ((c = zend_hash_str_find_ptr(EG(zend_constants), lcname, name_len)) != NULL) {
252 if (c->flags & CONST_CS) {
253 c = NULL;
254 }
255 } else {
256 c = zend_get_special_constant(name, name_len);
257 }
258 free_alloca(lcname, use_heap);
259 }
260
261 return c ? &c->value : NULL;
262 }
263
zend_get_constant(zend_string * name)264 ZEND_API zval *zend_get_constant(zend_string *name)
265 {
266 zend_constant *c;
267 ALLOCA_FLAG(use_heap)
268
269 if ((c = zend_hash_find_ptr(EG(zend_constants), name)) == NULL) {
270 char *lcname = do_alloca(ZSTR_LEN(name) + 1, use_heap);
271 zend_str_tolower_copy(lcname, ZSTR_VAL(name), ZSTR_LEN(name));
272 if ((c = zend_hash_str_find_ptr(EG(zend_constants), lcname, ZSTR_LEN(name))) != NULL) {
273 if (c->flags & CONST_CS) {
274 c = NULL;
275 }
276 } else {
277 c = zend_get_special_constant(ZSTR_VAL(name), ZSTR_LEN(name));
278 }
279 free_alloca(lcname, use_heap);
280 }
281
282 return c ? &c->value : NULL;
283 }
284
zend_get_constant_ex(zend_string * cname,zend_class_entry * scope,uint32_t flags)285 ZEND_API zval *zend_get_constant_ex(zend_string *cname, zend_class_entry *scope, uint32_t flags)
286 {
287 zend_constant *c;
288 const char *colon;
289 zend_class_entry *ce = NULL;
290 const char *name = ZSTR_VAL(cname);
291 size_t name_len = ZSTR_LEN(cname);
292
293 /* Skip leading \\ */
294 if (name[0] == '\\') {
295 name += 1;
296 name_len -= 1;
297 cname = NULL;
298 }
299
300 if ((colon = zend_memrchr(name, ':', name_len)) &&
301 colon > name && (*(colon - 1) == ':')) {
302 int class_name_len = colon - name - 1;
303 size_t const_name_len = name_len - class_name_len - 2;
304 zend_string *constant_name = zend_string_init(colon + 1, const_name_len, 0);
305 zend_string *class_name = zend_string_init(name, class_name_len, 0);
306 zend_class_constant *c = NULL;
307 zval *ret_constant = NULL;
308
309 if (zend_string_equals_literal_ci(class_name, "self")) {
310 if (UNEXPECTED(!scope)) {
311 zend_throw_error(NULL, "Cannot access self:: when no class scope is active");
312 goto failure;
313 }
314 ce = scope;
315 } else if (zend_string_equals_literal_ci(class_name, "parent")) {
316 if (UNEXPECTED(!scope)) {
317 zend_throw_error(NULL, "Cannot access parent:: when no class scope is active");
318 goto failure;
319 } else if (UNEXPECTED(!scope->parent)) {
320 zend_throw_error(NULL, "Cannot access parent:: when current class scope has no parent");
321 goto failure;
322 } else {
323 ce = scope->parent;
324 }
325 } else if (zend_string_equals_literal_ci(class_name, "static")) {
326 ce = zend_get_called_scope(EG(current_execute_data));
327 if (UNEXPECTED(!ce)) {
328 zend_throw_error(NULL, "Cannot access static:: when no class scope is active");
329 goto failure;
330 }
331 } else {
332 ce = zend_fetch_class(class_name, flags);
333 }
334 if (ce) {
335 c = zend_hash_find_ptr(&ce->constants_table, constant_name);
336 if (c == NULL) {
337 if ((flags & ZEND_FETCH_CLASS_SILENT) == 0) {
338 zend_throw_error(NULL, "Undefined class constant '%s::%s'", ZSTR_VAL(class_name), ZSTR_VAL(constant_name));
339 goto failure;
340 }
341 ret_constant = NULL;
342 } else {
343 if (!zend_verify_const_access(c, scope)) {
344 if ((flags & ZEND_FETCH_CLASS_SILENT) == 0) {
345 zend_throw_error(NULL, "Cannot access %s const %s::%s", zend_visibility_string(Z_ACCESS_FLAGS(c->value)), ZSTR_VAL(class_name), ZSTR_VAL(constant_name));
346 }
347 goto failure;
348 }
349 ret_constant = &c->value;
350 }
351 }
352
353 if (ret_constant && Z_CONSTANT_P(ret_constant)) {
354 if (Z_TYPE_P(ret_constant) == IS_CONSTANT_AST) {
355 if (IS_CONSTANT_VISITED(ret_constant)) {
356 zend_throw_error(NULL, "Cannot declare self-referencing constant '%s::%s'", ZSTR_VAL(class_name), ZSTR_VAL(constant_name));
357 ret_constant = NULL;
358 goto failure;
359 }
360 MARK_CONSTANT_VISITED(ret_constant);
361 }
362 if (UNEXPECTED(zval_update_constant_ex(ret_constant, c->ce) != SUCCESS)) {
363 RESET_CONSTANT_VISITED(ret_constant);
364 ret_constant = NULL;
365 goto failure;
366 }
367 RESET_CONSTANT_VISITED(ret_constant);
368 }
369 failure:
370 zend_string_release(class_name);
371 zend_string_free(constant_name);
372 return ret_constant;
373 }
374
375 /* non-class constant */
376 if ((colon = zend_memrchr(name, '\\', name_len)) != NULL) {
377 /* compound constant name */
378 int prefix_len = colon - name;
379 size_t const_name_len = name_len - prefix_len - 1;
380 const char *constant_name = colon + 1;
381 char *lcname;
382 size_t lcname_len;
383 ALLOCA_FLAG(use_heap)
384
385 lcname_len = prefix_len + 1 + const_name_len;
386 lcname = do_alloca(lcname_len + 1, use_heap);
387 zend_str_tolower_copy(lcname, name, prefix_len);
388 /* Check for namespace constant */
389
390 lcname[prefix_len] = '\\';
391 memcpy(lcname + prefix_len + 1, constant_name, const_name_len + 1);
392
393 if ((c = zend_hash_str_find_ptr(EG(zend_constants), lcname, lcname_len)) == NULL) {
394 /* try lowercase */
395 zend_str_tolower(lcname + prefix_len + 1, const_name_len);
396 if ((c = zend_hash_str_find_ptr(EG(zend_constants), lcname, lcname_len)) != NULL) {
397 if ((c->flags & CONST_CS) != 0) {
398 c = NULL;
399 }
400 }
401 }
402 free_alloca(lcname, use_heap);
403 if (c) {
404 return &c->value;
405 }
406 /* name requires runtime resolution, need to check non-namespaced name */
407 if ((flags & IS_CONSTANT_UNQUALIFIED) != 0) {
408 return zend_get_constant_str(constant_name, const_name_len);
409 }
410 return NULL;
411 }
412
413 if (cname) {
414 return zend_get_constant(cname);
415 } else {
416 return zend_get_constant_str(name, name_len);
417 }
418 }
419
zend_quick_get_constant(const zval * key,uint32_t flags)420 ZEND_API zend_constant* ZEND_FASTCALL zend_quick_get_constant(const zval *key, uint32_t flags)
421 {
422 zend_constant *c;
423
424 if ((c = zend_hash_find_ptr(EG(zend_constants), Z_STR_P(key))) == NULL) {
425 key++;
426 if ((c = zend_hash_find_ptr(EG(zend_constants), Z_STR_P(key))) == NULL ||
427 (c->flags & CONST_CS) != 0) {
428 if ((flags & (IS_CONSTANT_IN_NAMESPACE|IS_CONSTANT_UNQUALIFIED)) == (IS_CONSTANT_IN_NAMESPACE|IS_CONSTANT_UNQUALIFIED)) {
429 key++;
430 if ((c = zend_hash_find_ptr(EG(zend_constants), Z_STR_P(key))) == NULL) {
431 key++;
432 if ((c = zend_hash_find_ptr(EG(zend_constants), Z_STR_P(key))) == NULL ||
433 (c->flags & CONST_CS) != 0) {
434
435 key--;
436 c = NULL;
437 }
438 }
439 } else {
440 key--;
441 c = NULL;
442 }
443 }
444 }
445 return c;
446 }
447
zend_hash_add_constant(HashTable * ht,zend_string * key,zend_constant * c)448 static void* zend_hash_add_constant(HashTable *ht, zend_string *key, zend_constant *c)
449 {
450 void *ret;
451 zend_constant *copy = pemalloc(sizeof(zend_constant), c->flags & CONST_PERSISTENT);
452
453 memcpy(copy, c, sizeof(zend_constant));
454 ret = zend_hash_add_ptr(ht, key, copy);
455 if (!ret) {
456 pefree(copy, c->flags & CONST_PERSISTENT);
457 }
458 return ret;
459 }
460
zend_register_constant(zend_constant * c)461 ZEND_API int zend_register_constant(zend_constant *c)
462 {
463 zend_string *lowercase_name = NULL;
464 zend_string *name;
465 int ret = SUCCESS;
466
467 #if 0
468 printf("Registering constant for module %d\n", c->module_number);
469 #endif
470
471 if (c->module_number != PHP_USER_CONSTANT) {
472 c->name = zend_new_interned_string(c->name);
473 }
474
475 if (!(c->flags & CONST_CS)) {
476 lowercase_name = zend_string_alloc(ZSTR_LEN(c->name), c->flags & CONST_PERSISTENT);
477 zend_str_tolower_copy(ZSTR_VAL(lowercase_name), ZSTR_VAL(c->name), ZSTR_LEN(c->name));
478 lowercase_name = zend_new_interned_string(lowercase_name);
479 name = lowercase_name;
480 } else {
481 char *slash = strrchr(ZSTR_VAL(c->name), '\\');
482 if (slash) {
483 lowercase_name = zend_string_init(ZSTR_VAL(c->name), ZSTR_LEN(c->name), c->flags & CONST_PERSISTENT);
484 zend_str_tolower(ZSTR_VAL(lowercase_name), slash - ZSTR_VAL(c->name));
485 lowercase_name = zend_new_interned_string(lowercase_name);
486 name = lowercase_name;
487 } else {
488 name = c->name;
489 }
490 }
491
492 /* Check if the user is trying to define the internal pseudo constant name __COMPILER_HALT_OFFSET__ */
493 if ((ZSTR_LEN(c->name) == sizeof("__COMPILER_HALT_OFFSET__")-1
494 && !memcmp(ZSTR_VAL(name), "__COMPILER_HALT_OFFSET__", sizeof("__COMPILER_HALT_OFFSET__")-1))
495 || zend_hash_add_constant(EG(zend_constants), name, c) == NULL) {
496
497 /* The internal __COMPILER_HALT_OFFSET__ is prefixed by NULL byte */
498 if (ZSTR_VAL(c->name)[0] == '\0' && ZSTR_LEN(c->name) > sizeof("\0__COMPILER_HALT_OFFSET__")-1
499 && memcmp(ZSTR_VAL(name), "\0__COMPILER_HALT_OFFSET__", sizeof("\0__COMPILER_HALT_OFFSET__")) == 0) {
500 }
501 zend_error(E_NOTICE,"Constant %s already defined", ZSTR_VAL(name));
502 zend_string_release(c->name);
503 if (!(c->flags & CONST_PERSISTENT)) {
504 zval_dtor(&c->value);
505 }
506 ret = FAILURE;
507 }
508 if (lowercase_name) {
509 zend_string_release(lowercase_name);
510 }
511 return ret;
512 }
513
514
515 /*
516 * Local variables:
517 * tab-width: 4
518 * c-basic-offset: 4
519 * indent-tabs-mode: t
520 * End:
521 * vim600: sw=4 ts=4 fdm=marker
522 * vim<600: sw=4 ts=4
523 */
524
