Changeset 10270

Timestamp:

09/16/2020 06:16:57 PM (5 years ago)

Author:

iandunn

Message:

Events: Add start_unix_timestamp and end_unix_timestamp fields.

The date and end_date fields are WP timestamps which reflect the event's local timezone. True Unix timestamps are needed for the Events Widget to display events in the user's local timezone.

Fixes #4480
See ​#core51130
Props Rarst, dd32, iandunn

File:

• sites/trunk/api.wordpress.org/public_html/events/1.0/index.php (modified) (10 diffs)

sites/trunk/api.wordpress.org/public_html/events/1.0/index.php

@@ -35 +35 @@
     define( 'THROTTLE_IP2LOCATION',      0 );
 
-    defined( 'DAY_IN_SECONDS'  ) or define( 'DAY_IN_SECONDS', 60 * 60 * 24 );
+    defined( 'HOUR_IN_SECONDS' ) or define( 'HOUR_IN_SECONDS', 60 * 60 );
+    defined( 'DAY_IN_SECONDS'  ) or define( 'DAY_IN_SECONDS', HOUR_IN_SECONDS * 24 );
     defined( 'WEEK_IN_SECONDS' ) or define( 'WEEK_IN_SECONDS', 7 * DAY_IN_SECONDS );
 
@@ -869 +870 @@
             'meetup'     => $event->meetup,
             'meetup_url' => $event->meetup_url,
-            'date'       => $event->date_utc, // TODO: DB stores a local date, not UTC.
+
+            /*
+             * The `date_utc` column in the database is misnomed, and contains times in the event's local
+             * timezone. So the `date` field in the response is the local time, and the `date_utc` field in
+             * the response here is _actually_ UTC.
+             */
+            'date'       => $event->date_utc,
             'end_date'   => $event->end_date,
+            'start_unix_timestamp'  => strtotime( $event->date_utc ) - $event->date_utc_offset,
+            'end_unix_timestamp'    => strtotime( $event->end_date ) - $event->date_utc_offset,
+
 
             'location'   => array(
@@ -1032 +1042 @@
                 'date'       => '2020-02-21 00:00:00',
                 'end_date'   => '2020-02-23 00:00:00',
+                'start_unix_timestamp' => strtotime( '2020-02-21 00:00:00' ) - 7 * HOUR_IN_SECONDS,
+                'end_unix_timestamp'   => strtotime( '2020-02-23 00:00:00' ) - 7 * HOUR_IN_SECONDS,
 
                 'location' => array(
@@ -1057 +1069 @@
                 'date'       => '2020-06-04 00:00:00',
                 'end_date'   => '2020-06-06 00:00:00',
+                'start_unix_timestamp' => strtotime( '2020-06-04 00:00:00' ) - 1 * HOUR_IN_SECONDS,
+                'end_unix_timestamp'   => strtotime( '2020-06-06 00:00:00' ) - 1 * HOUR_IN_SECONDS,
 
                 'location' => array(
@@ -1083 +1097 @@
                 'date'       => '2020-10-27 00:00:00',
                 'end_date'   => '2020-10-29 00:00:00',
+                'start_unix_timestamp' => strtotime( '2020-10-27 00:00:00' ) - 5 * HOUR_IN_SECONDS,
+                'end_unix_timestamp'   => strtotime( '2020-10-29 00:00:00' ) - 5 * HOUR_IN_SECONDS,
 
                 'location' => array(
@@ -1271 +1287 @@
             'meetup_url' => '',
             'date'       => '2018-05-27 12:00:00',
+
             'location'   => array(
                 'location' => 'Everywhere',
@@ -1341 +1358 @@
         $raw_camp = $wpdb->get_row( "
             SELECT
-                `title`, `url`, `meetup`, `meetup_url`, `date_utc`, `end_date`, `country`, `latitude`, `longitude`
+                `title`, `url`, `meetup`, `meetup_url`, `date_utc`, `date_utc_offset`, `end_date`, `country`, `latitude`, `longitude`
             FROM `wporg_events`
             WHERE
@@ -1359 +1376 @@
                 'meetup'     => $raw_camp->meetup,
                 'meetup_url' => $raw_camp->meetup_url,
+
+                // See notes about UTC in `get_events()`.
                 'date'       => $raw_camp->date_utc,
                 'end_date'   => $raw_camp->end_date,
+                'start_unix_timestamp'  => strtotime( $raw_camp->date_utc ) - $raw_camp->date_utc_offset,
+                'end_unix_timestamp'    => strtotime( $raw_camp->end_date ) - $raw_camp->date_utc_offset,
 
                 'location'   => array(
@@ -1416 +1437 @@
     if ( ! $found ) {
         $raw_discussion_group = $wpdb->get_row( "
-            SELECT `title`, `url`, `meetup`, `meetup_url`, `date_utc`, `end_date`, `country`, `latitude`, `longitude`
+            SELECT `title`, `url`, `meetup`, `meetup_url`, `date_utc`, `date_utc_offset`, `end_date`, `country`, `latitude`, `longitude`
             FROM `wporg_events`
             WHERE
@@ -1435 +1456 @@
                 'meetup'     => $raw_discussion_group->meetup,
                 'meetup_url' => $raw_discussion_group->meetup_url,
+
+                // See notes about UTC in `get_events()`.
                 'date'       => $raw_discussion_group->date_utc,
                 'end_date'   => $raw_discussion_group->end_date,
+                'start_unix_timestamp' => strtotime( $raw_discussion_group->date_utc ) - $raw_discussion_group->date_utc_offset,
+                'end_unix_timestamp'   => strtotime( $raw_discussion_group->end_date ) - $raw_discussion_group->date_utc_offset,
 
                 'location'   => array(