Skip to content

Consistent error handling for fgetcsv/fputcsv #6188

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

Consistent error handling for fgetcsv/fputcsv #6188

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 18 additions & 21 deletions ext/spl/spl_directory.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2328,13 +2328,12 @@ PHP_METHOD(SplFileObject, fgetcsv)

CHECK_SPL_FILE_OBJECT_IS_INITIALIZED(intern);

// TODO Align behaviour on normal fgetcsv()
switch(ZEND_NUM_ARGS())
{
case 3:
if (esc_len > 1) {
php_error_docref(NULL, E_WARNING, "escape must be empty or a single character");
RETURN_FALSE;
zend_argument_value_error(3, "must be empty or a single character");
RETURN_THROWS();
}
if (esc_len == 0) {
escape = PHP_CSV_NO_ESCAPE;
Expand All @@ -2344,15 +2343,15 @@ PHP_METHOD(SplFileObject, fgetcsv)
/* no break */
case 2:
if (e_len != 1) {
php_error_docref(NULL, E_WARNING, "enclosure must be a character");
RETURN_FALSE;
zend_argument_value_error(2, "must be a single character");
RETURN_THROWS();
}
enclosure = enclo[0];
/* no break */
case 1:
if (d_len != 1) {
php_error_docref(NULL, E_WARNING, "delimiter must be a character");
RETURN_FALSE;
zend_argument_value_error(1, "must be a single character");
RETURN_THROWS();
}
delimiter = delim[0];
/* no break */
Expand All @@ -2377,7 +2376,6 @@ PHP_METHOD(SplFileObject, fputcsv)

if (zend_parse_parameters(ZEND_NUM_ARGS(), "a|sss", &fields, &delim, &d_len, &enclo, &e_len, &esc, &esc_len) == SUCCESS) {

// TODO Align behaviour on normal fputcsv()
switch(ZEND_NUM_ARGS())
{
case 4:
Expand All @@ -2389,21 +2387,21 @@ PHP_METHOD(SplFileObject, fputcsv)
escape = (unsigned char) esc[0];
break;
default:
php_error_docref(NULL, E_WARNING, "escape must be empty or a single character");
RETURN_FALSE;
zend_argument_value_error(4, "must be empty or a single character");
RETURN_THROWS();
}
/* no break */
case 3:
if (e_len != 1) {
php_error_docref(NULL, E_WARNING, "enclosure must be a character");
RETURN_FALSE;
zend_argument_value_error(3, "must be a single character");
RETURN_THROWS();
}
enclosure = enclo[0];
/* no break */
case 2:
if (d_len != 1) {
php_error_docref(NULL, E_WARNING, "delimiter must be a character");
RETURN_FALSE;
zend_argument_value_error(2, "must be a single character");
RETURN_THROWS();
}
delimiter = delim[0];
/* no break */
Expand All @@ -2430,7 +2428,6 @@ PHP_METHOD(SplFileObject, setCsvControl)
size_t d_len = 0, e_len = 0, esc_len = 0;

if (zend_parse_parameters(ZEND_NUM_ARGS(), "|sss", &delim, &d_len, &enclo, &e_len, &esc, &esc_len) == SUCCESS) {
// TODO Align behaviour on normal fgetcsv()
switch(ZEND_NUM_ARGS())
{
case 3:
Expand All @@ -2442,21 +2439,21 @@ PHP_METHOD(SplFileObject, setCsvControl)
escape = (unsigned char) esc[0];
break;
default:
php_error_docref(NULL, E_WARNING, "escape must be empty or a single character");
RETURN_FALSE;
zend_argument_value_error(3, "must be empty or a single character");
RETURN_THROWS();
}
/* no break */
case 2:
if (e_len != 1) {
php_error_docref(NULL, E_WARNING, "enclosure must be a character");
RETURN_FALSE;
zend_argument_value_error(2, "must be a single character");
RETURN_THROWS();
}
enclosure = enclo[0];
/* no break */
case 1:
if (d_len != 1) {
php_error_docref(NULL, E_WARNING, "delimiter must be a character");
RETURN_FALSE;
zend_argument_value_error(1, "must be a single character");
RETURN_THROWS();
}
delimiter = delim[0];
/* no break */
Expand Down
11 changes: 7 additions & 4 deletions ext/spl/tests/SplFileObject_fgetcsv_delimiter_error.phpt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,15 @@ fputcsv($fp, array(
fclose($fp);

$fo = new SplFileObject('SplFileObject__fgetcsv3.csv');
var_dump($fo->fgetcsv('invalid'));
try {
var_dump($fo->fgetcsv('invalid'));
} catch (ValueError $e) {
echo $e->getMessage(), "\n";
}
?>
--CLEAN--
<?php
unlink('SplFileObject__fgetcsv3.csv');
?>
--EXPECTF--
Warning: SplFileObject::fgetcsv(): delimiter must be a character in %s on line %d
bool(false)
--EXPECT--
SplFileObject::fgetcsv(): Argument #1 ($delimiter) must be a single character
11 changes: 7 additions & 4 deletions ext/spl/tests/SplFileObject_fgetcsv_enclosure_error.phpt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,15 @@ fputcsv($fp, array(
fclose($fp);

$fo = new SplFileObject('SplFileObject__fgetcsv5.csv');
var_dump($fo->fgetcsv(',', 'invalid'));
try {
var_dump($fo->fgetcsv(',', 'invalid'));
} catch (ValueError $e) {
echo $e->getMessage(), "\n";
}
?>
--CLEAN--
<?php
unlink('SplFileObject__fgetcsv5.csv');
?>
--EXPECTF--
Warning: SplFileObject::fgetcsv(): enclosure must be a character in %s on line %d
bool(false)
--EXPECT--
SplFileObject::fgetcsv(): Argument #2 ($enclosure) must be a single character
11 changes: 7 additions & 4 deletions ext/spl/tests/SplFileObject_fgetcsv_escape_error.phpt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,15 @@ fwrite($fp, '"aaa","b""bb","ccc"');
fclose($fp);

$fo = new SplFileObject('SplFileObject__fgetcsv8.csv');
var_dump($fo->fgetcsv(',', '"', 'invalid'));
try {
var_dump($fo->fgetcsv(',', '"', 'invalid'));
} catch (ValueError $e) {
echo $e->getMessage(), "\n";
}
?>
--CLEAN--
<?php
unlink('SplFileObject__fgetcsv8.csv');
?>
--EXPECTF--
Warning: SplFileObject::fgetcsv(): escape must be empty or a single character in %s on line %d
bool(false)
--EXPECT--
SplFileObject::fgetcsv(): Argument #3 ($escape) must be empty or a single character
12 changes: 7 additions & 5 deletions ext/spl/tests/SplFileObject_fputcsv_variation13.phpt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,11 @@ echo "*** Testing fputcsv() : with default enclosure & delimiter of two chars **

$fo = new SplFileObject(__DIR__ . '/SplFileObject_fputcsv_variation13.csv', 'w');

var_dump($fo->fputcsv(array('water', 'fruit'), ',,', '"'));
try {
var_dump($fo->fputcsv(array('water', 'fruit'), ',,', '"'));
} catch (ValueError $e) {
echo $e->getMessage(), "\n";
}

unset($fo);

Expand All @@ -21,9 +25,7 @@ echo "Done\n";
$file = __DIR__ . '/SplFileObject_fputcsv_variation13.csv';
unlink($file);
?>
--EXPECTF--
--EXPECT--
*** Testing fputcsv() : with default enclosure & delimiter of two chars ***

Warning: SplFileObject::fputcsv(): delimiter must be a character in %s on line %d
bool(false)
SplFileObject::fputcsv(): Argument #2 ($delimiter) must be a single character
Done
12 changes: 7 additions & 5 deletions ext/spl/tests/SplFileObject_fputcsv_variation14.phpt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,11 @@ echo "*** Testing fputcsv() : with enclosure & delimiter of two chars and file o

$fo = new SplFileObject(__DIR__ . '/SplFileObject_fputcsv_variation14.csv', 'w');

var_dump($fo->fputcsv(array('water', 'fruit'), ',,', '""'));
try {
var_dump($fo->fputcsv(array('water', 'fruit'), ',,', '""'));
} catch (ValueError $e) {
echo $e->getMessage(), "\n";
}

unset($fo);

Expand All @@ -21,9 +25,7 @@ echo "Done\n";
$file = __DIR__ . '/SplFileObject_fputcsv_variation14.csv';
unlink($file);
?>
--EXPECTF--
--EXPECT--
*** Testing fputcsv() : with enclosure & delimiter of two chars and file opened in read mode ***

Warning: SplFileObject::fputcsv(): enclosure must be a character in %s on line %d
bool(false)
SplFileObject::fputcsv(): Argument #3 ($enclosure) must be a single character
Done
10 changes: 7 additions & 3 deletions ext/spl/tests/SplFileObject_setCsvControl_error001.phpt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,15 @@ CDATA
);
$s = new SplFileObject('csv_control_data_error001.csv');
$s->setFlags(SplFileObject::READ_CSV);
$s->setCsvControl('||');
try {
$s->setCsvControl('||');
} catch (ValueError $e) {
echo $e->getMessage(), "\n";
}
?>
--CLEAN--
<?php
unlink('csv_control_data_error001.csv');
?>
--EXPECTF--
Warning: SplFileObject::setCsvControl(): delimiter must be a character in %s on line %d
--EXPECT--
SplFileObject::setCsvControl(): Argument #1 ($delimiter) must be a single character
10 changes: 7 additions & 3 deletions ext/spl/tests/SplFileObject_setCsvControl_error002.phpt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,15 @@ CDATA
);
$s = new SplFileObject('csv_control_data_error002.csv');
$s->setFlags(SplFileObject::READ_CSV);
$s->setCsvControl('|', 'two');
try {
$s->setCsvControl('|', 'two');
} catch (ValueError $e) {
echo $e->getMessage(), "\n";
}
?>
--CLEAN--
<?php
unlink('csv_control_data_error002.csv');
?>
--EXPECTF--
Warning: SplFileObject::setCsvControl(): enclosure must be a character in %s on line %d
--EXPECT--
SplFileObject::setCsvControl(): Argument #2 ($enclosure) must be a single character
10 changes: 7 additions & 3 deletions ext/spl/tests/SplFileObject_setCsvControl_error003.phpt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,15 @@ CDATA
);
$s = new SplFileObject('csv_control_data_error003.csv');
$s->setFlags(SplFileObject::READ_CSV);
$s->setCsvControl('|', '\'', 'three');
try {
$s->setCsvControl('|', '\'', 'three');
} catch (ValueError $e) {
echo $e->getMessage(), "\n";
}
?>
--CLEAN--
<?php
unlink('csv_control_data_error003.csv');
?>
--EXPECTF--
Warning: SplFileObject::setCsvControl(): escape must be empty or a single character in %s on line %d
--EXPECT--
SplFileObject::setCsvControl(): Argument #3 ($escape) must be empty or a single character
22 changes: 8 additions & 14 deletions ext/standard/file.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1815,31 +1815,28 @@ PHP_FUNCTION(fputcsv)

if (delimiter_str != NULL) {
/* Make sure that there is at least one character in string */
if (delimiter_str_len < 1) {
if (delimiter_str_len != 1) {
zend_argument_value_error(3, "must be a single character");
RETURN_THROWS();
} else if (delimiter_str_len > 1) {
php_error_docref(NULL, E_WARNING, "Argument #3 ($delimiter) must be a single character");
}

/* use first character from string */
delimiter = *delimiter_str;
}

if (enclosure_str != NULL) {
if (enclosure_str_len < 1) {
if (enclosure_str_len != 1) {
zend_argument_value_error(4, "must be a single character");
RETURN_THROWS();
} else if (enclosure_str_len > 1) {
php_error_docref(NULL, E_WARNING, "Argument #4 ($enclosure) must be a single character");
}
/* use first character from string */
enclosure = *enclosure_str;
}

if (escape_str != NULL) {
if (escape_str_len > 1) {
php_error_docref(NULL, E_WARNING, "Argument #5 ($escape) must be empty or a single character");
zend_argument_value_error(5, "must be empty or a single character");
RETURN_THROWS();
}
if (escape_str_len < 1) {
escape_char = PHP_CSV_NO_ESCAPE;
Expand Down Expand Up @@ -1953,23 +1950,19 @@ PHP_FUNCTION(fgetcsv)

if (delimiter_str != NULL) {
/* Make sure that there is at least one character in string */
if (delimiter_str_len < 1) {
if (delimiter_str_len != 1) {
zend_argument_value_error(3, "must be a single character");
RETURN_THROWS();
} else if (delimiter_str_len > 1) {
php_error_docref(NULL, E_WARNING, "Argument #3 ($delimiter) must be a single character");
}

/* use first character from string */
delimiter = delimiter_str[0];
}

if (enclosure_str != NULL) {
if (enclosure_str_len < 1) {
if (enclosure_str_len != 1) {
zend_argument_value_error(4, "must be a single character");
RETURN_THROWS();
} else if (enclosure_str_len > 1) {
php_error_docref(NULL, E_WARNING, "Argument #4 ($enclosure) must be a single character");
}

/* use first character from string */
Expand All @@ -1978,7 +1971,8 @@ PHP_FUNCTION(fgetcsv)

if (escape_str != NULL) {
if (escape_str_len > 1) {
php_error_docref(NULL, E_WARNING, "Argument #5 ($enclosure) must be empty or a single character");
zend_argument_value_error(5, "must be empty or a single character");
RETURN_THROWS();
}

if (escape_str_len < 1) {
Expand Down
Loading