<!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>[6078] sites/trunk/api.wordpress.org/public_html/events/1.0: Events: Add regional WordCamps to the Core widget for extra promotion.</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/6078">6078</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/6078","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-11-06 21:03:28 +0000 (Mon, 06 Nov 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'>Events: Add regional WordCamps to the Core widget for extra promotion.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#sitestrunkapiwordpressorgpublic_htmlevents10indexphp">sites/trunk/api.wordpress.org/public_html/events/1.0/index.php</a></li>
<li><a href="#sitestrunkapiwordpressorgpublic_htmlevents10teststestindexphp">sites/trunk/api.wordpress.org/public_html/events/1.0/tests/test-index.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="sitestrunkapiwordpressorgpublic_htmlevents10indexphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: sites/trunk/api.wordpress.org/public_html/events/1.0/index.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- sites/trunk/api.wordpress.org/public_html/events/1.0/index.php 2017-11-06 06:39:19 UTC (rev 6077)
+++ sites/trunk/api.wordpress.org/public_html/events/1.0/index.php 2017-11-06 21:03:28 UTC (rev 6078)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -147,6 +147,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"> $events = get_events( $event_args );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $events = add_regional_wordcamps( $events, $_SERVER['HTTP_USER_AGENT'] );
</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"> * There are two conditions which can cause a location to not have a description:
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -784,6 +785,80 @@
</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">+ * Add regional WordCamps to the Events Widget in Core for extra promotion.
+ *
+ * @param array $local_events
+ * @param string $user_agent
+ *
+ * @return array
+ */
+function add_regional_wordcamps( $local_events, $user_agent ) {
+ $time = time();
+ $regional_wordcamps = array();
+
+ /*
+ * Limit effects to the Events Widget in Core.
+ * Otherwise this would return unexpected results to other clients.
+ *
+ * This is the closest we can get to detecting Core, so it'll still distort results for any
+ * plugins that are fetching events with `wp_remote_get()`.
+ */
+ if ( false === strpos( $user_agent, 'WordPress/' ) ) {
+ return $local_events;
+ }
+
+ if ( $time <= strtotime( 'December 2nd, 2017' ) ) {
+ $regional_wordcamps[] = array(
+ 'type' => 'wordcamp',
+ 'title' => 'WordCamp US',
+ 'url' => 'https://2017.us.wordcamp.org/',
+ 'meetup' => '',
+ 'meetup_url' => '',
+ 'date' => '2017-12-01 00:00:00',
+
+ 'location' => array(
+ 'location' => 'Nashville, TN, USA',
+ 'country' => 'US',
+ 'latitude' => 36.1566085,
+ 'longitude' => -86.7784909,
+ )
+ );
+ }
+
+ if ( $time >= strtotime( 'May 14th, 2018' ) && $time <= strtotime( 'June 15th, 2018' ) ) {
+ $regional_wordcamps[] = array(
+ 'type' => 'wordcamp',
+ 'title' => 'WordCamp Europe',
+ 'url' => 'https://2018.europe.wordcamp.org/',
+ 'meetup' => '',
+ 'meetup_url' => '',
+ 'date' => '2018-06-14 00:00:00',
+
+ 'location' => array(
+ 'location' => 'Belgrade, Serbia',
+ 'country' => 'RS',
+ 'latitude' => 44.808497,
+ 'longitude' => 20.432285,
+ )
+ );
+ }
+
+ /**
+ * Remove duplicates events.
+ * Favor the regional event since it'll be pinned to the top.
+ */
+ foreach ( $regional_wordcamps as $regional_event ) {
+ foreach ( $local_events as $local_key => $local_event ) {
+ if ( parse_url( $regional_event['url'], PHP_URL_HOST ) === parse_url( $local_event['url'], PHP_URL_HOST ) ) {
+ unset( $local_events[ $local_key ] );
+ }
+ }
+ }
+
+ return array_merge( $regional_wordcamps, $local_events );
+}
+
+/**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Create a bounded latitude/longitude box of x KM around specific coordinates.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param float $lat The latitude of the location.
</span></span></pre></div>
<a id="sitestrunkapiwordpressorgpublic_htmlevents10teststestindexphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: sites/trunk/api.wordpress.org/public_html/events/1.0/tests/test-index.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- sites/trunk/api.wordpress.org/public_html/events/1.0/tests/test-index.php 2017-11-06 06:39:19 UTC (rev 6077)
+++ sites/trunk/api.wordpress.org/public_html/events/1.0/tests/test-index.php 2017-11-06 21:03:28 UTC (rev 6078)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -19,6 +19,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $tests_failed = 0;
</span><span class="cx" style="display: block; padding: 0 10px"> $tests_failed += test_get_location();
</span><span class="cx" style="display: block; padding: 0 10px"> $tests_failed += test_get_events();
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $tests_failed += test_add_regional_wordcamps();
</ins><span class="cx" style="display: block; padding: 0 10px"> $tests_failed += test_build_response();
</span><span class="cx" style="display: block; padding: 0 10px"> $query_count = count( $wpdb->queries );
</span><span class="cx" style="display: block; padding: 0 10px"> $query_time = array_sum( array_column( $wpdb->queries, 1 ) );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1018,6 +1019,56 @@
</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">+ * Test `add_regional_events()`
+ *
+ * @return int
+ */
+function test_add_regional_wordcamps() {
+ $failed = 0;
+
+ $local_events = get_events( array(
+ 'number' => '5',
+ 'nearby' => array(
+ 'latitude' => '-33.849951',
+ 'longitude' => '18.426246',
+ ),
+ ) );
+
+ // Make sure there's at least one event, otherwise there could be false positives.
+ if ( ! $local_events ) {
+ $local_events[] = array( 'title' => 'Mock Event' );
+ }
+
+ printf( "\n\nRunning %d add_regional_wordcamps() tests\n", 2 );
+
+ // Test that no changes were made if the user agent isn't Core.
+ $events_no_user_agent = add_regional_wordcamps( $local_events, '' );
+
+ if ( $events_no_user_agent !== $local_events ) {
+ $failed++;
+ output_results( 'no-user-agent', false, $local_events, $events_no_user_agent );
+ }
+
+ /*
+ * Test that local events were unharmed if the user agent is Core.
+ *
+ * There isn't an easy way to mock time(), so this doesn't test that the events were added
+ * correctly. It just makes sure that local events weren't removed.
+ */
+ $events_core_user_agent = add_regional_wordcamps( $local_events, 'WordPress/4.9; https://example.org' );
+
+ if (
+ count( $events_core_user_agent ) < count( $local_events ) ||
+ ! in_array( $local_events[0], $events_core_user_agent, true )
+ ) {
+ $failed++;
+ output_results( 'core-user-agent', false, 'local events were not affected', $events_core_user_agent );
+ }
+
+ return $failed;
+}
+
+/**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Stub to simulate cache misses, so that the tests always get fresh results
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @return false
</span></span></pre>
</div>
</div>
</body>
</html>