Deprecate Phar::setStub(resource $stub, int $length)

Author: kocsismate

ext/phar/phar_object.c

@@ -2871,6 +2871,13 @@ PHP_METHOD(Phar, setStub)
 	}
 
 	if (zend_parse_parameters_ex(ZEND_PARSE_PARAMS_QUIET, ZEND_NUM_ARGS(), "r|l", &zstub, &len) == SUCCESS) {
+		zend_string *method_name = get_active_function_or_method_name();
+		zend_error(E_DEPRECATED, "Calling %s(resource $stub, int $length) is deprecated", ZSTR_VAL(method_name));
+		zend_string_release(method_name);
+		if (UNEXPECTED(EG(exception))) {
+			RETURN_THROWS();
+		}
+
 		if ((php_stream_from_zval_no_verify(stream, zstub)) != NULL) {
 			if (len > 0) {
 				len = -len;

ext/phar/tests/cache_list/copyonwrite10.phar.phpt

@@ -8,7 +8,7 @@ phar.readonly=0
 phar
 --FILE_EXTERNAL--
 files/write10.phar
---EXPECT--
+--EXPECTF--
 string(214) "<?php
 $p = new Phar(__FILE__);
 var_dump($p->getStub());
@@ -19,6 +19,8 @@ echo $p2->getStub(),"\n";
 echo "ok\n";
 __HALT_COMPILER(); ?>
 "
+
+Deprecated: Calling Phar::setStub(resource $stub, int $length) is deprecated in %s on line %d
 <?php __HALT_COMPILER(); ?>
 
 ok

ext/phar/tests/phar_stub.phpt

@@ -55,6 +55,24 @@ echo file_get_contents($fname2) . "\n";
 $fp = fopen($fname2, 'rb');
 
 //// 4
+set_error_handler(function ($severity, $message, $file, $line) {
+    throw new Exception($message);
+});
+try {
+    $phar->setStub($fp);
+} catch (Exception $e) {
+    echo $e->getMessage() . "\n";
+}
+set_error_handler(null);
+fclose($fp);
+
+$fp = fopen($fname, 'rb');
+echo fread($fp, strlen($file)) . "\n";
+fclose($fp);
+
+$fp = fopen($fname2, 'rb');
+
+//// 5
 $phar->setStub($fp, strlen($file));
 fclose($fp);
 
@@ -81,10 +99,16 @@ unlink(__DIR__ . '/' . basename(__FILE__, '.clean.php') . '.phar.php');
 unlink(__DIR__ . '/' . basename(__FILE__, '.clean.php') . '.phartmp.php');
 __HALT_COMPILER();
 ?>
---EXPECT--
+--EXPECTF--
 <?php echo "first stub\n"; __HALT_COMPILER(); ?>
 <?php echo "second stub\n"; __HALT_COMPILER(); ?>
+
+Deprecated: Calling Phar::setStub(resource $stub, int $length) is deprecated in %s on line %d
 <?php echo "third stub\n"; __HALT_COMPILER(); ?>
 <?php echo "third stub\n"; __HALT_COMPILER(); ?>booya
+Calling Phar::setStub(resource $stub, int $length) is deprecated
+<?php echo "third stub\n"; __HALT_COMPILER(); ?>
+
+Deprecated: Calling Phar::setStub(resource $stub, int $length) is deprecated in %s on line %d
 <?php echo "third stub\n"; __HALT_COMPILER(); ?>
 <?php echo "third stub\n"; __HALT_COMPILER(); ?>

ext/phar/tests/phar_stub_write_file.phpt

@@ -47,10 +47,12 @@ var_dump($phar->getStub() == $sexp);
 unlink(__DIR__ . '/' . basename(__FILE__, '.clean.php') . '.phar.php');
 __HALT_COMPILER();
 ?>
---EXPECT--
+--EXPECTF--
 string(48) "<?php echo "first stub\n"; __HALT_COMPILER(); ?>"
 string(48) "<?php echo "first stub\n"; __HALT_COMPILER(); ?>"
 bool(true)
+
+Deprecated: Calling Phar::setStub(resource $stub, int $length) is deprecated in %s on line %d
 string(51) "<?php echo "second stub\n"; __HALT_COMPILER(); ?>
 "
 bool(false)

ext/phar/tests/tar/phar_stub.phpt

@@ -64,10 +64,14 @@ unlink(__DIR__ . '/' . basename(__FILE__, '.clean.php') . '.2.phar.tar.php');
 unlink(__DIR__ . '/' . basename(__FILE__, '.clean.php') . '.phartmp.php');
 __HALT_COMPILER();
 ?>
---EXPECT--
+--EXPECTF--
 <?php echo "first stub\n"; __HALT_COMPILER(); ?>
 <?php echo "second stub\n"; __HALT_COMPILER(); ?>
+
+Deprecated: Calling Phar::setStub(resource $stub, int $length) is deprecated in %s on line %d
 <?php echo "third stub\n"; __HALT_COMPILER(); ?>
 <?php echo "third stub\n"; __HALT_COMPILER(); ?>booya
+
+Deprecated: Calling Phar::setStub(resource $stub, int $length) is deprecated in %s on line %d
 <?php echo "third stub\n"; __HALT_COMPILER(); ?>
 <?php echo "third stub\n"; __HALT_COMPILER(); ?>

ext/phar/tests/zip/phar_begin_setstub_commit.phpt

@@ -60,7 +60,11 @@ string(5) "Hello"
 string(5) "World"
 string(%d) "<?php var_dump("Second"); Phar::mapPhar("phar_begin_setstub_commit.phar"); __HALT_COMPILER(); ?>
 "
+
+Deprecated: Calling Phar::setStub(resource $stub, int $length) is deprecated in %s on line %d
 string(%d) "<?php var_dump("First resource"); Phar::mapPhar("phar_begin_setstub_commit.phar"); __HALT_COMPILER(); ?>
 "
+
+Deprecated: Calling Phar::setStub(resource $stub, int $length) is deprecated in %s on line %d
 string(%d) "<?php var_dump("First resource"); Phar::mapPhar("phar_begin_setstub_commit.phar"); __HALT_COMPILER(); ?>
 "

ext/phar/tests/zip/phar_stub.phpt

@@ -64,10 +64,14 @@ unlink(__DIR__ . '/' . basename(__FILE__, '.clean.php') . '.2.phar.zip.php');
 unlink(__DIR__ . '/' . basename(__FILE__, '.clean.php') . '.phartmp.php');
 __HALT_COMPILER();
 ?>
---EXPECT--
+--EXPECTF--
 <?php echo "first stub\n"; __HALT_COMPILER(); ?>
 <?php echo "second stub\n"; __HALT_COMPILER(); ?>
+
+Deprecated: Calling Phar::setStub(resource $stub, int $length) is deprecated in %s on line %d
 <?php echo "third stub\n"; __HALT_COMPILER(); ?>
 <?php echo "third stub\n"; __HALT_COMPILER(); ?>booya
+
+Deprecated: Calling Phar::setStub(resource $stub, int $length) is deprecated in %s on line %d
 <?php echo "third stub\n"; __HALT_COMPILER(); ?>
 <?php echo "third stub\n"; __HALT_COMPILER(); ?>