1 /*
2 +----------------------------------------------------------------------+
3 | PHP Version 7 |
4 +----------------------------------------------------------------------+
5 | Copyright (c) 1997-2017 The PHP Group |
6 +----------------------------------------------------------------------+
7 | This source file is subject to version 3.01 of the PHP 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.php.net/license/3_01.txt |
11 | If you did not receive a copy of the PHP license and are unable to |
12 | obtain it through the world-wide-web, please send a note to |
13 | license@php.net so we can mail you a copy immediately. |
14 +----------------------------------------------------------------------+
15 | Author: Thies C. Arntzen <thies@thieso.net> |
16 +----------------------------------------------------------------------+
17 */
18
19 /* $Id$ */
20
21 /* {{{ includes */
22 #include "php.h"
23 #include "php_assert.h"
24 #include "php_ini.h"
25 #include "zend_exceptions.h"
26 /* }}} */
27
28 ZEND_BEGIN_MODULE_GLOBALS(assert)
29 zval callback;
30 char *cb;
31 zend_bool active;
32 zend_bool bail;
33 zend_bool warning;
34 zend_bool quiet_eval;
35 zend_bool exception;
36 ZEND_END_MODULE_GLOBALS(assert)
37
38 ZEND_DECLARE_MODULE_GLOBALS(assert)
39
40 static zend_class_entry *assertion_error_ce;
41
42 #define ASSERTG(v) ZEND_MODULE_GLOBALS_ACCESSOR(assert, v)
43
44 #define SAFE_STRING(s) ((s)?(s):"")
45
46 enum {
47 ASSERT_ACTIVE=1,
48 ASSERT_CALLBACK,
49 ASSERT_BAIL,
50 ASSERT_WARNING,
51 ASSERT_QUIET_EVAL,
52 ASSERT_EXCEPTION
53 };
54
PHP_INI_MH(OnChangeCallback)55 static PHP_INI_MH(OnChangeCallback) /* {{{ */
56 {
57 if (EG(current_execute_data)) {
58 if (Z_TYPE(ASSERTG(callback)) != IS_UNDEF) {
59 zval_ptr_dtor(&ASSERTG(callback));
60 ZVAL_UNDEF(&ASSERTG(callback));
61 }
62 if (new_value && (Z_TYPE(ASSERTG(callback)) != IS_UNDEF || ZSTR_LEN(new_value))) {
63 ZVAL_STR_COPY(&ASSERTG(callback), new_value);
64 }
65 } else {
66 if (ASSERTG(cb)) {
67 pefree(ASSERTG(cb), 1);
68 }
69 if (new_value && ZSTR_LEN(new_value)) {
70 ASSERTG(cb) = pemalloc(ZSTR_LEN(new_value) + 1, 1);
71 memcpy(ASSERTG(cb), ZSTR_VAL(new_value), ZSTR_LEN(new_value));
72 ASSERTG(cb)[ZSTR_LEN(new_value)] = '\0';
73 } else {
74 ASSERTG(cb) = NULL;
75 }
76 }
77 return SUCCESS;
78 }
79 /* }}} */
80
81 PHP_INI_BEGIN()
82 STD_PHP_INI_ENTRY("assert.active", "1", PHP_INI_ALL, OnUpdateBool, active, zend_assert_globals, assert_globals)
83 STD_PHP_INI_ENTRY("assert.bail", "0", PHP_INI_ALL, OnUpdateBool, bail, zend_assert_globals, assert_globals)
84 STD_PHP_INI_ENTRY("assert.warning", "1", PHP_INI_ALL, OnUpdateBool, warning, zend_assert_globals, assert_globals)
85 PHP_INI_ENTRY("assert.callback", NULL, PHP_INI_ALL, OnChangeCallback)
86 STD_PHP_INI_ENTRY("assert.quiet_eval", "0", PHP_INI_ALL, OnUpdateBool, quiet_eval, zend_assert_globals, assert_globals)
87 STD_PHP_INI_ENTRY("assert.exception", "0", PHP_INI_ALL, OnUpdateBool, exception, zend_assert_globals, assert_globals)
PHP_INI_END()88 PHP_INI_END()
89
90 static void php_assert_init_globals(zend_assert_globals *assert_globals_p) /* {{{ */
91 {
92 ZVAL_UNDEF(&assert_globals_p->callback);
93 assert_globals_p->cb = NULL;
94 }
95 /* }}} */
96
PHP_MINIT_FUNCTION(assert)97 PHP_MINIT_FUNCTION(assert) /* {{{ */
98 {
99 zend_class_entry ce;
100
101 ZEND_INIT_MODULE_GLOBALS(assert, php_assert_init_globals, NULL);
102
103 REGISTER_INI_ENTRIES();
104
105 REGISTER_LONG_CONSTANT("ASSERT_ACTIVE", ASSERT_ACTIVE, CONST_CS|CONST_PERSISTENT);
106 REGISTER_LONG_CONSTANT("ASSERT_CALLBACK", ASSERT_CALLBACK, CONST_CS|CONST_PERSISTENT);
107 REGISTER_LONG_CONSTANT("ASSERT_BAIL", ASSERT_BAIL, CONST_CS|CONST_PERSISTENT);
108 REGISTER_LONG_CONSTANT("ASSERT_WARNING", ASSERT_WARNING, CONST_CS|CONST_PERSISTENT);
109 REGISTER_LONG_CONSTANT("ASSERT_QUIET_EVAL", ASSERT_QUIET_EVAL, CONST_CS|CONST_PERSISTENT);
110 REGISTER_LONG_CONSTANT("ASSERT_EXCEPTION", ASSERT_EXCEPTION, CONST_CS|CONST_PERSISTENT);
111
112 INIT_CLASS_ENTRY(ce, "AssertionError", NULL);
113 assertion_error_ce = zend_register_internal_class_ex(&ce, zend_ce_error);
114
115 return SUCCESS;
116 }
117 /* }}} */
118
PHP_MSHUTDOWN_FUNCTION(assert)119 PHP_MSHUTDOWN_FUNCTION(assert) /* {{{ */
120 {
121 if (ASSERTG(cb)) {
122 pefree(ASSERTG(cb), 1);
123 ASSERTG(cb) = NULL;
124 }
125 return SUCCESS;
126 }
127 /* }}} */
128
PHP_RSHUTDOWN_FUNCTION(assert)129 PHP_RSHUTDOWN_FUNCTION(assert) /* {{{ */
130 {
131 if (Z_TYPE(ASSERTG(callback)) != IS_UNDEF) {
132 zval_ptr_dtor(&ASSERTG(callback));
133 ZVAL_UNDEF(&ASSERTG(callback));
134 }
135
136 return SUCCESS;
137 }
138 /* }}} */
139
PHP_MINFO_FUNCTION(assert)140 PHP_MINFO_FUNCTION(assert) /* {{{ */
141 {
142 DISPLAY_INI_ENTRIES();
143 }
144 /* }}} */
145
146 /* {{{ proto int assert(string|bool assertion[, mixed description])
147 Checks if assertion is false */
PHP_FUNCTION(assert)148 PHP_FUNCTION(assert)
149 {
150 zval *assertion;
151 zval *description = NULL;
152 int val;
153 char *myeval = NULL;
154 char *compiled_string_description;
155
156 if (! ASSERTG(active)) {
157 RETURN_TRUE;
158 }
159
160 if (zend_parse_parameters(ZEND_NUM_ARGS(), "z|z", &assertion, &description) == FAILURE) {
161 return;
162 }
163
164 if (Z_TYPE_P(assertion) == IS_STRING) {
165 zval retval;
166 int old_error_reporting = 0; /* shut up gcc! */
167 zend_class_entry *orig_scope = EG(scope);
168
169 myeval = Z_STRVAL_P(assertion);
170
171 if (ASSERTG(quiet_eval)) {
172 old_error_reporting = EG(error_reporting);
173 EG(error_reporting) = 0;
174 }
175
176 compiled_string_description = zend_make_compiled_string_description("assert code");
177 if (zend_eval_stringl(myeval, Z_STRLEN_P(assertion), &retval, compiled_string_description) == FAILURE) {
178 efree(compiled_string_description);
179 if (!description) {
180 php_error_docref(NULL, E_RECOVERABLE_ERROR, "Failure evaluating code: %s%s", PHP_EOL, myeval);
181 } else {
182 zend_string *str = zval_get_string(description);
183 php_error_docref(NULL, E_RECOVERABLE_ERROR, "Failure evaluating code: %s%s:\"%s\"", PHP_EOL, ZSTR_VAL(str), myeval);
184 zend_string_release(str);
185 }
186 if (ASSERTG(bail)) {
187 zend_bailout();
188 }
189 RETURN_FALSE;
190 }
191 efree(compiled_string_description);
192
193 if (ASSERTG(quiet_eval)) {
194 EG(error_reporting) = old_error_reporting;
195 }
196
197 EG(scope) = orig_scope;
198
199 convert_to_boolean(&retval);
200 val = Z_TYPE(retval) == IS_TRUE;
201 } else {
202 val = zend_is_true(assertion);
203 }
204
205 if (val) {
206 RETURN_TRUE;
207 }
208
209 if (Z_TYPE(ASSERTG(callback)) == IS_UNDEF && ASSERTG(cb)) {
210 ZVAL_STRING(&ASSERTG(callback), ASSERTG(cb));
211 }
212
213 if (Z_TYPE(ASSERTG(callback)) != IS_UNDEF) {
214 zval *args = safe_emalloc(!description ? 3 : 4, sizeof(zval), 0);
215 zval retval;
216 int i;
217 uint lineno = zend_get_executed_lineno();
218 const char *filename = zend_get_executed_filename();
219
220 ZVAL_STRING(&args[0], SAFE_STRING(filename));
221 ZVAL_LONG (&args[1], lineno);
222 ZVAL_STRING(&args[2], SAFE_STRING(myeval));
223
224 ZVAL_FALSE(&retval);
225
226 /* XXX do we want to check for error here? */
227 if (!description) {
228 call_user_function(CG(function_table), NULL, &ASSERTG(callback), &retval, 3, args);
229 for (i = 0; i <= 2; i++) {
230 zval_ptr_dtor(&(args[i]));
231 }
232 } else {
233 ZVAL_STR(&args[3], zval_get_string(description));
234 call_user_function(CG(function_table), NULL, &ASSERTG(callback), &retval, 4, args);
235 for (i = 0; i <= 3; i++) {
236 zval_ptr_dtor(&(args[i]));
237 }
238 }
239
240 efree(args);
241 zval_ptr_dtor(&retval);
242 }
243
244 if (ASSERTG(exception)) {
245 if (!description) {
246 zend_throw_exception(assertion_error_ce, NULL, E_ERROR);
247 } else if (Z_TYPE_P(description) == IS_OBJECT &&
248 instanceof_function(Z_OBJCE_P(description), zend_ce_throwable)) {
249 Z_ADDREF_P(description);
250 zend_throw_exception_object(description);
251 } else {
252 zend_string *str = zval_get_string(description);
253 zend_throw_exception(assertion_error_ce, ZSTR_VAL(str), E_ERROR);
254 zend_string_release(str);
255 }
256 } else if (ASSERTG(warning)) {
257 if (!description) {
258 if (myeval) {
259 php_error_docref(NULL, E_WARNING, "Assertion \"%s\" failed", myeval);
260 } else {
261 php_error_docref(NULL, E_WARNING, "Assertion failed");
262 }
263 } else {
264 zend_string *str = zval_get_string(description);
265 if (myeval) {
266 php_error_docref(NULL, E_WARNING, "%s: \"%s\" failed", ZSTR_VAL(str), myeval);
267 } else {
268 php_error_docref(NULL, E_WARNING, "%s failed", ZSTR_VAL(str));
269 }
270 zend_string_release(str);
271 }
272 }
273
274 if (ASSERTG(bail)) {
275 zend_bailout();
276 }
277
278 RETURN_FALSE;
279 }
280 /* }}} */
281
282 /* {{{ proto mixed assert_options(int what [, mixed value])
283 Set/get the various assert flags */
PHP_FUNCTION(assert_options)284 PHP_FUNCTION(assert_options)
285 {
286 zval *value = NULL;
287 zend_long what;
288 zend_bool oldint;
289 int ac = ZEND_NUM_ARGS();
290 zend_string *key;
291
292 if (zend_parse_parameters(ac, "l|z", &what, &value) == FAILURE) {
293 return;
294 }
295
296 switch (what) {
297 case ASSERT_ACTIVE:
298 oldint = ASSERTG(active);
299 if (ac == 2) {
300 zend_string *value_str = zval_get_string(value);
301 key = zend_string_init("assert.active", sizeof("assert.active")-1, 0);
302 zend_alter_ini_entry_ex(key, value_str, PHP_INI_USER, PHP_INI_STAGE_RUNTIME, 0);
303 zend_string_release(key);
304 zend_string_release(value_str);
305 }
306 RETURN_LONG(oldint);
307 break;
308
309 case ASSERT_BAIL:
310 oldint = ASSERTG(bail);
311 if (ac == 2) {
312 zend_string *value_str = zval_get_string(value);
313 key = zend_string_init("assert.bail", sizeof("assert.bail")-1, 0);
314 zend_alter_ini_entry_ex(key, value_str, PHP_INI_USER, PHP_INI_STAGE_RUNTIME, 0);
315 zend_string_release(key);
316 zend_string_release(value_str);
317 }
318 RETURN_LONG(oldint);
319 break;
320
321 case ASSERT_QUIET_EVAL:
322 oldint = ASSERTG(quiet_eval);
323 if (ac == 2) {
324 zend_string *value_str = zval_get_string(value);
325 key = zend_string_init("assert.quiet_eval", sizeof("assert.quiet_eval")-1, 0);
326 zend_alter_ini_entry_ex(key, value_str, PHP_INI_USER, PHP_INI_STAGE_RUNTIME, 0);
327 zend_string_release(key);
328 zend_string_release(value_str);
329 }
330 RETURN_LONG(oldint);
331 break;
332
333 case ASSERT_WARNING:
334 oldint = ASSERTG(warning);
335 if (ac == 2) {
336 zend_string *value_str = zval_get_string(value);
337 key = zend_string_init("assert.warning", sizeof("assert.warning")-1, 0);
338 zend_alter_ini_entry_ex(key, value_str, PHP_INI_USER, PHP_INI_STAGE_RUNTIME, 0);
339 zend_string_release(key);
340 zend_string_release(value_str);
341 }
342 RETURN_LONG(oldint);
343 break;
344
345 case ASSERT_CALLBACK:
346 if (Z_TYPE(ASSERTG(callback)) != IS_UNDEF) {
347 ZVAL_COPY(return_value, &ASSERTG(callback));
348 } else if (ASSERTG(cb)) {
349 RETVAL_STRING(ASSERTG(cb));
350 } else {
351 RETVAL_NULL();
352 }
353 if (ac == 2) {
354 zval_ptr_dtor(&ASSERTG(callback));
355 ZVAL_COPY(&ASSERTG(callback), value);
356 }
357 return;
358
359 case ASSERT_EXCEPTION:
360 oldint = ASSERTG(exception);
361 if (ac == 2) {
362 zend_string *key = zend_string_init("assert.exception", sizeof("assert.exception")-1, 0);
363 zend_string *val = zval_get_string(value);
364 zend_alter_ini_entry_ex(key, val, PHP_INI_USER, PHP_INI_STAGE_RUNTIME, 0);
365 zend_string_release(val);
366 zend_string_release(key);
367 }
368 RETURN_LONG(oldint);
369 break;
370
371 default:
372 php_error_docref(NULL, E_WARNING, "Unknown value %pd", what);
373 break;
374 }
375
376 RETURN_FALSE;
377 }
378 /* }}} */
379
380 /*
381 * Local variables:
382 * tab-width: 4
383 * c-basic-offset: 4
384 * End:
385 * vim600: sw=4 ts=4 fdm=marker
386 * vim<600: sw=4 ts=4
387 */
388
389
