phar: Fix broken return value of fflush() for phar file entries

ndossche · ndossche · commit 2f9d86b67787 · 2025-11-15T13:56:06.000+01:00
The flush functions always return EOF, even in the success path. The success path should return 0 to indicate success. Closes phpGH-20474.
diff --git a/NEWS b/NEWS
@@ -21,6 +21,7 @@ PHP                                                                        NEWS
 - Phar:
   . Fixed bug GH-20442 (Phar does not respect case-insensitiveness of
     __halt_compiler() when reading stub). (ndossche, TimWolla)
+  . Fix broken return value of fflush() for phar file entries. (ndossche)
 
 - PHPDBG:
   . Fixed ZPP type violation in phpdbg_get_executable() and phpdbg_end_oplog().
diff --git a/ext/phar/phar.c b/ext/phar/phar.c
@@ -3225,7 +3225,7 @@ int phar_flush(phar_archive_data *phar, char *user_stub, zend_long len, int conv
 		return EOF;
 	}
 
-	return EOF;
+	return 0;
 
 cleanup:
 	if (shared_cfp != NULL) {
diff --git a/ext/phar/tar.c b/ext/phar/tar.c
@@ -1378,6 +1378,6 @@ int phar_tar_flush(phar_archive_data *phar, char *user_stub, zend_long len, int
 			php_stream_close(newfile);
 		}
 	}
-	return EOF;
+	return 0;
 }
 /* }}} */
diff --git a/ext/phar/tests/fflush_phar_file_report_success.phpt b/ext/phar/tests/fflush_phar_file_report_success.phpt
@@ -0,0 +1,25 @@
+--TEST--
+fflush() on phar file should report success
+--EXTENSIONS--
+phar
+--INI--
+phar.readonly=0
+--FILE--
+<?php
+
+$phar = new Phar(__DIR__.'/fflush_phar_file_report_success.phar');
+$phar->addFromString('test', 'contents');
+unset($phar);
+
+$f = fopen('phar://' . __DIR__.'/fflush_phar_file_report_success.phar/test', 'w');
+var_dump(fflush($f));
+var_dump(fclose($f));
+
+?>
+--CLEAN--
+<?php
+@unlink(__DIR__.'/fflush_phar_file_report_success.phar');
+?>
+--EXPECT--
+bool(true)
+bool(true)
diff --git a/ext/phar/zip.c b/ext/phar/zip.c
@@ -1542,6 +1542,6 @@ int phar_zip_flush(phar_archive_data *phar, char *user_stub, zend_long len, int
 	if (closeoldfile) {
 		php_stream_close(oldfile);
 	}
-	return EOF;
+	return 0;
 }
 /* }}} */

Original file line number	Diff line number	Diff line change
`@@ -3225,7 +3225,7 @@ int phar_flush(phar_archive_data phar, char user_stub, zend_long len, int conv`
`3225`	`3225`	`return EOF;`
`3226`	`3226`	`}`
`3227`	`3227`
`3228`		`- return EOF;`
	`3228`	`+ return 0;`
`3229`	`3229`
`3230`	`3230`	`cleanup:`
`3231`	`3231`	`if (shared_cfp != NULL) {`
Original file line number	Diff line number	Diff line change
`@@ -1378,6 +1378,6 @@ int phar_tar_flush(phar_archive_data phar, char user_stub, zend_long len, int`
`1378`	`1378`	`php_stream_close(newfile);`
`1379`	`1379`	`}`
`1380`	`1380`	`}`
`1381`		`- return EOF;`
	`1381`	`+ return 0;`
`1382`	`1382`	`}`
`1383`	`1383`	`/* }}} */`
Original file line number	Diff line number	Diff line change
`@@ -1542,6 +1542,6 @@ int phar_zip_flush(phar_archive_data phar, char user_stub, zend_long len, int`
`1542`	`1542`	`if (closeoldfile) {`
`1543`	`1543`	`php_stream_close(oldfile);`
`1544`	`1544`	`}`
`1545`		`- return EOF;`
	`1545`	`+ return 0;`
`1546`	`1546`	`}`
`1547`	`1547`	`/* }}} */`