Fix some SPL bugs

ext/spl/spl_directory.c

@@ -1892,22 +1892,21 @@ static zend_result spl_filesystem_file_read_ex(spl_filesystem_object *intern, bo
 	}
 
 	if (!buf) {
-		intern->u.file.current_line = estrdup("");
-		intern->u.file.current_line_len = 0;
-	} else {
-		if (SPL_HAS_FLAG(intern->flags, SPL_FILE_OBJECT_DROP_NEW_LINE)) {
-			if (line_len > 0 && buf[line_len - 1] == '\n') {
+		return FAILURE;
+	}
+
+	if (SPL_HAS_FLAG(intern->flags, SPL_FILE_OBJECT_DROP_NEW_LINE)) {
+		if (line_len > 0 && buf[line_len - 1] == '\n') {
+			line_len--;
+			if (line_len > 0 && buf[line_len - 1] == '\r') {
 				line_len--;
-				if (line_len > 0 && buf[line_len - 1] == '\r') {
-					line_len--;
-				}
-				buf[line_len] = '\0';
 			}
+			buf[line_len] = '\0';
 		}
-
-		intern->u.file.current_line = buf;
-		intern->u.file.current_line_len = line_len;
 	}
+
+	intern->u.file.current_line = buf;
+	intern->u.file.current_line_len = line_len;
 	intern->u.file.current_line_num += line_add;
 
 	return SUCCESS;
@@ -1944,7 +1943,7 @@ static zend_result spl_filesystem_file_read_csv(spl_filesystem_object *intern, c
 }
 /* }}} */
 
-static zend_result spl_filesystem_file_read_line_ex(zval * this_ptr, spl_filesystem_object *intern, int silent) /* {{{ */
+static zend_result spl_filesystem_file_read_line_ex(zval * this_ptr, spl_filesystem_object *intern, bool silent) /* {{{ */
 {
 	zval retval;
 
@@ -1980,6 +1979,7 @@ static zend_result spl_filesystem_file_read_line_ex(zval * this_ptr, spl_filesys
 		spl_filesystem_file_free_line(intern);
 		intern->u.file.current_line = estrndup(Z_STRVAL(retval), Z_STRLEN(retval));
 		intern->u.file.current_line_len = Z_STRLEN(retval);
+		intern->u.file.lines_to_catch_up = 0;
 		zval_ptr_dtor(&retval);
 		return SUCCESS;
 	} else {
@@ -2026,7 +2026,7 @@ static bool spl_filesystem_file_is_empty_line(spl_filesystem_object *intern) /*
 }
 /* }}} */
 
-static zend_result spl_filesystem_file_read_line(zval * this_ptr, spl_filesystem_object *intern, int silent) /* {{{ */
+static zend_result spl_filesystem_file_read_line(zval * this_ptr, spl_filesystem_object *intern, bool silent) /* {{{ */
 {
 	zend_result ret = spl_filesystem_file_read_line_ex(this_ptr, intern, silent);
 
@@ -2047,12 +2047,14 @@ static void spl_filesystem_file_rewind(zval * this_ptr, spl_filesystem_object *i
 	}
 	if (-1 == php_stream_rewind(intern->u.file.stream)) {
 		zend_throw_exception_ex(spl_ce_RuntimeException, 0, "Cannot rewind file %s", ZSTR_VAL(intern->file_name));
-	} else {
-		spl_filesystem_file_free_line(intern);
-		intern->u.file.current_line_num = 0;
+		return;
 	}
+
+	spl_filesystem_file_free_line(intern);
+	intern->u.file.current_line_num = 0;
+	intern->u.file.lines_to_catch_up = 0;
 	if (SPL_HAS_FLAG(intern->flags, SPL_FILE_OBJECT_READ_AHEAD)) {
-		spl_filesystem_file_read_line(this_ptr, intern, 1);
+		spl_filesystem_file_read_line(this_ptr, intern, /* silent */ true);
 	}
 } /* }}} */
 
@@ -2191,6 +2193,8 @@ PHP_METHOD(SplFileObject, fgets)
 	if (spl_filesystem_file_read_ex(intern, /* silent */ false, /* line_add */ 1) == FAILURE) {
 		RETURN_THROWS();
 	}
+	/* Inform current() that it needs to catch up a line */
+	intern->u.file.lines_to_catch_up++;
 	RETURN_STRINGL(intern->u.file.current_line, intern->u.file.current_line_len);
 } /* }}} */
 
@@ -2205,8 +2209,18 @@ PHP_METHOD(SplFileObject, current)
 
 	CHECK_SPL_FILE_OBJECT_IS_INITIALIZED(intern);
 
+	/* No lines have been read yet (rewind or just opened file) */
 	if (!intern->u.file.current_line && Z_ISUNDEF(intern->u.file.current_zval)) {
-		spl_filesystem_file_read_line(ZEND_THIS, intern, 1);
+		spl_filesystem_file_read_line(ZEND_THIS, intern, /* silent */ true);
+	}
+	/* next() of fgets() has been called and we need to read the line which is now pointed at */
+	if (intern->u.file.lines_to_catch_up > 0) {
+		ZEND_ASSERT(intern->u.file.current_line || !Z_ISUNDEF(intern->u.file.current_zval));
+		for (; 0 < intern->u.file.lines_to_catch_up; intern->u.file.lines_to_catch_up--) {
+			/* Free fetched line */
+			spl_filesystem_file_free_line(intern);
+			spl_filesystem_file_read_line(ZEND_THIS, intern, /* silent */ true);
+		}
 	}
 	if (intern->u.file.current_line && (!SPL_HAS_FLAG(intern->flags, SPL_FILE_OBJECT_READ_CSV) || Z_ISUNDEF(intern->u.file.current_zval))) {
 		RETURN_STRINGL(intern->u.file.current_line, intern->u.file.current_line_len);
@@ -2228,7 +2242,7 @@ PHP_METHOD(SplFileObject, key)
 
 	/* Do not read the next line to support correct counting with fgetc()
 	if (!intern->u.file.current_line) {
-		spl_filesystem_file_read_line(ZEND_THIS, intern, 1);
+		spl_filesystem_file_read_line(ZEND_THIS, intern, silent true);
 	} */
 	RETURN_LONG(intern->u.file.current_line_num);
 } /* }}} */
@@ -2242,9 +2256,11 @@ PHP_METHOD(SplFileObject, next)
 		RETURN_THROWS();
 	}
 
-	spl_filesystem_file_free_line(intern);
 	if (SPL_HAS_FLAG(intern->flags, SPL_FILE_OBJECT_READ_AHEAD)) {
-		spl_filesystem_file_read_line(ZEND_THIS, intern, 1);
+		spl_filesystem_file_free_line(intern);
+		spl_filesystem_file_read_line(ZEND_THIS, intern, /* silent */ true);
+	} else {
+		intern->u.file.lines_to_catch_up++;
 	}
 	intern->u.file.current_line_num++;
 } /* }}} */
@@ -2743,7 +2759,7 @@ PHP_METHOD(SplFileObject, seek)
 	spl_filesystem_file_rewind(ZEND_THIS, intern);
 
 	for (i = 0; i < line_pos; i++) {
-		if (spl_filesystem_file_read_line(ZEND_THIS, intern, 1) == FAILURE) {
+		if (spl_filesystem_file_read_line(ZEND_THIS, intern, /* silent */ true) == FAILURE) {
 			return;
 		}
 	}

ext/spl/spl_directory.h

@@ -85,7 +85,8 @@ struct _spl_filesystem_object {
 			char               *current_line;
 			size_t             current_line_len;
 			size_t             max_line_len;
-			zend_long               current_line_num;
+			zend_long          current_line_num;
+			zend_long          lines_to_catch_up;
 			zval               zresource;
 			zend_function      *func_getCurr;
 			char               delimiter;

ext/spl/tests/SplFileObject/SplFileObject_fgetcsv_basic.phpt

@@ -14,7 +14,6 @@ fclose($fp);
 $fo = new SplFileObject('SplFileObject__fgetcsv1.csv');
 var_dump($fo->fgetcsv());
 var_dump($fo->fgetcsv());
-var_dump($fo->fgetcsv());
 ?>
 --CLEAN--
 <?php
@@ -31,8 +30,4 @@ array(4) {
   [3]=>
   string(1) "5"
 }
-array(1) {
-  [0]=>
-  NULL
-}
 bool(false)

ext/spl/tests/SplFileObject/SplFileObject_key_error001.phpt

@@ -18,5 +18,5 @@ var_dump($s->key());
 var_dump($s->valid());
 ?>
 --EXPECT--
-int(14)
+int(12)
 bool(false)

ext/spl/tests/SplFileObject/SplFileObject_key_error002.phpt

@@ -18,5 +18,5 @@ var_dump($s->key());
 var_dump($s->valid());
 ?>
 --EXPECT--
-int(13)
+int(12)
 bool(false)

ext/spl/tests/SplFileObject/fileobject_001.phpt

@@ -70,7 +70,7 @@ string(1) "4"
 int(5)
 string(1) "5"
 int(6)
-string(0) ""
+bool(false)
 ===B===
 int(0)
 string(1) "0"

ext/spl/tests/SplFileObject/gh8561.phpt

@@ -0,0 +1,22 @@
+--TEST--
+Bug GH-8561: SplFileObject: key() and current() unsinchronized after call to fgets()
+--FILE--
+<?php
+$file = new SplTempFileObject();
+
+// write to file
+for ($i = 0; $i < 5; $i++) {
+    $file->fwrite("line {$i}" . PHP_EOL);
+}
+
+$file->rewind();
+
+// read first line
+$file->fgets();
+
+// where am I?
+echo $file->key(), ': ', $file->current();
+
+?>
+--EXPECT--
+1: line 1

ext/spl/tests/SplFileObject/gh8562.phpt

@@ -0,0 +1,22 @@
+--TEST--
+Bug GH-8562: SplFileObject: current() returns wrong result after call to next()
+--FILE--
+<?php
+$file = new SplTempFileObject();
+
+// write to file
+for ($i = 0; $i < 5; $i++) {
+    $file->fwrite("line {$i}" . PHP_EOL);
+}
+
+$file->rewind();
+
+$file->next();
+echo $file->key(), ': ', $file->current();
+$file->next();
+echo $file->key(), ': ', $file->current();
+
+?>
+--EXPECT--
+1: line 1
+2: line 2

ext/spl/tests/SplFileObject/gh8563.phpt

@@ -0,0 +1,48 @@
+--TEST--
+Bug GH-8563: Different results for seek() on SplFileObject and SplTempFileObject
+--FILE--
+<?php
+
+const LINES = 5;
+const INDEX = 10;
+
+$file_01 = new SplFileObject(__DIR__ . '/gh8563.txt', 'w+');
+$file_02 = new SplTempFileObject(-1);
+$file_03 = new SplTempFileObject(0);
+$file_04 = new SplTempFileObject();
+
+// write to files
+for ($i = 0; $i < LINES; $i++) {
+    $file_01->fwrite("line {$i}" . PHP_EOL);
+    $file_02->fwrite("line {$i}" . PHP_EOL);
+    $file_03->fwrite("line {$i}" . PHP_EOL);
+    $file_04->fwrite("line {$i}" . PHP_EOL);
+}
+
+// reset
+$file_01->rewind();
+$file_02->rewind();
+$file_03->rewind();
+$file_04->rewind();
+
+// seek
+$file_01->seek(INDEX);
+$file_02->seek(INDEX);
+$file_03->seek(INDEX);
+$file_04->seek(INDEX);
+
+// show results
+echo 'file_01: ' . $file_01->key(), PHP_EOL;
+echo 'file_02: ' . $file_02->key(), PHP_EOL;
+echo 'file_03: ' . $file_03->key(), PHP_EOL;
+echo 'file_04: ' . $file_04->key(), PHP_EOL;
+?>
+--CLEAN--
+<?php
+unlink(__DIR__ . '/gh8563.txt');
+?>
+--EXPECT--
+file_01: 4
+file_02: 4
+file_03: 4
+file_04: 4

ext/spl/tests/bug81477.phpt

@@ -21,7 +21,6 @@ string(8) "baz,bat
 "
 string(10) "more,data
 "
-string(0) ""
 --CLEAN--
 <?php
 @unlink(__DIR__ . '/bug81477.csv');