Skip to content

WIP: DateInterval improvements #5346

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

WIP: DateInterval improvements #5346

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
fd17ecc
Make DateInterval::__construct() param optional/null tolerant
DaveRandom Apr 4, 2020
8b9e74f
Add DateInterval::$u property
DaveRandom Apr 4, 2020
684d5bc
Use macros for usecs/fraction conversions
DaveRandom Apr 4, 2020
563bbc7
Use zend_string_equals_literal() for readability
DaveRandom Apr 4, 2020
c1a7b54
Remove redundant macro
DaveRandom Apr 4, 2020
462349b
WIP fix tests
DaveRandom Apr 4, 2020
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
133 changes: 82 additions & 51 deletions ext/date/php_date.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,9 @@ static inline long long php_date_llabs( long long i ) { return i >= 0 ? i : -i;
#endif
#endif

#define DATE_USECS_TO_FRACTION(u) (((double)(u)) / 1000000.0)
#define DATE_FRACTION_TO_USECS(f) ((timelib_sll)((f) * 1000000))

PHPAPI time_t php_time()
{
#ifdef HAVE_GETTIMEOFDAY
Expand Down Expand Up @@ -327,6 +330,7 @@ static HashTable *date_object_get_gc(zend_object *object, zval **table, int *n);
static HashTable *date_object_get_properties_for(zend_object *object, zend_prop_purpose purpose);
static HashTable *date_object_get_gc_interval(zend_object *object, zval **table, int *n);
static HashTable *date_object_get_properties_interval(zend_object *object);
static HashTable *date_object_get_debug_info_interval(zend_object *object, int *is_temp);
static HashTable *date_object_get_gc_period(zend_object *object, zval **table, int *n);
static HashTable *date_object_get_properties_period(zend_object *object);
static HashTable *date_object_get_properties_for_timezone(zend_object *object, zend_prop_purpose purpose);
Expand Down Expand Up @@ -1827,6 +1831,7 @@ static void date_register_classes(void) /* {{{ */
date_object_handlers_interval.read_property = date_interval_read_property;
date_object_handlers_interval.write_property = date_interval_write_property;
date_object_handlers_interval.get_properties = date_object_get_properties_interval;
date_object_handlers_interval.get_debug_info = date_object_get_debug_info_interval;
date_object_handlers_interval.get_property_ptr_ptr = date_interval_get_property_ptr_ptr;
date_object_handlers_interval.get_gc = date_object_get_gc_interval;
date_object_handlers_interval.compare = date_interval_compare_objects;
Expand Down Expand Up @@ -2164,44 +2169,69 @@ static HashTable *date_object_get_gc_interval(zend_object *object, zval **table,
return zend_std_get_properties(object);
} /* }}} */

static HashTable *date_object_get_properties_interval(zend_object *object) /* {{{ */
#define DATE_INTERVAL_EXPORT_PROPERTY_LONG(n, f) \
do { \
ZVAL_LONG(&zv, (zend_long)intervalobj->diff->f); \
zend_hash_str_update(props, n, sizeof(n) - 1, &zv); \
} while (0)

static HashTable *date_interval_export_properties(php_interval_obj *intervalobj, HashTable *props, zend_bool debug_info)
{
HashTable *props;
zval zv;
php_interval_obj *intervalobj;

intervalobj = php_interval_obj_from_obj(object);
props = zend_std_get_properties(object);
if (!intervalobj->initialized) {
return props;
}

#define PHP_DATE_INTERVAL_ADD_PROPERTY(n,f) \
ZVAL_LONG(&zv, (zend_long)intervalobj->diff->f); \
zend_hash_str_update(props, n, sizeof(n)-1, &zv);
DATE_INTERVAL_EXPORT_PROPERTY_LONG("y", y);
DATE_INTERVAL_EXPORT_PROPERTY_LONG("m", m);
DATE_INTERVAL_EXPORT_PROPERTY_LONG("d", d);
DATE_INTERVAL_EXPORT_PROPERTY_LONG("h", h);
DATE_INTERVAL_EXPORT_PROPERTY_LONG("i", i);
DATE_INTERVAL_EXPORT_PROPERTY_LONG("s", s);

PHP_DATE_INTERVAL_ADD_PROPERTY("y", y);
PHP_DATE_INTERVAL_ADD_PROPERTY("m", m);
PHP_DATE_INTERVAL_ADD_PROPERTY("d", d);
PHP_DATE_INTERVAL_ADD_PROPERTY("h", h);
PHP_DATE_INTERVAL_ADD_PROPERTY("i", i);
PHP_DATE_INTERVAL_ADD_PROPERTY("s", s);
ZVAL_DOUBLE(&zv, (double)intervalobj->diff->us / 1000000.0);
if (debug_info) {
DATE_INTERVAL_EXPORT_PROPERTY_LONG("u", us);
}

ZVAL_DOUBLE(&zv, DATE_USECS_TO_FRACTION(intervalobj->diff->us));
zend_hash_str_update(props, "f", sizeof("f") - 1, &zv);
PHP_DATE_INTERVAL_ADD_PROPERTY("weekday", weekday);
PHP_DATE_INTERVAL_ADD_PROPERTY("weekday_behavior", weekday_behavior);
PHP_DATE_INTERVAL_ADD_PROPERTY("first_last_day_of", first_last_day_of);
PHP_DATE_INTERVAL_ADD_PROPERTY("invert", invert);

DATE_INTERVAL_EXPORT_PROPERTY_LONG("weekday", weekday);
DATE_INTERVAL_EXPORT_PROPERTY_LONG("weekday_behavior", weekday_behavior);
DATE_INTERVAL_EXPORT_PROPERTY_LONG("first_last_day_of", first_last_day_of);
DATE_INTERVAL_EXPORT_PROPERTY_LONG("invert", invert);

if (intervalobj->diff->days != -99999) {
PHP_DATE_INTERVAL_ADD_PROPERTY("days", days);
DATE_INTERVAL_EXPORT_PROPERTY_LONG("days", days);
} else {
ZVAL_FALSE(&zv);
zend_hash_str_update(props, "days", sizeof("days")-1, &zv);
}
PHP_DATE_INTERVAL_ADD_PROPERTY("special_type", special.type);
PHP_DATE_INTERVAL_ADD_PROPERTY("special_amount", special.amount);
PHP_DATE_INTERVAL_ADD_PROPERTY("have_weekday_relative", have_weekday_relative);
PHP_DATE_INTERVAL_ADD_PROPERTY("have_special_relative", have_special_relative);

DATE_INTERVAL_EXPORT_PROPERTY_LONG("special_type", special.type);
DATE_INTERVAL_EXPORT_PROPERTY_LONG("special_amount", special.amount);

DATE_INTERVAL_EXPORT_PROPERTY_LONG("have_weekday_relative", have_weekday_relative);
DATE_INTERVAL_EXPORT_PROPERTY_LONG("have_special_relative", have_special_relative);

return props;
}

static HashTable *date_object_get_properties_interval(zend_object *object) /* {{{ */
{
return date_interval_export_properties(php_interval_obj_from_obj(object), zend_std_get_properties(object), 0);
} /* }}} */

static HashTable *date_object_get_debug_info_interval(zend_object *object, int *is_temp) /* {{{ */
{
HashTable *props = zend_std_get_properties(object);
php_interval_obj *intervalobj = php_interval_obj_from_obj(object);

if (intervalobj->initialized) {
*is_temp = 1;
props = date_interval_export_properties(intervalobj, zend_array_dup(props), 1);
}

return props;
} /* }}} */
Expand Down Expand Up @@ -2811,7 +2841,7 @@ void php_date_do_return_parsed_time(INTERNAL_FUNCTION_PARAMETERS, timelib_time *
if (parsed_time->us == -99999) {
add_assoc_bool(return_value, "fraction", 0);
} else {
add_assoc_double(return_value, "fraction", (double)parsed_time->us / 1000000.0);
add_assoc_double(return_value, "fraction", DATE_USECS_TO_FRACTION(parsed_time->us));
}

zval_from_error_container(return_value, error);
Expand Down Expand Up @@ -3865,6 +3895,12 @@ static int date_interval_initialize(timelib_rel_time **rt, /*const*/ char *forma
int retval = 0;
timelib_error_container *errors;

if (format_length == 0) {
#define DATE_INTERVAL_DEFAULT_FORMAT "PT0S"
format = DATE_INTERVAL_DEFAULT_FORMAT;
format_length = sizeof(DATE_INTERVAL_DEFAULT_FORMAT) - 1;
}

timelib_strtointerval(format, format_length, &b, &e, &p, &r, &errors);

if (errors->error_count > 0) {
Expand Down Expand Up @@ -3931,8 +3967,9 @@ static zval *date_interval_read_property(zend_object *object, zend_string *name,
GET_VALUE_FROM_STRUCT(h, "h");
GET_VALUE_FROM_STRUCT(i, "i");
GET_VALUE_FROM_STRUCT(s, "s");
GET_VALUE_FROM_STRUCT(us, "u");
if (strcmp(ZSTR_VAL(name), "f") == 0) {
fvalue = obj->diff->us / 1000000.0;
fvalue = DATE_USECS_TO_FRACTION(obj->diff->us);
break;
}
GET_VALUE_FROM_STRUCT(invert, "invert");
Expand Down Expand Up @@ -3981,8 +4018,9 @@ static zval *date_interval_write_property(zend_object *object, zend_string *name
SET_VALUE_FROM_STRUCT(h, "h");
SET_VALUE_FROM_STRUCT(i, "i");
SET_VALUE_FROM_STRUCT(s, "s");
SET_VALUE_FROM_STRUCT(us, "u");
if (strcmp(ZSTR_VAL(name), "f") == 0) {
obj->diff->us = zval_get_double(value) * 1000000;
obj->diff->us = DATE_FRACTION_TO_USECS(zval_get_double(value));
break;
}
SET_VALUE_FROM_STRUCT(invert, "invert");
Expand All @@ -3999,15 +4037,16 @@ static zval *date_interval_get_property_ptr_ptr(zend_object *object, zend_string
{
zval *ret;

if(zend_binary_strcmp("y", sizeof("y") - 1, ZSTR_VAL(name), ZSTR_LEN(name)) == 0 ||
zend_binary_strcmp("m", sizeof("m") - 1, ZSTR_VAL(name), ZSTR_LEN(name)) == 0 ||
zend_binary_strcmp("d", sizeof("d") - 1, ZSTR_VAL(name), ZSTR_LEN(name)) == 0 ||
zend_binary_strcmp("h", sizeof("h") - 1, ZSTR_VAL(name), ZSTR_LEN(name)) == 0 ||
zend_binary_strcmp("i", sizeof("i") - 1, ZSTR_VAL(name), ZSTR_LEN(name)) == 0 ||
zend_binary_strcmp("s", sizeof("s") - 1, ZSTR_VAL(name), ZSTR_LEN(name)) == 0 ||
zend_binary_strcmp("f", sizeof("f") - 1, ZSTR_VAL(name), ZSTR_LEN(name)) == 0 ||
zend_binary_strcmp("days", sizeof("days") - 1, ZSTR_VAL(name), ZSTR_LEN(name)) == 0 ||
zend_binary_strcmp("invert", sizeof("invert") - 1, ZSTR_VAL(name), ZSTR_LEN(name)) == 0) {
if (zend_string_equals_literal(name, "y") ||
zend_string_equals_literal(name, "m") ||
zend_string_equals_literal(name, "d") ||
zend_string_equals_literal(name, "h") ||
zend_string_equals_literal(name, "i") ||
zend_string_equals_literal(name, "s") ||
zend_string_equals_literal(name, "u") ||
zend_string_equals_literal(name, "f") ||
zend_string_equals_literal(name, "days") ||
zend_string_equals_literal(name, "invert")) {
/* Fallback to read_property. */
ret = NULL;
} else {
Expand All @@ -4023,16 +4062,18 @@ static zval *date_interval_get_property_ptr_ptr(zend_object *object, zend_string
*/
PHP_METHOD(DateInterval, __construct)
{
zend_string *interval_string = NULL;
char *interval_str = NULL;
size_t interval_str_len = 0;
timelib_rel_time *reltime;
zend_error_handling error_handling;

ZEND_PARSE_PARAMETERS_START(1, 1)
Z_PARAM_STR(interval_string)
ZEND_PARSE_PARAMETERS_START(0, 1)
Z_PARAM_OPTIONAL
Z_PARAM_STRING_OR_NULL(interval_str, interval_str_len)
ZEND_PARSE_PARAMETERS_END();

zend_replace_error_handling(EH_THROW, NULL, &error_handling);
if (date_interval_initialize(&reltime, ZSTR_VAL(interval_string), ZSTR_LEN(interval_string)) == SUCCESS) {
if (date_interval_initialize(&reltime, interval_str, interval_str_len) == SUCCESS) {
php_interval_obj *diobj = Z_PHPINTERVAL_P(ZEND_THIS);
diobj->diff = reltime;
diobj->initialized = 1;
Expand Down Expand Up @@ -4083,16 +4124,6 @@ static int php_date_interval_initialize_from_hash(zval **return_value, php_inter
} \
} while (0);

#define PHP_DATE_INTERVAL_READ_PROPERTY_DOUBLE(element, member, def) \
do { \
zval *z_arg = zend_hash_str_find(myht, element, sizeof(element) - 1); \
if (z_arg) { \
(*intobj)->diff->member = (double)zval_get_double(z_arg); \
} else { \
(*intobj)->diff->member = (double)def; \
} \
} while (0);

PHP_DATE_INTERVAL_READ_PROPERTY("y", y, timelib_sll, -1)
PHP_DATE_INTERVAL_READ_PROPERTY("m", m, timelib_sll, -1)
PHP_DATE_INTERVAL_READ_PROPERTY("d", d, timelib_sll, -1)
Expand All @@ -4103,7 +4134,7 @@ static int php_date_interval_initialize_from_hash(zval **return_value, php_inter
zval *z_arg = zend_hash_str_find(myht, "f", sizeof("f") - 1);
(*intobj)->diff->us = -1000000;
if (z_arg) {
double val = zval_get_double(z_arg) * 1000000;
timelib_sll val = DATE_FRACTION_TO_USECS(zval_get_double(z_arg));
if (val >= 0 && val < 1000000) {
(*intobj)->diff->us = val;
}
Expand Down
4 changes: 2 additions & 2 deletions ext/date/php_date_arginfo.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -366,8 +366,8 @@ ZEND_END_ARG_INFO()

#define arginfo_class_DateTimeZone___set_state arginfo_class_DateTime___set_state

ZEND_BEGIN_ARG_INFO_EX(arginfo_class_DateInterval___construct, 0, 0, 1)
ZEND_ARG_TYPE_INFO(0, interval_spec, IS_STRING, 0)
ZEND_BEGIN_ARG_INFO_EX(arginfo_class_DateInterval___construct, 0, 0, 0)
ZEND_ARG_TYPE_INFO(0, interval_spec, IS_STRING, 1)
ZEND_END_ARG_INFO()

ZEND_BEGIN_ARG_INFO_EX(arginfo_class_DateInterval_createFromDateString, 0, 0, 1)
Expand Down
26 changes: 26 additions & 0 deletions ext/date/tests/DateInterval_construct_spec_default.phpt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
--TEST--
DateInterval::__construct() default arg value (arg not supplied)
--FILE--
<?php

$interval = new DateInterval();

var_dump(
$interval->y,
$interval->m,
$interval->d,
$interval->h,
$interval->i,
$interval->s,
$interval->f
);

?>
--EXPECT--
int(0)
int(0)
int(0)
int(0)
int(0)
int(0)
float(0)
26 changes: 26 additions & 0 deletions ext/date/tests/DateInterval_construct_spec_null.phpt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
--TEST--
DateInterval::__construct() default arg value (arg not supplied)
--FILE--
<?php

$interval = new DateInterval(null);

var_dump(
$interval->y,
$interval->m,
$interval->d,
$interval->h,
$interval->i,
$interval->s,
$interval->f
);

?>
--EXPECT--
int(0)
int(0)
int(0)
int(0)
int(0)
int(0)
float(0)
50 changes: 50 additions & 0 deletions ext/date/tests/DateInterval_prop_u.phpt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
--TEST--
DateInterval::$u behavior
--FILE--
<?php

function dump_usecs(DateInterval $interval): void
{
var_dump(
$interval->u,
sprintf("%.6F", $interval->f),
$interval->format("%f"),
$interval->format("%F")
);
echo "\n";
}

$interval = new DateInterval('PT0S');
dump_usecs($interval);

$interval->u = 123;
dump_usecs($interval);

$interval->f = 0.456;
dump_usecs($interval);

$interval->u = 987654;
dump_usecs($interval);

?>
--EXPECT--
int(0)
string(8) "0.000000"
string(1) "0"
string(6) "000000"

int(123)
string(8) "0.000123"
string(3) "123"
string(6) "000123"

int(456000)
string(8) "0.456000"
string(6) "456000"
string(6) "456000"

int(987654)
string(8) "0.987654"
string(6) "987654"
string(6) "987654"

4 changes: 3 additions & 1 deletion ext/date/tests/DatePeriod_set_state.phpt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ object(DatePeriod)#%d (6) {
["end"]=>
NULL
["interval"]=>
object(DateInterval)#%d (16) {
object(DateInterval)#%d (17) {
["y"]=>
int(0)
["m"]=>
Expand All @@ -47,6 +47,8 @@ object(DatePeriod)#%d (6) {
int(30)
["s"]=>
int(0)
["u"]=>
int(0)
["f"]=>
float(0)
["weekday"]=>
Expand Down
4 changes: 3 additions & 1 deletion ext/date/tests/bug45682.phpt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ $diff = date_diff($date, $other);

var_dump($diff);
--EXPECTF--
object(DateInterval)#%d (16) {
object(DateInterval)#%d (17) {
["y"]=>
int(0)
["m"]=>
Expand All @@ -25,6 +25,8 @@ object(DateInterval)#%d (16) {
int(0)
["s"]=>
int(0)
["u"]=>
int(0)
["f"]=>
float(0)
["weekday"]=>
Expand Down
Loading