Deprecate MT_RAND_PHP (php#11560)

TimWolla · web-flow · commit 61251093ab5b · 2023-07-07T12:16:48.000+02:00
see https://wiki.php.net/rfc/deprecations_php_8_3#mt_rand_php
diff --git a/NEWS b/NEWS
@@ -15,6 +15,9 @@ PHP                                                                        NEWS
 - OpenSSL
   . Added support for additional EC parameters in openssl_pkey_new. (Eno-CN)
 
+- Random
+  . Deprecate MT_RAND_PHP. (timwolla)
+
 06 Jul 2023, PHP 8.3.0alpha3
 
 - Core:
diff --git a/UPGRADING b/UPGRADING
@@ -116,6 +116,10 @@ PHP 8.3 UPGRADE NOTES
   . The U_MULTIPLE_DECIMAL_SEP*E*RATORS constant had been deprecated, using
     the U_MULTIPLE_DECIMAL_SEP*A*RATORS instead is recommended.
 
+- Random
+  . The MT_RAND_PHP Mt19937 variant is deprecated.
+    RFC: https://wiki.php.net/rfc/deprecations_php_8_3#mt_rand_php
+
 - SQLite3
   . Using exceptions is now preferred, warnings will be removed in the future.
     Calling SQLite3::enableExceptions(false) will trigger a depreciation warning
diff --git a/ext/random/engine_mt19937.c b/ext/random/engine_mt19937.c
@@ -264,6 +264,7 @@ PHP_METHOD(Random_Engine_Mt19937, __construct)
 			state->mode = MT_RAND_MT19937;
 			break;
 		case MT_RAND_PHP:
+			zend_error(E_DEPRECATED, "The MT_RAND_PHP variant of Mt19937 is deprecated");
 			state->mode = MT_RAND_PHP;
 			break;
 		default:
diff --git a/ext/random/random.c b/ext/random/random.c
@@ -488,6 +488,11 @@ PHP_FUNCTION(mt_srand)
 
 	state->mode = mode;
 
+	/* Anything that is not MT_RAND_MT19937 was interpreted as MT_RAND_PHP. */
+	if (state->mode != MT_RAND_MT19937) {
+		zend_error(E_DEPRECATED, "The MT_RAND_PHP variant of Mt19937 is deprecated");
+	}
+
 	if (seed_is_null) {
 		php_random_mt19937_seed_default(status->state);
 	} else {
diff --git a/ext/random/random.stub.php b/ext/random/random.stub.php
@@ -10,6 +10,7 @@
     const MT_RAND_MT19937 = UNKNOWN;
     /**
      * @var int
+     * @deprecated
      * @cvalue MT_RAND_PHP
      */
     const MT_RAND_PHP = UNKNOWN;
diff --git a/ext/random/random_arginfo.h b/ext/random/random_arginfo.h
diff --git a/ext/random/tests/01_functions/array_rand_mt_rand_php.phpt b/ext/random/tests/01_functions/array_rand_mt_rand_php.phpt
@@ -24,6 +24,9 @@ var_dump(
 );
 ?>
 --EXPECTF--
+Deprecated: Constant MT_RAND_PHP is deprecated in %s on line %d
+
+Deprecated: The MT_RAND_PHP variant of Mt19937 is deprecated in %s on line %d
 string(11) "found key 0"
 string(11) "found key 1"
 string(11) "found key 0"
diff --git a/ext/random/tests/01_functions/bug75514.phpt b/ext/random/tests/01_functions/bug75514.phpt
@@ -5,6 +5,9 @@ Bug #75514 mt_rand returns value outside [$min,$max]
 mt_srand(0, MT_RAND_PHP);
 var_dump(mt_rand(0,999999999), mt_rand(0,999));
 ?>
---EXPECT--
+--EXPECTF--
+Deprecated: Constant MT_RAND_PHP is deprecated in %s on line %d
+
+Deprecated: The MT_RAND_PHP variant of Mt19937 is deprecated in %s on line %d
 int(448865905)
 int(592)
diff --git a/ext/random/tests/01_functions/mt_rand_value.phpt b/ext/random/tests/01_functions/mt_rand_value.phpt
@@ -37,7 +37,10 @@ echo $x.PHP_EOL;
  */
 
 ?>
---EXPECT--
+--EXPECTF--
+Deprecated: Constant MT_RAND_PHP is deprecated in %s on line %d
+
+Deprecated: The MT_RAND_PHP variant of Mt19937 is deprecated in %s on line %d
 1614640687
 1711027313
 857485497
diff --git a/ext/random/tests/03_randomizer/compatibility_mt_rand.phpt b/ext/random/tests/03_randomizer/compatibility_mt_rand.phpt
@@ -43,7 +43,15 @@ for ($i = 0; $i < 10_000; $i++) {
 die('success');
 
 ?>
---EXPECT--
+--EXPECTF--
 MT_RAND_PHP
+
+Deprecated: Constant MT_RAND_PHP is deprecated in %s on line %d
+
+Deprecated: The MT_RAND_PHP variant of Mt19937 is deprecated in %s on line %d
+
+Deprecated: Constant MT_RAND_PHP is deprecated in %s on line %d
+
+Deprecated: The MT_RAND_PHP variant of Mt19937 is deprecated in %s on line %d
 MT_RAND_MT19937
 success
diff --git a/ext/random/tests/03_randomizer/methods/getBytes.phpt b/ext/random/tests/03_randomizer/methods/getBytes.phpt
@@ -37,7 +37,10 @@ foreach ($engines as $engine) {
 die('success');
 
 ?>
---EXPECT--
+--EXPECTF--
+Deprecated: Constant MT_RAND_PHP is deprecated in %s on line %d
+
+Deprecated: The MT_RAND_PHP variant of Mt19937 is deprecated in %s on line %d
 Random\Engine\Mt19937
 Random\Engine\Mt19937
 Random\Engine\PcgOneseq128XslRr64
diff --git a/ext/random/tests/03_randomizer/methods/getBytesFromString.phpt b/ext/random/tests/03_randomizer/methods/getBytesFromString.phpt
@@ -41,7 +41,10 @@ foreach ($engines as $engine) {
 die('success');
 
 ?>
---EXPECT--
+--EXPECTF--
+Deprecated: Constant MT_RAND_PHP is deprecated in %s on line %d
+
+Deprecated: The MT_RAND_PHP variant of Mt19937 is deprecated in %s on line %d
 Random\Engine\Mt19937
 string(10) "aaaaaaaaaa"
 string(5) "aaaaa"
diff --git a/ext/random/tests/03_randomizer/methods/getFloat.phpt b/ext/random/tests/03_randomizer/methods/getFloat.phpt
@@ -40,7 +40,10 @@ foreach ($engines as $engine) {
 die('success');
 
 ?>
---EXPECT--
+--EXPECTF--
+Deprecated: Constant MT_RAND_PHP is deprecated in %s on line %d
+
+Deprecated: The MT_RAND_PHP variant of Mt19937 is deprecated in %s on line %d
 Random\Engine\Mt19937
 Random\Engine\Mt19937
 Random\Engine\PcgOneseq128XslRr64
diff --git a/ext/random/tests/03_randomizer/methods/getInt.phpt b/ext/random/tests/03_randomizer/methods/getInt.phpt
@@ -44,7 +44,10 @@ foreach ($engines as $engine) {
 die('success');
 
 ?>
---EXPECT--
+--EXPECTF--
+Deprecated: Constant MT_RAND_PHP is deprecated in %s on line %d
+
+Deprecated: The MT_RAND_PHP variant of Mt19937 is deprecated in %s on line %d
 Random\Engine\Mt19937
 Random\Engine\Mt19937
 Random\Engine\PcgOneseq128XslRr64
diff --git a/ext/random/tests/03_randomizer/methods/nextFloat.phpt b/ext/random/tests/03_randomizer/methods/nextFloat.phpt
@@ -39,7 +39,10 @@ foreach ($engines as $engine) {
 die('success');
 
 ?>
---EXPECT--
+--EXPECTF--
+Deprecated: Constant MT_RAND_PHP is deprecated in %s on line %d
+
+Deprecated: The MT_RAND_PHP variant of Mt19937 is deprecated in %s on line %d
 Random\Engine\Mt19937
 Random\Engine\Mt19937
 Random\Engine\PcgOneseq128XslRr64
diff --git a/ext/random/tests/03_randomizer/methods/nextInt.phpt b/ext/random/tests/03_randomizer/methods/nextInt.phpt
@@ -40,7 +40,10 @@ foreach ($engines as $engine) {
 die('success');
 
 ?>
---EXPECT--
+--EXPECTF--
+Deprecated: Constant MT_RAND_PHP is deprecated in %s on line %d
+
+Deprecated: The MT_RAND_PHP variant of Mt19937 is deprecated in %s on line %d
 Random\Engine\Mt19937
 Random\Engine\Mt19937
 Random\Engine\PcgOneseq128XslRr64
diff --git a/ext/random/tests/03_randomizer/methods/pickArrayKeys.phpt b/ext/random/tests/03_randomizer/methods/pickArrayKeys.phpt
@@ -74,7 +74,10 @@ foreach ($engines as $engine) {
 die('success');
 
 ?>
---EXPECT--
+--EXPECTF--
+Deprecated: Constant MT_RAND_PHP is deprecated in %s on line %d
+
+Deprecated: The MT_RAND_PHP variant of Mt19937 is deprecated in %s on line %d
 Random\Engine\Mt19937
 Random\Engine\Mt19937
 Random\Engine\PcgOneseq128XslRr64
diff --git a/ext/random/tests/03_randomizer/methods/shuffleArray.phpt b/ext/random/tests/03_randomizer/methods/shuffleArray.phpt
@@ -43,7 +43,10 @@ foreach ($engines as $engine) {
 die('success');
 
 ?>
---EXPECT--
+--EXPECTF--
+Deprecated: Constant MT_RAND_PHP is deprecated in %s on line %d
+
+Deprecated: The MT_RAND_PHP variant of Mt19937 is deprecated in %s on line %d
 Random\Engine\Mt19937
 Random\Engine\Mt19937
 Random\Engine\PcgOneseq128XslRr64
diff --git a/ext/random/tests/03_randomizer/methods/shuffleBytes.phpt b/ext/random/tests/03_randomizer/methods/shuffleBytes.phpt
@@ -50,7 +50,10 @@ foreach ($engines as $engine) {
 die('success');
 
 ?>
---EXPECT--
+--EXPECTF--
+Deprecated: Constant MT_RAND_PHP is deprecated in %s on line %d
+
+Deprecated: The MT_RAND_PHP variant of Mt19937 is deprecated in %s on line %d
 Random\Engine\Mt19937
 Random\Engine\Mt19937
 Random\Engine\PcgOneseq128XslRr64
diff --git a/ext/random/tests/03_randomizer/serialize.phpt b/ext/random/tests/03_randomizer/serialize.phpt
@@ -41,7 +41,10 @@ foreach ($engines as $engine) {
 
 die('success');
 ?>
---EXPECT--
+--EXPECTF--
+Deprecated: Constant MT_RAND_PHP is deprecated in %s on line %d
+
+Deprecated: The MT_RAND_PHP variant of Mt19937 is deprecated in %s on line %d
 Random\Engine\Mt19937
 Random\Engine\Mt19937
 Random\Engine\PcgOneseq128XslRr64
