root/ext/standard/assert.c

/* [<][>][^][v][top][bottom][index][help] */

DEFINITIONS

This source file includes following definitions.
  1. ZEND_BEGIN_MODULE_GLOBALS
  2. PHP_INI_MH
  3. PHP_INI_BEGIN
  4. PHP_MINIT_FUNCTION
  5. PHP_MSHUTDOWN_FUNCTION
  6. PHP_RSHUTDOWN_FUNCTION
  7. PHP_MINFO_FUNCTION
  8. PHP_FUNCTION
  9. PHP_FUNCTION

/*
   +----------------------------------------------------------------------+
   | PHP Version 5                                                        |
   +----------------------------------------------------------------------+
   | Copyright (c) 1997-2008 The PHP Group                                |
   +----------------------------------------------------------------------+
   | This source file is subject to version 3.01 of the PHP license,      |
   | that is bundled with this package in the file LICENSE, and is        |
   | available through the world-wide-web at the following url:           |
   | http://www.php.net/license/3_01.txt                                  |
   | If you did not receive a copy of the PHP license and are unable to   |
   | obtain it through the world-wide-web, please send a note to          |
   | license@php.net so we can mail you a copy immediately.               |
   +----------------------------------------------------------------------+
   | Author: Thies C. Arntzen <thies@thieso.net>                          |
   +----------------------------------------------------------------------+
 */

/* $Id: assert.c,v 1.60.2.3.2.7 2007/12/31 07:20:12 sebastian Exp $ */

/* {{{ includes/startup/misc */

#include "php.h"
#include "php_assert.h"
#include "php_ini.h"

ZEND_BEGIN_MODULE_GLOBALS(assert)
        long active;
        long bail;
        long warning;
        long quiet_eval;
        zval *callback;
        char *cb;
ZEND_END_MODULE_GLOBALS(assert)

ZEND_DECLARE_MODULE_GLOBALS(assert)

#ifdef ZTS
#define ASSERTG(v) TSRMG(assert_globals_id, zend_assert_globals *, v)
#else
#define ASSERTG(v) (assert_globals.v)
#endif

#define SAFE_STRING(s) ((s)?(s):"")

enum {
        ASSERT_ACTIVE=1,
        ASSERT_CALLBACK,
        ASSERT_BAIL,
        ASSERT_WARNING,
        ASSERT_QUIET_EVAL
};

static PHP_INI_MH(OnChangeCallback)
{
        if (EG(in_execution)) {
                if (ASSERTG(callback)) {
                        zval_ptr_dtor(&ASSERTG(callback));
                }
                if (new_value && (ASSERTG(callback) || new_value_length)) {
                        MAKE_STD_ZVAL(ASSERTG(callback));
                        ZVAL_STRINGL(ASSERTG(callback), new_value, new_value_length, 1);
                }
        } else {
                if (ASSERTG(cb)) {
                        pefree(ASSERTG(cb), 1);
                }
                if (new_value && new_value_length) {
                        ASSERTG(cb) = pemalloc(new_value_length + 1, 1);
                        memcpy(ASSERTG(cb), new_value, new_value_length);
                        ASSERTG(cb)[new_value_length] = '\0';
                } else {
                        ASSERTG(cb) = NULL;
                }
        }
        return SUCCESS;
}

PHP_INI_BEGIN()
         STD_PHP_INI_ENTRY("assert.active",         "1",        PHP_INI_ALL,    OnUpdateLong,           active,                         zend_assert_globals,            assert_globals)
         STD_PHP_INI_ENTRY("assert.bail",           "0",        PHP_INI_ALL,    OnUpdateLong,           bail,                           zend_assert_globals,            assert_globals)
         STD_PHP_INI_ENTRY("assert.warning",    "1",    PHP_INI_ALL,    OnUpdateLong,           warning,                        zend_assert_globals,            assert_globals)
         PHP_INI_ENTRY    ("assert.callback",   NULL,   PHP_INI_ALL,    OnChangeCallback)
         STD_PHP_INI_ENTRY("assert.quiet_eval", "0",    PHP_INI_ALL,    OnUpdateLong,           quiet_eval,                     zend_assert_globals,            assert_globals)
PHP_INI_END()

static void php_assert_init_globals(zend_assert_globals *assert_globals_p TSRMLS_DC)
{
        assert_globals_p->callback = NULL;
        assert_globals_p->cb = NULL;
}

PHP_MINIT_FUNCTION(assert)
{
        ZEND_INIT_MODULE_GLOBALS(assert, php_assert_init_globals, NULL);

        REGISTER_INI_ENTRIES();

        REGISTER_LONG_CONSTANT("ASSERT_ACTIVE", ASSERT_ACTIVE, CONST_CS|CONST_PERSISTENT);
        REGISTER_LONG_CONSTANT("ASSERT_CALLBACK", ASSERT_CALLBACK, CONST_CS|CONST_PERSISTENT);
        REGISTER_LONG_CONSTANT("ASSERT_BAIL", ASSERT_BAIL, CONST_CS|CONST_PERSISTENT);
        REGISTER_LONG_CONSTANT("ASSERT_WARNING", ASSERT_WARNING, CONST_CS|CONST_PERSISTENT);
        REGISTER_LONG_CONSTANT("ASSERT_QUIET_EVAL", ASSERT_QUIET_EVAL, CONST_CS|CONST_PERSISTENT);

        return SUCCESS;
}

PHP_MSHUTDOWN_FUNCTION(assert)
{
        if (ASSERTG(cb)) {
                pefree(ASSERTG(cb), 1);
                ASSERTG(cb) = NULL;
        }
        return SUCCESS;
}

PHP_RSHUTDOWN_FUNCTION(assert)
{
        if (ASSERTG(callback)) { 
                zval_ptr_dtor(&ASSERTG(callback));
                ASSERTG(callback) = NULL;
        }

        return SUCCESS;
}

PHP_MINFO_FUNCTION(assert)
{
        DISPLAY_INI_ENTRIES();
}

/* }}} */
/* {{{ internal functions */
/* }}} */
/* {{{ proto int assert(string|bool assertion)
   Checks if assertion is false */

PHP_FUNCTION(assert)
{
        zval **assertion;       
        int val;
        char *myeval = NULL;
        char *compiled_string_description;
        
        if (! ASSERTG(active)) {
                RETURN_TRUE;
        }

        if (ZEND_NUM_ARGS() != 1 || zend_get_parameters_ex(1, &assertion) == FAILURE) {
                WRONG_PARAM_COUNT;
        }

        if (Z_TYPE_PP(assertion) == IS_STRING) {
                zval retval;
                int old_error_reporting = 0; /* shut up gcc! */

                myeval = Z_STRVAL_PP(assertion);

                if (ASSERTG(quiet_eval)) {
                        old_error_reporting = EG(error_reporting);
                        EG(error_reporting) = 0;
                }

                compiled_string_description = zend_make_compiled_string_description("assert code" TSRMLS_CC);
                if (zend_eval_string(myeval, &retval, compiled_string_description TSRMLS_CC) == FAILURE) {
                        efree(compiled_string_description);
                        php_error_docref(NULL TSRMLS_CC, E_RECOVERABLE_ERROR, "Failure evaluating code: %s%s", PHP_EOL, myeval);
                        if (ASSERTG(bail)) {
                                zend_bailout();
                        }
                        RETURN_FALSE;
                }
                efree(compiled_string_description);

                if (ASSERTG(quiet_eval)) {
                        EG(error_reporting) = old_error_reporting;
                }

                convert_to_boolean(&retval);
                val = Z_LVAL(retval);
        } else {
                convert_to_boolean_ex(assertion);
                val = Z_LVAL_PP(assertion);
        }

        if (val) {
                RETURN_TRUE;
        }

        if (!ASSERTG(callback) && ASSERTG(cb)) {
                MAKE_STD_ZVAL(ASSERTG(callback));
                ZVAL_STRING(ASSERTG(callback), ASSERTG(cb), 1);
        }

        if (ASSERTG(callback)) {
                zval *args[3];
                zval *retval;
                int i;
                uint lineno = zend_get_executed_lineno(TSRMLS_C);
                char *filename = zend_get_executed_filename(TSRMLS_C);

                MAKE_STD_ZVAL(args[0]);
                MAKE_STD_ZVAL(args[1]);
                MAKE_STD_ZVAL(args[2]);

                ZVAL_STRING(args[0], SAFE_STRING(filename), 1);
                ZVAL_LONG (args[1], lineno);
                ZVAL_STRING(args[2], SAFE_STRING(myeval), 1);
                
                MAKE_STD_ZVAL(retval);
                ZVAL_FALSE(retval);

                /* XXX do we want to check for error here? */
                call_user_function(CG(function_table), NULL, ASSERTG(callback), retval, 3, args TSRMLS_CC);

                for (i = 0; i <= 2; i++) {
                        zval_ptr_dtor(&(args[i]));
                }
                zval_ptr_dtor(&retval);
        }

        if (ASSERTG(warning)) {
                if (myeval) {
                        php_error_docref(NULL TSRMLS_CC, E_WARNING, "Assertion \"%s\" failed", myeval);
                } else {
                        php_error_docref(NULL TSRMLS_CC, E_WARNING, "Assertion failed");
                }
        }

        if (ASSERTG(bail)) {
                zend_bailout();
        }
}

/* }}} */
/* {{{ proto mixed assert_options(int what [, mixed value])
   Set/get the various assert flags */

PHP_FUNCTION(assert_options)
{
        zval **what, **value;
        int oldint;
        int ac = ZEND_NUM_ARGS();
        
        if (ac < 1 || ac > 2 || zend_get_parameters_ex(ac, &what, &value) == FAILURE) {
                WRONG_PARAM_COUNT;
        }

        convert_to_long_ex(what);

        switch (Z_LVAL_PP(what)) {
        case ASSERT_ACTIVE:
                oldint = ASSERTG(active);
                if (ac == 2) {
                        convert_to_long_ex(value);
                        ASSERTG(active) = Z_LVAL_PP(value);
                }
                RETURN_LONG(oldint);
                break;

        case ASSERT_BAIL:
                oldint = ASSERTG(bail);
                if (ac == 2) {
                        convert_to_long_ex(value);
                        ASSERTG(bail) = Z_LVAL_PP(value);
                }
                RETURN_LONG(oldint);
                break;

        case ASSERT_QUIET_EVAL:
                oldint = ASSERTG(quiet_eval);
                if (ac == 2) {
                        convert_to_long_ex(value);
                        ASSERTG(quiet_eval) = Z_LVAL_PP(value);
                }
                RETURN_LONG(oldint);
                break;

        case ASSERT_WARNING:
                oldint = ASSERTG(warning);
                if (ac == 2) {
                        convert_to_long_ex(value);
                        ASSERTG(warning) = Z_LVAL_PP(value);
                }
                RETURN_LONG(oldint);
                break;

        case ASSERT_CALLBACK:
                if (ASSERTG(callback) != NULL) {
                        RETVAL_ZVAL(ASSERTG(callback), 1, 0);
                } else if (ASSERTG(cb)) {
                        RETVAL_STRING(ASSERTG(cb), 1);
                } else {
                        RETVAL_NULL();
                }
                if (ac == 2) {
                        if (ASSERTG(callback)) {
                                zval_ptr_dtor(&ASSERTG(callback));
                        }
                        ASSERTG(callback) = *value;
                        zval_add_ref(value);
                }
                return;
                break;

        default:
                php_error_docref(NULL TSRMLS_CC, E_WARNING, "Unknown value %ld", Z_LVAL_PP(what));
                break;
        }

        RETURN_FALSE;
}

/* }}} */

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

/* [<][>][^][v][top][bottom][index][help] */