Only call DateTimeFormat::fix() when there's an Exception

- This prevents valid date/time strings to be mangled by fix()
This commit is contained in:
Hypolite Petovan 2022-10-09 00:23:09 -04:00
parent b5ad8c3e15
commit bee6506d33
2 changed files with 29 additions and 17 deletions

View file

@ -119,7 +119,7 @@ class DateTimeFormat
* @return string Formatted date according to given format * @return string Formatted date according to given format
* @throws Exception * @throws Exception
*/ */
public static function convert($s = 'now', $tz_to = 'UTC', $tz_from = 'UTC', $format = self::MYSQL) public static function convert(string $s = 'now', string $tz_to = 'UTC', string $tz_from = 'UTC', string $format = self::MYSQL): string
{ {
// Defaults to UTC if nothing is set, but throws an exception if set to empty string. // Defaults to UTC if nothing is set, but throws an exception if set to empty string.
// Provide some sane defaults regardless. // Provide some sane defaults regardless.
@ -135,20 +135,11 @@ class DateTimeFormat
$s = 'now'; $s = 'now';
} }
$s = self::fix($s); // Lowest possible datetime value
/*
* Slight hackish adjustment so that 'zero' datetime actually returns what is intended
* otherwise we end up with -0001-11-30 ...
* add 32 days so that we at least get year 00, and then hack around the fact that
* months and days always start with 1.
*/
if (substr($s, 0, 10) <= '0001-01-01') { if (substr($s, 0, 10) <= '0001-01-01') {
if ($s < '0000-00-00') { $d = new DateTime('now', new DateTimeZone('UTC'));
$s = '0000-00-00'; $d->setDate(1, 1, 1)->setTime(0, 0);
} return $d->format($format);
$d = new DateTime($s . ' + 32 days', new DateTimeZone('UTC'));
return str_replace('1', '0', $d->format($format));
} }
try { try {
@ -160,9 +151,13 @@ class DateTimeFormat
try { try {
$d = new DateTime($s, $from_obj); $d = new DateTime($s, $from_obj);
} catch (Exception $e) { } catch (Exception $e) {
try {
$d = new DateTime(self::fix($s), $from_obj);
} catch (\Throwable $e) {
Logger::warning('DateTimeFormat::convert: exception: ' . $e->getMessage()); Logger::warning('DateTimeFormat::convert: exception: ' . $e->getMessage());
$d = new DateTime('now', $from_obj); $d = new DateTime('now', $from_obj);
} }
}
try { try {
$to_obj = new DateTimeZone($tz_to); $to_obj = new DateTimeZone($tz_to);
@ -176,7 +171,10 @@ class DateTimeFormat
} }
/** /**
* Fix weird date formats * Fix weird date formats.
*
* Note: This method isn't meant to sanitize valid date/time strings, for example it will mangle relative date
* strings like "now - 3 days".
* *
* @see \Friendica\Test\src\Util\DateTimeFormatTest::dataFix() for a list of examples handled by this method. * @see \Friendica\Test\src\Util\DateTimeFormatTest::dataFix() for a list of examples handled by this method.
* @param string $dateString * @param string $dateString

View file

@ -141,4 +141,18 @@ class DateTimeFormatTest extends MockedTest
{ {
$this->assertEquals($expected, DateTimeFormat::fix($dateString)); $this->assertEquals($expected, DateTimeFormat::fix($dateString));
} }
/**
* This test is meant to ensure DateTimeFormat::fix() isn't called on relative date/time strings
*
* @return void
* @throws \Exception
*/
public function testConvertRelative()
{
$now = DateTimeFormat::utcNow('U');
$date = DateTimeFormat::utc('now - 3 days', 'U');
$this->assertEquals(259200, $now - $date);
}
} }