<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[58923] trunk: Date/Time: Prevent type errors in `current_time()`.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/58923">58923</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/58923","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>peterwilsoncc</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2024-08-22 23:25:17 +0000 (Thu, 22 Aug 2024)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Date/Time: Prevent type errors in `current_time()`.
Prevents a potential type error when calling `current_time( 'timestamp' )` by casting `get_option( 'gmt_offset' )` to a float prior to performing calculations with the value.
This mainly accounts for incorrect storage of values, such as an empty string or city name.
Follow up to <a href="https://core.trac.wordpress.org/changeset/45856">[45856]</a>, <a href="https://core.trac.wordpress.org/changeset/55054">[55054]</a>, <a href="https://core.trac.wordpress.org/changeset/55598">[55598]</a>.
Props hellofromtonya, peterwilsoncc, rarst, costdev, Nick_theGeek, SergeyBiryukov, johnbillion, desrosj, reputeinfosystems, audrasjb, oglekler.
Fixes <a href="https://core.trac.wordpress.org/ticket/57035">#57035</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesfunctionsphp">trunk/src/wp-includes/functions.php</a></li>
<li><a href="#trunktestsphpunittestsdatecurrentTimephp">trunk/tests/phpunit/tests/date/currentTime.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesfunctionsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/functions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/functions.php 2024-08-22 08:06:05 UTC (rev 58922)
+++ trunk/src/wp-includes/functions.php 2024-08-22 23:25:17 UTC (rev 58923)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -73,7 +73,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> function current_time( $type, $gmt = 0 ) {
</span><span class="cx" style="display: block; padding: 0 10px"> // Don't use non-GMT timestamp, unless you know the difference and really need to.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( 'timestamp' === $type || 'U' === $type ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return $gmt ? time() : time() + (int) ( get_option( 'gmt_offset' ) * HOUR_IN_SECONDS );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return $gmt ? time() : time() + (int) ( (float) get_option( 'gmt_offset' ) * HOUR_IN_SECONDS );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( 'mysql' === $type ) {
</span></span></pre></div>
<a id="trunktestsphpunittestsdatecurrentTimephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/date/currentTime.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/date/currentTime.php 2024-08-22 08:06:05 UTC (rev 58922)
+++ trunk/tests/phpunit/tests/date/currentTime.php 2024-08-22 23:25:17 UTC (rev 58923)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -91,9 +91,14 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * @ticket 40653
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @ticket 57998
+ *
+ * @dataProvider data_timezones
+ *
+ * @param string $timezone The timezone to test.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- public function test_should_return_wp_timestamp() {
- update_option( 'timezone_string', 'Europe/Helsinki' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public function test_should_return_wp_timestamp( $timezone ) {
+ update_option( 'timezone_string', $timezone );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $timestamp = time();
</span><span class="cx" style="display: block; padding: 0 10px"> $datetime = new DateTime( '@' . $timestamp );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -101,24 +106,29 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $wp_timestamp = $timestamp + $datetime->getOffset();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // phpcs:ignore WordPress.DateTime.CurrentTimeTimestamp.RequestedUTC
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertEqualsWithDelta( $timestamp, current_time( 'timestamp', true ), 2, 'The dates should be equal' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertEqualsWithDelta( $timestamp, current_time( 'timestamp', true ), 2, 'When passing "timestamp", the date should be equal to time()' );
</ins><span class="cx" style="display: block; padding: 0 10px"> // phpcs:ignore WordPress.DateTime.CurrentTimeTimestamp.RequestedUTC
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertEqualsWithDelta( $timestamp, current_time( 'U', true ), 2, 'The dates should be equal' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertEqualsWithDelta( $timestamp, current_time( 'U', true ), 2, 'When passing "U", the date should be equal to time()' );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // phpcs:ignore WordPress.DateTime.CurrentTimeTimestamp.Requested
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertEqualsWithDelta( $wp_timestamp, current_time( 'timestamp' ), 2, 'The dates should be equal' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertEqualsWithDelta( $wp_timestamp, current_time( 'timestamp' ), 2, 'When passing "timestamp", the date should be equal to calculated timestamp' );
</ins><span class="cx" style="display: block; padding: 0 10px"> // phpcs:ignore WordPress.DateTime.CurrentTimeTimestamp.Requested
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertEqualsWithDelta( $wp_timestamp, current_time( 'U' ), 2, 'The dates should be equal' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertEqualsWithDelta( $wp_timestamp, current_time( 'U' ), 2, 'When passing "U", the date should be equal to calculated timestamp' );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // phpcs:ignore WordPress.DateTime.CurrentTimeTimestamp.Requested
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertIsInt( current_time( 'timestamp' ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertIsInt( current_time( 'timestamp' ), 'The returned timestamp should be an integer' );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * @ticket 40653
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @ticket 57998
+ *
+ * @dataProvider data_timezones
+ *
+ * @param string $timezone The timezone to test.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- public function test_should_return_correct_local_time() {
- update_option( 'timezone_string', 'Europe/Helsinki' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public function test_should_return_correct_local_time( $timezone ) {
+ update_option( 'timezone_string', $timezone );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $timestamp = time();
</span><span class="cx" style="display: block; padding: 0 10px"> $datetime_local = new DateTime( '@' . $timestamp );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -127,10 +137,23 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $datetime_utc->setTimezone( new DateTimeZone( 'UTC' ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEqualsWithDelta( strtotime( $datetime_local->format( DATE_W3C ) ), strtotime( current_time( DATE_W3C ) ), 2, 'The dates should be equal' );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertEqualsWithDelta( strtotime( $datetime_utc->format( DATE_W3C ) ), strtotime( current_time( DATE_W3C, true ) ), 2, 'The dates should be equal' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertEqualsWithDelta( strtotime( $datetime_utc->format( DATE_W3C ) ), strtotime( current_time( DATE_W3C, true ) ), 2, 'When passing "timestamp", the dates should be equal' );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Data provider.
+ *
+ * @return array[]
+ */
+ public function data_timezones() {
+ return array(
+ array( 'Europe/Helsinki' ),
+ array( 'Indian/Antananarivo' ),
+ array( 'Australia/Adelaide' ),
+ );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Ensures that deprecated timezone strings are handled correctly.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @ticket 56468
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -158,4 +181,88 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( gmdate( $format ), $current_time_gmt, 'The dates should be equal [3]' );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( $datetime->format( $format ), $current_time, 'The dates should be equal [4]' );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Ensures an empty offset does not cause a type error.
+ *
+ * @ticket 57998
+ */
+ public function test_empty_offset_does_not_cause_a_type_error() {
+ // Ensure `wp_timezone_override_offset()` doesn't override offset.
+ update_option( 'timezone_string', '' );
+ update_option( 'gmt_offset', '' );
+
+ $expected = time();
+
+ // phpcs:ignore WordPress.DateTime.CurrentTimeTimestamp.Requested
+ $this->assertEqualsWithDelta( $expected, current_time( 'timestamp' ), 2, 'The timestamps should be equal' );
+ }
+
+ /**
+ * Ensures the offset applied in current_time() is correct.
+ *
+ * @ticket 57998
+ *
+ * @dataProvider data_partial_hour_timezones_with_timestamp
+ *
+ * @param float $partial_hour Partial hour GMT offset to test.
+ */
+ public function test_partial_hour_timezones_with_timestamp( $partial_hour ) {
+ // Ensure `wp_timezone_override_offset()` doesn't override offset.
+ update_option( 'timezone_string', '' );
+ update_option( 'gmt_offset', $partial_hour );
+
+ $expected = time() + (int) ( $partial_hour * HOUR_IN_SECONDS );
+
+ // phpcs:ignore WordPress.DateTime.CurrentTimeTimestamp.Requested
+ $this->assertEqualsWithDelta( $expected, current_time( 'timestamp' ), 2, 'The timestamps should be equal' );
+ }
+
+ /**
+ * Tests the tests.
+ *
+ * Ensures the offsets match the stated timezones in the data provider.
+ *
+ * @ticket 57998
+ *
+ * @dataProvider data_partial_hour_timezones_with_timestamp
+ *
+ * @param float $partial_hour Partial hour GMT offset to test.
+ * @param string $timezone_string Timezone string to test.
+ */
+ public function test_partial_hour_timezones_match_datetime_offset( $partial_hour, $timezone_string ) {
+ $timezone = new DateTimeZone( $timezone_string );
+ $datetime = new DateTime( 'now', $timezone );
+ $dst_offset = (int) $datetime->format( 'I' );
+
+ // Timezone offset in hours.
+ $offset = $timezone->getOffset( $datetime ) / HOUR_IN_SECONDS;
+
+ /*
+ * Adjust for daylight saving time.
+ *
+ * DST adds an hour to the offset, the partial hour offset
+ * is set the the standard time offset so this removes the
+ * DST offset to avoid false negatives.
+ */
+ $offset -= $dst_offset;
+
+ $this->assertSame( $partial_hour, $offset, 'The offset should match to timezone.' );
+ }
+
+ /**
+ * Data provider.
+ *
+ * @return array[]
+ */
+ public function data_partial_hour_timezones_with_timestamp() {
+ return array(
+ '+12:45' => array( 12.75, 'Pacific/Chatham' ), // New Zealand, Chatham Islands.
+ '+9:30' => array( 9.5, 'Australia/Darwin' ), // Australian Northern Territory.
+ '+05:30' => array( 5.5, 'Asia/Kolkata' ), // India and Sri Lanka.
+ '+05:45' => array( 5.75, 'Asia/Kathmandu' ), // Nepal.
+ '-03:30' => array( -3.50, 'Canada/Newfoundland' ), // Canada, Newfoundland.
+ '-09:30' => array( -9.50, 'Pacific/Marquesas' ), // French Polynesia, Marquesas Islands.
+ );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>