PHPC-804: Relax zpp types in Timestamp and UTCDateTime constructors

jmikola · jmikola · commit 8d7e358330cd · 2016-11-23T12:15:37.000-05:00
Changing "s" to "z" in zend_parse_parameters() allows integers to be accepted in strict types mode. If all necessary parameters are integers, we can also skip conversion to a string and back to a 64-bit integer.
diff --git a/src/BSON/Timestamp.c b/src/BSON/Timestamp.c
@@ -140,28 +140,48 @@ static bool php_phongo_timestamp_init_from_hash(php_phongo_timestamp_t *intern,
 	return false;
 }
 
-/* {{{ proto void Timestamp::__construct(string $increment, string $timestamp)
+/* {{{ proto void Timestamp::__construct(int|string $increment, int|string $timestamp)
    Construct a new BSON timestamp type, which consists of a 4-byte increment and
    4-byte timestamp. */
 PHP_METHOD(Timestamp, __construct)
 {
-	php_phongo_timestamp_t    *intern;
-	zend_error_handling       error_handling;
-	char                      *s_increment;
-	phongo_zpp_char_len       s_increment_len;
-	char                      *s_timestamp;
-	phongo_zpp_char_len       s_timestamp_len;
+	php_phongo_timestamp_t *intern;
+	zend_error_handling     error_handling;
+	zval                   *increment = NULL, *timestamp = NULL;
 
 	zend_replace_error_handling(EH_THROW, phongo_exception_from_phongo_domain(PHONGO_ERROR_INVALID_ARGUMENT), &error_handling TSRMLS_CC);
 	intern = Z_TIMESTAMP_OBJ_P(getThis());
 
-	if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "ss", &s_increment, &s_increment_len, &s_timestamp, &s_timestamp_len) == FAILURE) {
+	if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "zz", &increment, &timestamp) == FAILURE) {
 		zend_restore_error_handling(&error_handling TSRMLS_CC);
 		return;
 	}
 	zend_restore_error_handling(&error_handling TSRMLS_CC);
 
-	php_phongo_timestamp_init_from_string(intern, s_increment, s_increment_len, s_timestamp, s_timestamp_len TSRMLS_CC);
+	if (Z_TYPE_P(increment) == IS_LONG && Z_TYPE_P(timestamp) == IS_LONG) {
+		php_phongo_timestamp_init(intern, Z_LVAL_P(increment), Z_LVAL_P(timestamp) TSRMLS_CC);
+		return;
+	}
+
+	if (Z_TYPE_P(increment) == IS_LONG) {
+		convert_to_string(increment);
+	}
+
+	if (Z_TYPE_P(increment) != IS_STRING) {
+		phongo_throw_exception(PHONGO_ERROR_INVALID_ARGUMENT TSRMLS_CC, "Expected increment to be an unsigned 32-bit integer or string, %s given", zend_get_type_by_const(Z_TYPE_P(increment)));
+		return;
+	}
+
+	if (Z_TYPE_P(timestamp) == IS_LONG) {
+		convert_to_string(timestamp);
+	}
+
+	if (Z_TYPE_P(timestamp) != IS_STRING) {
+		phongo_throw_exception(PHONGO_ERROR_INVALID_ARGUMENT TSRMLS_CC, "Expected timestamp to be an unsigned 32-bit integer or string, %s given", zend_get_type_by_const(Z_TYPE_P(timestamp)));
+		return;
+	}
+
+	php_phongo_timestamp_init_from_string(intern, Z_STRVAL_P(increment), Z_STRLEN_P(increment), Z_STRVAL_P(timestamp), Z_STRLEN_P(timestamp) TSRMLS_CC);
 }
 /* }}} */
 
diff --git a/src/BSON/UTCDateTime.c b/src/BSON/UTCDateTime.c
@@ -157,49 +157,54 @@ static bool php_phongo_utcdatetime_init_from_date(php_phongo_utcdatetime_t *inte
 	return true;
 }
 
-/* {{{ proto void UTCDateTime::__construct([string|DateTimeInterface $milliseconds = null])
+/* {{{ proto void UTCDateTime::__construct([int|string|DateTimeInterface $milliseconds = null])
    Construct a new BSON UTCDateTime type from either the current time,
-   milliseconds since the epoch, or a DateTimeInterface object. */
+   milliseconds since the epoch, or a DateTimeInterface object. Defaults to the
+   current time. */
 PHP_METHOD(UTCDateTime, __construct)
 {
 	php_phongo_utcdatetime_t    *intern;
 	zend_error_handling          error_handling;
-	zval                        *datetime = NULL;
+	zval                        *milliseconds = NULL;
 
 	zend_replace_error_handling(EH_THROW, phongo_exception_from_phongo_domain(PHONGO_ERROR_INVALID_ARGUMENT), &error_handling TSRMLS_CC);
 	intern = Z_UTCDATETIME_OBJ_P(getThis());
 
-	if (zend_parse_parameters_ex(ZEND_PARSE_PARAMS_QUIET, ZEND_NUM_ARGS() TSRMLS_CC, "|o!", &datetime) == SUCCESS) {
-		if (datetime == NULL) {
-			php_phongo_utcdatetime_init_from_current_time(intern);
-		} else if (instanceof_function(Z_OBJCE_P(datetime), php_date_get_date_ce() TSRMLS_CC)) {
-			php_phongo_utcdatetime_init_from_date(intern, Z_PHPDATE_P(datetime));
-#if PHP_VERSION_ID >= 50500
-		} else if (instanceof_function(Z_OBJCE_P(datetime), php_date_get_immutable_ce() TSRMLS_CC)) {
-			php_phongo_utcdatetime_init_from_date(intern, Z_PHPDATE_P(datetime));
-#endif
-		} else {
-			phongo_throw_exception(PHONGO_ERROR_INVALID_ARGUMENT TSRMLS_CC, "Expected instance of DateTimeInterface, %s given", ZSTR_VAL(Z_OBJCE_P(datetime)->name));
-		}
-
+	if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|z!", &milliseconds) == FAILURE) {
 		zend_restore_error_handling(&error_handling TSRMLS_CC);
 		return;
 	}
+	zend_restore_error_handling(&error_handling TSRMLS_CC);
 
-	{
-		char                *s_milliseconds;
-		phongo_zpp_char_len  s_milliseconds_len;
+	if (milliseconds == NULL) {
+		php_phongo_utcdatetime_init_from_current_time(intern);
+		return;
+	}
 
-		if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &s_milliseconds, &s_milliseconds_len) == FAILURE) {
-			zend_restore_error_handling(&error_handling TSRMLS_CC);
-			return;
+	if (Z_TYPE_P(milliseconds) == IS_OBJECT) {
+		if (instanceof_function(Z_OBJCE_P(milliseconds), php_date_get_date_ce() TSRMLS_CC)) {
+			php_phongo_utcdatetime_init_from_date(intern, Z_PHPDATE_P(milliseconds));
+#if PHP_VERSION_ID >= 50500
+		} else if (instanceof_function(Z_OBJCE_P(milliseconds), php_date_get_immutable_ce() TSRMLS_CC)) {
+			php_phongo_utcdatetime_init_from_date(intern, Z_PHPDATE_P(milliseconds));
+#endif
+		} else {
+			phongo_throw_exception(PHONGO_ERROR_INVALID_ARGUMENT TSRMLS_CC, "Expected instance of DateTimeInterface, %s given", ZSTR_VAL(Z_OBJCE_P(milliseconds)->name));
 		}
+		return;
+	}
 
-		php_phongo_utcdatetime_init_from_string(intern, s_milliseconds, s_milliseconds_len TSRMLS_CC);
+	if (Z_TYPE_P(milliseconds) == IS_LONG) {
+		php_phongo_utcdatetime_init(intern, Z_LVAL_P(milliseconds));
+		return;
 	}
 
-	zend_restore_error_handling(&error_handling TSRMLS_CC);
+	if (Z_TYPE_P(milliseconds) != IS_STRING) {
+		phongo_throw_exception(PHONGO_ERROR_INVALID_ARGUMENT TSRMLS_CC, "Expected integer or string, %s given", zend_get_type_by_const(Z_TYPE_P(milliseconds)));
+		return;
+	}
 
+	php_phongo_utcdatetime_init_from_string(intern, Z_STRVAL_P(milliseconds), Z_STRLEN_P(milliseconds) TSRMLS_CC);
 }
 /* }}} */
 
diff --git a/tests/bson/bson-timestamp_error-006.phpt b/tests/bson/bson-timestamp_error-006.phpt
@@ -0,0 +1,46 @@
+--TEST--
+MongoDB\BSON\Timestamp constructor requires integer or string arguments
+--FILE--
+<?php
+
+require_once __DIR__ . '/../utils/tools.php';
+
+$invalidValues = [null, 1234.5, true, [], new stdClass];
+
+foreach ($invalidValues as $invalidValue) {
+    echo throws(function() use ($invalidValue) {
+        new MongoDB\BSON\Timestamp($invalidValue, 0);
+    }, 'MongoDB\Driver\Exception\InvalidArgumentException'), "\n";
+}
+
+foreach ($invalidValues as $invalidValue) {
+    echo throws(function() use ($invalidValue) {
+        new MongoDB\BSON\Timestamp(0, $invalidValue);
+    }, 'MongoDB\Driver\Exception\InvalidArgumentException'), "\n";
+}
+
+?>
+===DONE===
+<?php exit(0); ?>
+--EXPECTF--
+OK: Got MongoDB\Driver\Exception\InvalidArgumentException
+Expected increment to be an unsigned 32-bit integer or string, %r(null|NULL)%r given
+OK: Got MongoDB\Driver\Exception\InvalidArgumentException
+Expected increment to be an unsigned 32-bit integer or string, %r(double|float)%r given
+OK: Got MongoDB\Driver\Exception\InvalidArgumentException
+Expected increment to be an unsigned 32-bit integer or string, boolean given
+OK: Got MongoDB\Driver\Exception\InvalidArgumentException
+Expected increment to be an unsigned 32-bit integer or string, array given
+OK: Got MongoDB\Driver\Exception\InvalidArgumentException
+Expected increment to be an unsigned 32-bit integer or string, object given
+OK: Got MongoDB\Driver\Exception\InvalidArgumentException
+Expected timestamp to be an unsigned 32-bit integer or string, %r(null|NULL)%r given
+OK: Got MongoDB\Driver\Exception\InvalidArgumentException
+Expected timestamp to be an unsigned 32-bit integer or string, %r(double|float)%r given
+OK: Got MongoDB\Driver\Exception\InvalidArgumentException
+Expected timestamp to be an unsigned 32-bit integer or string, boolean given
+OK: Got MongoDB\Driver\Exception\InvalidArgumentException
+Expected timestamp to be an unsigned 32-bit integer or string, array given
+OK: Got MongoDB\Driver\Exception\InvalidArgumentException
+Expected timestamp to be an unsigned 32-bit integer or string, object given
+===DONE===
diff --git a/tests/bson/bson-utcdatetime_error-004.phpt b/tests/bson/bson-utcdatetime_error-004.phpt
@@ -0,0 +1,24 @@
+--TEST--
+MongoDB\BSON\UTCDateTime constructor requires integer or string argument
+--FILE--
+<?php
+
+require_once __DIR__ . '/../utils/tools.php';
+
+$invalidValues = [true, []];
+
+foreach ($invalidValues as $invalidValue) {
+    echo throws(function() use ($invalidValue) {
+        new MongoDB\BSON\UTCDateTime($invalidValue);
+    }, 'MongoDB\Driver\Exception\InvalidArgumentException'), "\n";
+}
+
+?>
+===DONE===
+<?php exit(0); ?>
+--EXPECTF--
+OK: Got MongoDB\Driver\Exception\InvalidArgumentException
+Expected integer or string, boolean given
+OK: Got MongoDB\Driver\Exception\InvalidArgumentException
+Expected integer or string, array given
+===DONE===
