summaryrefslogtreecommitdiff
path: root/ext/spl/spl_directory.h
diff options
context:
space:
mode:
authorChristoph M. Becker <cmbecker69@gmx.de>2018-12-02 16:28:18 +0100
committerChristoph M. Becker <cmbecker69@gmx.de>2018-12-15 14:38:15 +0100
commit3b0f05119383fe21ee75adaed3d0239ba8976aef (patch)
tree5bbad1d4dbf64e4f8b00eaadf05eca03066917b0 /ext/spl/spl_directory.h
parentd206630f13812ba63cf62765d4731149700125e3 (diff)
downloadphp-git-3b0f05119383fe21ee75adaed3d0239ba8976aef.tar.gz
Allow empty $escape to eschew escaping CSV
Albeit CSV is still a widespread data exchange format, it has never been officially standardized. There exists, however, the “informational” RFC 4180[1] which has no notion of escape characters, but rather defines `escaped` as strings enclosed in double-quotes where contained double-quotes have to be doubled. While this concept is supported by PHP's implementation (`$enclosure`), the `$escape` sometimes interferes, so that `fgetcsv()` is unable to correctly parse externally generated CSV, and `fputcsv()` is sometimes generating non-compliant CSV. Since PHP's `$escape` concept is availble for many years, we cannot drop it for BC reasons (even though many consider it as bug). Instead we allow to pass an empty string as `$escape` parameter to the respective functions, which results in ignoring/omitting any escaping, and as such is more inline with RFC 4180. It is noteworthy that this is almost no userland BC break, since formerly most functions did not accept an empty string, and failed in this case. The only exception was `str_getcsv()` which did accept an empty string, and used a backslash as escape character then (which appears to be unintended behavior, anyway). The changed functions are `fputcsv()`, `fgetcsv()` and `str_getcsv()`, and also the `::setCsvControl()`, `::getCsvControl()`, `::fputcsv()`, and `::fgetcsv()` methods of `SplFileObject`. The implementation also changes the type of the escape parameter of the PHP_APIs `php_fgetcsv()` and `php_fputcsv()` from `char` to `int`, where `PHP_CSV_NO_ESCAPE` means to ignore/omit escaping. The parameter accepts the same values as `isalpha()` and friends, i.e. “the value of which shall be representable as an `unsigned char` or shall equal the value of the macro `EOF`. If the argument has any other value, the behavior is undefined.” This is a subtle BC break, since the character `chr(128)` has the value `-1` if `char` is signed, and so likely would be confused with `EOF` when converted to `int`. We consider this BC break to be acceptable, since it's rather unlikely that anybody uses `chr(128)` as escape character, and it easily can be fixed by casting all `escape` arguments to `unsigned char`. This patch implements the feature requests 38301[2] and 51496[3]. [1] <https://tools.ietf.org/html/rfc4180> [2] <https://bugs.php.net/bug.php?id=38301> [3] <https://bugs.php.net/bug.php?id=51496>
Diffstat (limited to 'ext/spl/spl_directory.h')
-rw-r--r--ext/spl/spl_directory.h2
1 files changed, 1 insertions, 1 deletions
diff --git a/ext/spl/spl_directory.h b/ext/spl/spl_directory.h
index 2bbdadfe6d..d4dcfcbc20 100644
--- a/ext/spl/spl_directory.h
+++ b/ext/spl/spl_directory.h
@@ -96,7 +96,7 @@ struct _spl_filesystem_object {
zend_function *func_getCurr;
char delimiter;
char enclosure;
- char escape;
+ int escape;
} file;
} u;
zend_object std;