Skip to content

Safe casting functions #874

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 26 commits into from
Closed

Safe casting functions #874

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
0de1e1a
toInt(), toFloat() and toString() safe casting functions
hikari-no-yume Oct 5, 2014
78101d5
Renamed toInt/toFloat/toString to to_int/to_float/to_string
hikari-no-yume Oct 6, 2014
a0f372c
Return FALSE on failure, not NULL
hikari-no-yume Oct 6, 2014
c3a73f0
Removed base argument from to_int
hikari-no-yume Oct 6, 2014
26c7ecf
Oh, RETURN_FALSE *does* exist
hikari-no-yume Oct 6, 2014
56ae42a
use zend_string_copy to avoid breaking interned strings
hikari-no-yume Oct 6, 2014
82cefa6
Removed redundant breaks
hikari-no-yume Oct 6, 2014
6fc532b
Removed unneeded TSRMLS_FETCH();
hikari-no-yume Oct 6, 2014
9ea1bfb
Add commented-out zend_strpprintf block mentioning segfault
hikari-no-yume Oct 6, 2014
9d135f7
Reject non-integral floats passed to to_int
hikari-no-yume Oct 9, 2014
c672669
We don't need to use zend_dval_to_lval here
hikari-no-yume Oct 9, 2014
9898449
Removed the (now redundant) INF/NAN check
hikari-no-yume Oct 9, 2014
03401d9
Clarify that "10.0" should work for float, not for int
hikari-no-yume Oct 11, 2014
6c05ba9
Don't permit leading or trailing whitespace
hikari-no-yume Oct 20, 2014
0cce32d
Test string overflow, octal, hex for to_int()
hikari-no-yume Oct 21, 2014
0f7c856
Test string overflow, octal, hex for to_int(), to_float()
hikari-no-yume Oct 21, 2014
5158a43
Merge branch 'master' into safe_casts
hikari-no-yume Nov 7, 2014
b845227
Merge branch 'master' into safe_casts
hikari-no-yume Nov 10, 2014
f5cf9df
Return NULL, not FALSE, on failure
hikari-no-yume Nov 11, 2014
9afe6a5
Reject leading 0, +
hikari-no-yume Nov 12, 2014
d9361da
Test empty strings
hikari-no-yume Nov 12, 2014
6144649
Note that first char check also excludes empty strings
hikari-no-yume Nov 12, 2014
fccf267
Use more efficient float-string conversion which appears not to segfa…
hikari-no-yume Nov 14, 2014
5632a34
Move casting behaviour into own functions, to allow multiple interfaces
hikari-no-yume Nov 14, 2014
d6c0182
Made to_* functions throw exceptions, add try_* functions to return NULL
hikari-no-yume Nov 14, 2014
7b3a900
Allow + prefix to signify sign
hikari-no-yume Nov 19, 2014
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
22 changes: 22 additions & 0 deletions ext/standard/basic_functions.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2549,6 +2549,19 @@ ZEND_BEGIN_ARG_INFO_EX(arginfo_is_callable, 0, 0, 1)
ZEND_ARG_INFO(0, syntax_only)
ZEND_ARG_INFO(1, callable_name)
ZEND_END_ARG_INFO()

ZEND_BEGIN_ARG_INFO_EX(arginfo_to_int, 0, 0, 1)
ZEND_ARG_INFO(0, from)
ZEND_END_ARG_INFO()

ZEND_BEGIN_ARG_INFO_EX(arginfo_to_float, 0, 0, 1)
ZEND_ARG_INFO(0, from)
ZEND_END_ARG_INFO()

ZEND_BEGIN_ARG_INFO_EX(arginfo_to_string, 0, 0, 1)
ZEND_ARG_INFO(0, from)
ZEND_END_ARG_INFO()

/* }}} */
/* {{{ uniqid.c */
#ifdef HAVE_GETTIMEOFDAY
Expand Down Expand Up @@ -3043,6 +3056,14 @@ const zend_function_entry basic_functions[] = { /* {{{ */
PHP_FE(is_scalar, arginfo_is_scalar)
PHP_FE(is_callable, arginfo_is_callable)

PHP_FE(to_int, arginfo_to_int)
PHP_FE(try_int, arginfo_to_int)
PHP_FE(to_float, arginfo_to_float)
PHP_FE(try_float, arginfo_to_float)
PHP_FE(to_string, arginfo_to_string)
PHP_FE(try_string, arginfo_to_string)


/* functions from file.c */
PHP_FE(pclose, arginfo_pclose)
PHP_FE(popen, arginfo_popen)
Expand Down Expand Up @@ -3612,6 +3633,7 @@ PHP_MINIT_FUNCTION(basic) /* {{{ */
BASIC_MINIT_SUBMODULE(standard_filters)
BASIC_MINIT_SUBMODULE(user_filters)
BASIC_MINIT_SUBMODULE(password)
BASIC_MINIT_SUBMODULE(type)

#if defined(HAVE_LOCALECONV) && defined(ZTS)
BASIC_MINIT_SUBMODULE(localeconv)
Expand Down
8 changes: 8 additions & 0 deletions ext/standard/php_type.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@
#ifndef PHP_TYPE_H
#define PHP_TYPE_H

extern PHPAPI zend_class_entry *php_CastException_ce;

PHP_FUNCTION(intval);
PHP_FUNCTION(floatval);
PHP_FUNCTION(strval);
Expand All @@ -38,5 +40,11 @@ PHP_FUNCTION(is_array);
PHP_FUNCTION(is_object);
PHP_FUNCTION(is_scalar);
PHP_FUNCTION(is_callable);
PHP_FUNCTION(to_int);
PHP_FUNCTION(try_int);
PHP_FUNCTION(to_float);
PHP_FUNCTION(try_float);
PHP_FUNCTION(to_string);
PHP_FUNCTION(try_string);

#endif
121 changes: 121 additions & 0 deletions ext/standard/tests/type/to_float.phpt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,121 @@
--TEST--
to_float()
--FILE--
<?php

function to_float_wrapper($value) {
try {
return to_float($value);
} catch (CastException $e) {
return NULL;
}
}

// should pass
var_dump(to_float_wrapper("0"));
var_dump(to_float_wrapper(0));
var_dump(to_float_wrapper(0.0));
var_dump(to_float_wrapper("10"));
var_dump(to_float_wrapper("+10"));
var_dump(to_float_wrapper("-10"));
var_dump(to_float_wrapper("10.0"));
var_dump(to_float_wrapper(10));
var_dump(to_float_wrapper(10.0));
var_dump(to_float_wrapper((string)PHP_INT_MAX));
var_dump(to_float_wrapper(PHP_INT_MAX));
var_dump(to_float_wrapper((float)PHP_INT_MAX));
var_dump(to_float_wrapper((string)PHP_INT_MIN));
var_dump(to_float_wrapper(PHP_INT_MIN));
var_dump(to_float_wrapper((float)PHP_INT_MIN));

echo PHP_EOL;

// disallowed types
var_dump(to_float_wrapper(""));
var_dump(to_float_wrapper("0x10"));
var_dump(to_float_wrapper(NULL));
var_dump(to_float_wrapper(TRUE));
var_dump(to_float_wrapper(FALSE));
var_dump(to_float_wrapper(new StdClass));
var_dump(to_float_wrapper(fopen("data:text/html,foobar", "r")));
var_dump(to_float_wrapper([]));

echo PHP_EOL;

var_dump(to_float_wrapper(1.5));
var_dump(to_float_wrapper("1.5"));

echo PHP_EOL;

// reject leading, trailing chars
var_dump(to_float_wrapper("010"));
var_dump(to_float_wrapper("10abc"));
var_dump(to_float_wrapper("abc10"));
var_dump(to_float_wrapper(" 100 "));
var_dump(to_float_wrapper("\n\t\v\r\f 78 \n \t\v\r\f \n"));
var_dump(to_float_wrapper("\n\t\v\r\f78"));
var_dump(to_float_wrapper("78\n\t\v\r\f"));

echo PHP_EOL;

// overflow/nan/inf
var_dump(to_float_wrapper(INF));
var_dump(to_float_wrapper(-INF));
var_dump(to_float_wrapper(NAN));
var_dump(to_float_wrapper(PHP_INT_MAX * 2));
var_dump(to_float_wrapper(PHP_INT_MIN * 2));
var_dump(to_float_wrapper((string)(PHP_INT_MAX * 2)));
var_dump(to_float_wrapper((string)(PHP_INT_MIN * 2)));

echo PHP_EOL;

// check exponents work
var_dump(to_float_wrapper("75e-5"));
var_dump(to_float_wrapper("31e+7"));
--EXPECTF--
float(0)
float(0)
float(0)
float(10)
float(10)
float(-10)
float(10)
float(10)
float(10)
float(%s)
float(%s)
float(%s)
float(-%s)
float(-%s)
float(%s)

NULL
NULL
NULL
NULL
NULL
NULL
NULL
NULL

float(1.5)
float(1.5)

NULL
NULL
NULL
NULL
NULL
NULL
NULL

float(INF)
float(-INF)
float(NAN)
float(%s)
float(%s)
float(%s)
float(%s)

float(0.00075)
float(310000000)
118 changes: 118 additions & 0 deletions ext/standard/tests/type/to_int.phpt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,118 @@
--TEST--
to_int()
--FILE--
<?php

function to_int_wrapper($value) {
try {
return to_int($value);
} catch (CastException $e) {
return NULL;
}
}

// should pass
var_dump(to_int_wrapper("0"));
var_dump(to_int_wrapper(0));
var_dump(to_int_wrapper(0.0));
var_dump(to_int_wrapper("10"));
var_dump(to_int_wrapper("+10"));
var_dump(to_int_wrapper("-10"));
var_dump(to_int_wrapper(10));
var_dump(to_int_wrapper(10.0));
var_dump(to_int_wrapper((string)PHP_INT_MAX));
var_dump(to_int_wrapper(PHP_INT_MAX));
var_dump(to_int_wrapper((string)PHP_INT_MIN));
var_dump(to_int_wrapper(PHP_INT_MIN));

echo PHP_EOL;

// shouldn't pass
var_dump(to_int_wrapper(""));
var_dump(to_int_wrapper("10.0"));
var_dump(to_int_wrapper("75e-5"));
var_dump(to_int_wrapper("31e+7"));
var_dump(to_int_wrapper("0x10"));

echo PHP_EOL;

// disallowed types
var_dump(to_int_wrapper(NULL));
var_dump(to_int_wrapper(TRUE));
var_dump(to_int_wrapper(FALSE));
var_dump(to_int_wrapper(new StdClass));
var_dump(to_int_wrapper(fopen("data:text/html,foobar", "r")));
var_dump(to_int_wrapper([]));

echo PHP_EOL;

// check truncation
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These assertions might make more sense under the "shouldn't pass" section since we no longer truncate.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We never did... the "shouldn't pass" section is poorly labelled.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm referring to the change in 9d135f7, and the assertions on lines 38-39.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh, right. Still...

var_dump(to_int_wrapper(1.5));
var_dump(to_int_wrapper("1.5"));

echo PHP_EOL;

// reject leading, trailing chars
var_dump(to_int_wrapper("010"));
var_dump(to_int_wrapper("10abc"));
var_dump(to_int_wrapper("abc10"));
var_dump(to_int_wrapper(" 100 "));
var_dump(to_int_wrapper("\n\t\v\r\f 78 \n \t\v\r\f \n"));
var_dump(to_int_wrapper("\n\t\v\r\f78"));
var_dump(to_int_wrapper("78\n\t\v\r\f"));

echo PHP_EOL;

// overflow/nan/inf
var_dump(to_int_wrapper(INF));
var_dump(to_int_wrapper(-INF));
var_dump(to_int_wrapper(NAN));
var_dump(to_int_wrapper(PHP_INT_MAX * 2));
var_dump(to_int_wrapper(PHP_INT_MIN * 2));
var_dump(to_int_wrapper((string)(PHP_INT_MAX * 2)));
var_dump(to_int_wrapper((string)(PHP_INT_MIN * 2)));
--EXPECTF--
int(0)
int(0)
int(0)
int(10)
int(10)
int(-10)
int(10)
int(10)
int(%d)
int(%d)
int(-%d)
int(-%d)

NULL
NULL
NULL
NULL
NULL

NULL
NULL
NULL
NULL
NULL
NULL

NULL
NULL

NULL
NULL
NULL
NULL
NULL
NULL
NULL

NULL
NULL
NULL
NULL
NULL
NULL
NULL
63 changes: 63 additions & 0 deletions ext/standard/tests/type/to_string.phpt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
--TEST--
to_string()
--FILE--
<?php

function to_string_wrapper($value) {
try {
return to_string($value);
} catch (CastException $e) {
return NULL;
}
}

// valid
var_dump(to_string_wrapper("foobar"));
var_dump(to_string_wrapper(123));
var_dump(to_string_wrapper(123.45));
var_dump(to_string_wrapper(INF));
var_dump(to_string_wrapper(-INF));
var_dump(to_string_wrapper(NAN));
var_dump(to_string_wrapper(""));

echo PHP_EOL;

// invalid
var_dump(to_string_wrapper(NULL));
var_dump(to_string_wrapper(TRUE));
var_dump(to_string_wrapper(FALSE));
var_dump(to_string_wrapper([]));
var_dump(to_string_wrapper(fopen('data:text/plan,foobar', 'r')));

echo PHP_EOL;

class NotStringable {}
class Stringable {
public function __toString() {
return "foobar";
}
}

// objects
var_dump(to_string_wrapper(new StdClass));
var_dump(to_string_wrapper(new NotStringable));
var_dump(to_string_wrapper(new Stringable));

--EXPECT--
string(6) "foobar"
string(3) "123"
string(6) "123.45"
string(3) "INF"
string(4) "-INF"
string(3) "NAN"
string(0) ""

NULL
NULL
NULL
NULL
NULL

NULL
NULL
string(6) "foobar"
Loading