<!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>[4853] sites/trunk/wordpress.org/public_html/wp-content/plugins/official-wordpress-events: Official WordPress Events: Cache events in database for api.wordpress.org</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 { 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="http://meta.trac.wordpress.org/changeset/4853">4853</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"http://meta.trac.wordpress.org/changeset/4853","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>iandunn</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2017-02-03 10:37:20 +0000 (Fri, 03 Feb 2017)</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'>Official WordPress Events: Cache events in database for api.wordpress.org
api.wordpress.org/events/1.0 is being built to expose this data for various use cases, and needs to be able to access it in a performant manner.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentpluginsofficialwordpresseventsofficialwordpresseventphp">sites/trunk/wordpress.org/public_html/wp-content/plugins/official-wordpress-events/official-wordpress-event.php</a></li>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentpluginsofficialwordpresseventsofficialwordpresseventsphp">sites/trunk/wordpress.org/public_html/wp-content/plugins/official-wordpress-events/official-wordpress-events.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="sitestrunkwordpressorgpublic_htmlwpcontentpluginsofficialwordpresseventsofficialwordpresseventphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: sites/trunk/wordpress.org/public_html/wp-content/plugins/official-wordpress-events/official-wordpress-event.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- sites/trunk/wordpress.org/public_html/wp-content/plugins/official-wordpress-events/official-wordpress-event.php 2017-02-03 10:14:11 UTC (rev 4852)
+++ sites/trunk/wordpress.org/public_html/wp-content/plugins/official-wordpress-events/official-wordpress-event.php 2017-02-03 10:37:20 UTC (rev 4853)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -4,10 +4,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * An official WordPress event
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * This doesn't have any real functionality, but it exists to provide a standard data structure
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * for events across various event types.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * for events across various event types. It mostly matches the schema for the `wporg_events`
+ * database table.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> class Official_WordPress_Event {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- public $type, $title, $url, $start_timestamp, $end_timestamp, $location, $coordinates;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public $id, $type, $source_id, $title, $url, $description, $num_attendees, $meetup_name, $meetup_url,
+ $start_timestamp, $end_timestamp, $location, $latitude, $longitude;
</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"> * Constructor
</span></span></pre></div>
<a id="sitestrunkwordpressorgpublic_htmlwpcontentpluginsofficialwordpresseventsofficialwordpresseventsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: sites/trunk/wordpress.org/public_html/wp-content/plugins/official-wordpress-events/official-wordpress-events.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- sites/trunk/wordpress.org/public_html/wp-content/plugins/official-wordpress-events/official-wordpress-events.php 2017-02-03 10:14:11 UTC (rev 4852)
+++ sites/trunk/wordpress.org/public_html/wp-content/plugins/official-wordpress-events/official-wordpress-events.php 2017-02-03 10:37:20 UTC (rev 4853)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -7,6 +7,7 @@
</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"> class Official_WordPress_Events {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ const EVENTS_TABLE = 'wporg_events';
</ins><span class="cx" style="display: block; padding: 0 10px"> const WORDCAMP_API_BASE_URL = 'https://central.wordcamp.org/wp-json/';
</span><span class="cx" style="display: block; padding: 0 10px"> const WORDCAMP_API_VERSION = 2;
</span><span class="cx" style="display: block; padding: 0 10px"> const MEETUP_API_BASE_URL = 'https://api.meetup.com/';
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -17,11 +18,24 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /*
</span><span class="cx" style="display: block; padding: 0 10px"> * @todo
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Database
+ * ==============
+ * `location` field should have full state/county names, not abbreviations
+ * Can/should probably remove calls to geocode API in favor of using meetup v2/group or some other endpoint that returns detailed location breakdown
+ * Once shortcode pulls from db, bump remote_get timeout limit to 30 to avoid premature timeouts
</ins><span class="cx" style="display: block; padding: 0 10px"> * Meetups only pulling 1 week instead of full month
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Look at meetup-stats.php and see if any differences are relevant, or if there's anything else that'd be helpful in general
+ * Check non-latin characters, accents etc to make sure stored properly in db
+ * Add admin_notice to wordcamp post type to warn when coordinates missing. Also back-fill current ones that are missing.
+ * PHP timeout @ 100 seconds - should be fixed by switch to pulling from db
+ * Store wordcamp dates in UTC, and also store timezone? Would need to start collecting timezone for wordcamps and then back-fill old records
</ins><span class="cx" style="display: block; padding: 0 10px"> * Maybe pull more than 1 month of meetups
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ *
+ *
+ * Shortcode
+ * ==============
+ * Update shortcode to pull from cached DB entries instead of API directly. Probably remove caching from $this->remote_get()
</ins><span class="cx" style="display: block; padding: 0 10px"> * Make meetups and wordcamps cut off on the same date, so it doesn't look like there aren't any meetups later in the year
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Always display cached results, and refresh stale cache asynchronously, to avoid visitors having to wait while the data is pulled
- * After async cache refresh, bump remote_get timeout limit to 30 to avoid premature timeouts
</del><span class="cx" style="display: block; padding: 0 10px"> * Ability to feature a camp in a hero area
</span><span class="cx" style="display: block; padding: 0 10px"> * Add a "load more" button that retrieves more events via AJAX and updates the DOM. Have each click load the next month of events?
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -33,9 +47,61 @@
</span><span class="cx" style="display: block; padding: 0 10px"> public function __construct() {
</span><span class="cx" style="display: block; padding: 0 10px"> add_action( 'wp_enqueue_scripts', array( $this, 'enqueue_scripts' ) );
</span><span class="cx" style="display: block; padding: 0 10px"> add_shortcode( 'official_wordpress_events', array( $this, 'render_events' ) );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ add_action( 'owpe_prime_events_cache', array( $this, 'prime_events_cache' ) );
+
+ if ( ! wp_next_scheduled( 'owpe_prime_events_cache' ) ) {
+ wp_schedule_event( time(), 'hourly', 'owpe_prime_events_cache');
+ }
</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">+ * Prime the cache of WordPress events
+ *
+ * WARNING: The database table is used by api.wordpress.org/events/1.0 (and possibly by future versions), so
+ * be careful to maintain consistency when making any changes to this.
+ */
+ public function prime_events_cache() {
+ global $wpdb;
+
+ $events = $this->get_all_events();
+
+ foreach ( $events as $event ) {
+ $row_values = array(
+ 'id' => null,
+ 'type' => $event->type,
+ 'source_id' => $event->source_id,
+ 'title' => $event->title,
+ 'url' => $event->url,
+ 'description' => $event->description,
+ 'attendees' => $event->num_attendees,
+ 'meetup' => $event->meetup_name,
+ 'meetup_url' => $event->meetup_url,
+ 'date_utc' => date( 'Y-m-d H:i:s', $event->start_timestamp ),
+ 'end_date' => date( 'Y-m-d H:i:s', $event->end_timestamp ),
+ 'location' => $event->location,
+ 'latitude' => $event->latitude,
+ 'longitude' => $event->longitude,
+ );
+
+ // Latitude and longitude are required by the database, so skip events that don't have one
+ if ( empty( $row_values['latitude'] ) || empty( $row_values['longitude'] ) ) {
+ continue;
+ }
+
+ /*
+ * Insert the events into the table, without creating duplicates
+ *
+ * Note: Since replace() is matching against a unique key rather than the primary `id` key, it's
+ * expected for each row to be deleted and re-inserted, making the IDs increment each time.
+ *
+ * See http://stackoverflow.com/a/12205366/450127
+ */
+ $wpdb->replace( self::EVENTS_TABLE, $row_values );
+ }
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Enqueue scripts and styles
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function enqueue_scripts() {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -73,8 +139,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $events = array_merge( $this->get_wordcamp_events(), $this->get_meetup_events() );
</span><span class="cx" style="display: block; padding: 0 10px"> usort( $events, array( $this, 'sort_events' ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // todo Cache results here too, to avoid processing the raw data on each request? If so, then no longer need to cache API call results?
-
</del><span class="cx" style="display: block; padding: 0 10px"> return $events;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -241,8 +305,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $wordcamps ) {
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $wordcamps as $wordcamp ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $event = array(
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'source_id' => $wordcamp->id,
</ins><span class="cx" style="display: block; padding: 0 10px"> 'type' => 'wordcamp',
</span><span class="cx" style="display: block; padding: 0 10px"> 'title' => $wordcamp->title->rendered,
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'description' => $wordcamp->content->rendered,
</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"> foreach ( $wordcamp as $field => $value ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -269,28 +335,29 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> break;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ case 'Number of Anticipated Attendees':
+ $event['num_attendees'] = $value;
+ break;
+
</ins><span class="cx" style="display: block; padding: 0 10px"> case 'Location':
</span><span class="cx" style="display: block; padding: 0 10px"> $event['location'] = $value;
</span><span class="cx" style="display: block; padding: 0 10px"> break;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> case '_venue_coordinates' :
</span><span class="cx" style="display: block; padding: 0 10px"> if ( isset( $value->latitude, $value->longitude ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $event['coordinates'] = array(
- 'latitude' => $value->latitude,
- 'longitude' => $value->longitude,
- );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $event['latitude'] = $value->latitude;
+ $event['longitude'] = $value->longitude;
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> break;
</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">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( $event['start_timestamp'] && empty( $event['end_timestamp'] ) ) {
+ $event['end_timestamp'] = $event['start_timestamp'];
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $events[] = new Official_WordPress_Event( $event );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-
- uasort( $events, array( $this, 'sort_events' ) );
-
- // Return fewer WordCamps since they happen less frequently than meetups
- $events = array_slice( $events, 0, self::POSTS_PER_PAGE * 0.5 );
</del><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"> return $events;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -335,11 +402,18 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $events[] = new Official_WordPress_Event( array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'type' => 'meetup',
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'source_id' => $meetup->id,
</ins><span class="cx" style="display: block; padding: 0 10px"> 'title' => $meetup->name,
</span><span class="cx" style="display: block; padding: 0 10px"> 'url' => $meetup->event_url,
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'meetup_name' => $meetup->group->name,
+ 'meetup_url' => sprintf( 'https://www.meetup.com/%s/', $meetup->group->urlname ),
+ 'description' => $meetup->description,
+ 'num_attendees' => $meetup->yes_rsvp_count,
</ins><span class="cx" style="display: block; padding: 0 10px"> 'start_timestamp' => $start_timestamp,
</span><span class="cx" style="display: block; padding: 0 10px"> 'end_timestamp' => ( empty ( $meetup->duration ) ? $start_timestamp : $start_timestamp + ( $meetup->duration / 1000 ) ), // convert to seconds
</span><span class="cx" style="display: block; padding: 0 10px"> 'location' => $location,
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'latitude' => $meetup->venue->lat ?? $meetup->group->group_lat,
+ 'longitude' => $meetup->venue->lon ?? $meetup->group->group_lon,
</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></pre>
</div>
</div>
</body>
</html>