Req #46367 [Opn]: fputcsv does not add the correct newline character on Windows

From: Date: Wed, 10 Mar 2010 19:41:54 +0000
Subject: Req #46367 [Opn]: fputcsv does not add the correct newline character on Windows
References: 1  Groups: php.bugs 
Request: Send a blank email to php-bugs+get-148479@lists.php.net to get a copy of this message
Edit report at http://bugs.php.net/bug.php?id=46367&edit=1

 ID:               46367
 Updated by:       johannes@php.net
 Reported by:      jmertic@php.net
 Summary:          fputcsv does not add the correct newline character on
                   Windows
 Status:           Open
 Type:             Feature/Change Request
-Package:          Feature/Change Request
+Package:          *General Issues
 Operating System: Windows XP
 PHP Version:      5.2.6

 New Comment:

Applying the "correct" patch means that the resulting file is system
dependent and might break what current users expect. Probably this needs
to be configured (additional parameter?)


Previous Comments:
------------------------------------------------------------------------
[2010-03-10 19:50:50] m_rayman at bigfoot dot com

For such a simple bug, this should have been solved the same week it was
brought to attention...  The correct and tested patch is even included!

------------------------------------------------------------------------
[2009-07-17 11:41:41] chris dot tatedavies at inflightproductions dot
com

How long does the voting last? I need to know if this is going to be
fixed. Or if it has been already. I've looked through the changelog to
no avail. Its been over 8 months since the original report.

Thanks, Chris

------------------------------------------------------------------------
[2008-11-06 13:49:51] jmertic@php.net

Updated earlier patch:

Index: file.c
===================================================================
RCS file: /repository/php-src/ext/standard/file.c,v
retrieving revision 1.530
diff -u -r1.530 file.c
--- file.c	21 Oct 2008 22:06:48 -0000	1.530
+++ file.c	22 Oct 2008 21:21:42 -0000
@@ -2104,7 +2104,7 @@
 		}
 	}
 
-	smart_str_appendc(&csvline, '\n');
+	smart_str_appendl(&csvline, PHP_EOL, sizeof(PHP_EOL));
 	smart_str_0(&csvline);
 
 	ret = php_stream_write(stream, csvline.c, csvline.len);

Also below is a test case for this bug. Should fail currently on
Windows.

--TEST--
Bug #46367 - fputcsv does not add the correct newline character on
Windows
--FILE--
<?php

$array1 = array("a","b","c");
$array2 = array("a","b","c");

$data_file = dirname(__FILE__) . '/dump.txt';
$fp = fopen($data_file);

fputcsv($fp,$array1);
fputcsv($fp,$array2);

fclose($fp);

$csvfile = file_get_contents($data_file);

var_dump(stripos($csvfile,PHP_EOL) !== FALSE);

echo "Done\n";

unlink($data_file);
?>
--EXPECT--
bool(true)
Done

------------------------------------------------------------------------
[2008-10-22 17:00:52] jmertic@php.net

Description:
------------
Per the documentation for the fputcsv() function, it adds a newline to
the end of the csv string it returns. However, it is hardcoded to be
'\n' ( default for unix newline ), while Windows uses \r\n. PHP should
do this as well.

Below is a patch to fix this issue; it uses the constant PHP_EOL to get
the correct newline to use on the current platform:

Index: php-src/ext/standard/file.c
===================================================================
RCS file: /repository/php-src/ext/standard/file.c,v
retrieving revision 1.530
diff -r1.530 file.c
2107c2107
< 	smart_str_appendc(&csvline, '\n');
---
> 	smart_str_appendc(&csvline, PHP_EOL);


Reproduce code:
---------------
$array1 = array("a","b","c");
$array2 = array("d","e","f");

echo fputcsv($array1).fputcsv($array2);

Expected result:
----------------
"a","b","c"
"d","e","f"

Actual result:
--------------
"a","b","c""d","e","f"


------------------------------------------------------------------------



-- 
Edit this bug report at http://bugs.php.net/bug.php?id=46367&edit=1


Thread (7 messages)

« previous php.bugs (#148479) next »