<!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>[9107] sites/trunk/wordpress.org/public_html/wp-content/plugins/official-wordpress-events/meetup: Official WordPress Events: Tweak Meetup client to try to avoid auth token probs</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="http://meta.trac.wordpress.org/changeset/9107">9107</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/9107","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>coreymckrill</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2019-08-17 00:35:04 +0000 (Sat, 17 Aug 2019)</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: Tweak Meetup client to try to avoid auth token probs
This attempts to avoid the scenario where the client has somehow stored an
oauth token that is expired/invalid, and keeps using it for requests anyway.
Now it will try to detect when the token it has isn't working and refresh it
without breaking the current request cycle.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentpluginsofficialwordpresseventsmeetupclassapiclientphp">sites/trunk/wordpress.org/public_html/wp-content/plugins/official-wordpress-events/meetup/class-api-client.php</a></li>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentpluginsofficialwordpresseventsmeetupclassmeetupclientphp">sites/trunk/wordpress.org/public_html/wp-content/plugins/official-wordpress-events/meetup/class-meetup-client.php</a></li>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentpluginsofficialwordpresseventsmeetupclassmeetupoauth2clientphp">sites/trunk/wordpress.org/public_html/wp-content/plugins/official-wordpress-events/meetup/class-meetup-oauth2-client.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="sitestrunkwordpressorgpublic_htmlwpcontentpluginsofficialwordpresseventsmeetupclassapiclientphp"></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/meetup/class-api-client.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/meetup/class-api-client.php 2019-08-16 18:50:58 UTC (rev 9106)
+++ sites/trunk/wordpress.org/public_html/wp-content/plugins/official-wordpress-events/meetup/class-api-client.php 2019-08-17 00:35:04 UTC (rev 9107)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -38,6 +38,16 @@
</span><span class="cx" style="display: block; padding: 0 10px"> protected $breaking_response_codes = [];
</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">+ * @var string|null The URL for the current request being attempted.
+ */
+ protected $current_request_url = null;
+
+ /**
+ * @var array|null The args for the current request being attempted.
+ */
+ protected $current_request_args = null;
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * API_Client constructor.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $settings {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -85,8 +95,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $args['timeout'] = 15;
</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">+ // Set current request in state so it can be manipulated between request attempts if necessary.
+ $this->current_request_url = $url;
+ $this->current_request_args = $args;
+
</ins><span class="cx" style="display: block; padding: 0 10px"> while ( $attempt_count < $max_attempts ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $response = wp_remote_request( $url, $args );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $response = wp_remote_request( $this->current_request_url, $this->current_request_args );
</ins><span class="cx" style="display: block; padding: 0 10px"> $response_code = wp_remote_retrieve_response_code( $response );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // This is called before breaking in case a new request is made immediately.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -117,7 +131,16 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $attempt_count
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $max_attempts
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- do_action( 'api_client_tenacious_remote_request_attempt', $response, compact( 'url', 'args' ), $attempt_count, $max_attempts );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ do_action(
+ 'api_client_tenacious_remote_request_attempt',
+ $response,
+ array(
+ 'url' => $this->current_request_url,
+ 'args' => $this->current_request_args,
+ ),
+ $attempt_count,
+ $max_attempts
+ );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $attempt_count < $max_attempts ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $retry_after = wp_remote_retrieve_header( $response, 'retry-after' ) ?: 5;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -129,6 +152,10 @@
</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">+ // Reset current request.
+ $this->current_request_url = null;
+ $this->current_request_args = null;
+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( $attempt_count === $max_attempts && ( 200 !== $response_code || is_wp_error( $response ) ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> self::cli_message( "\nRequest failed $attempt_count times. Giving up." );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -224,6 +251,28 @@
</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">+ * Merge two error objects into one, new error object.
+ *
+ * @param WP_Error $error1 An error object.
+ * @param WP_Error $error2 An error object.
+ *
+ * @return WP_Error The combined errors of the two parameters.
+ */
+ protected function merge_errors( WP_Error $error1, WP_Error $error2 ) {
+ $codes = $error2->get_error_codes();
+
+ foreach ( $codes as $code ) {
+ $messages = $error2->get_error_messages( $code );
+
+ foreach ( $messages as $message ) {
+ $error1->add( $code, $message );
+ }
+ }
+
+ return $error1;
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Outputs a message when the command is run from the PHP command line.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $message
</span></span></pre></div>
<a id="sitestrunkwordpressorgpublic_htmlwpcontentpluginsofficialwordpresseventsmeetupclassmeetupclientphp"></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/meetup/class-meetup-client.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/meetup/class-meetup-client.php 2019-08-16 18:50:58 UTC (rev 9106)
+++ sites/trunk/wordpress.org/public_html/wp-content/plugins/official-wordpress-events/meetup/class-meetup-client.php 2019-08-17 00:35:04 UTC (rev 9107)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -72,15 +72,48 @@
</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><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->oauth_client = new Meetup_OAuth2_Client;
- $this->debug = $settings['debug'];
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->debug = $settings['debug'];
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $this->debug ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- self::cli_message( "Meetup Client debug is ON. Results will be truncated." );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ self::cli_message( "Meetup Client debug is on. Results will be truncated." );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ $this->oauth_client = new Meetup_OAuth2_Client;
+
+ if ( ! empty( $this->oauth_client->error->get_error_messages() ) ) {
+ $this->error = $this->merge_errors( $this->error, $this->oauth_client->error );
+ }
+
+ add_action( 'api_client_tenacious_remote_request_attempt', array( $this, 'maybe_reset_oauth_token' ) );
</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">+ * Attempt to fix authorization errors before they permanently fail.
+ *
+ * Hooked to `api_client_tenacious_remote_request_attempt` so that a request that has failed due to an invalid
+ * oauth token can be retried after resetting the token.
+ *
+ * @param array $response
+ *
+ * @return void
+ */
+ public function maybe_reset_oauth_token( $response ) {
+ $code = wp_remote_retrieve_response_code( $response );
+ $body = json_decode( wp_remote_retrieve_body( $response ), true );
+
+ if ( 400 === $code && ! empty( $body['error'] ) && 'invalid_grant' === $body['error'] ) {
+ $this->oauth_client->reset_oauth_token();
+
+ if ( ! empty( $this->oauth_client->error->get_error_messages() ) ) {
+ $this->error = $this->merge_errors( $this->error, $this->oauth_client->error );
+ }
+
+ // Reset the request headers, so that they include the new oauth token.
+ $this->current_request_args = $this->get_request_args();
+ }
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Send a paginated request to the Meetup API and return the aggregated response.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * This automatically paginates requests and will repeat requests to ensure all results are retrieved.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -122,7 +155,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $request_url = $this->get_next_url( $response );
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->handle_error_response( $response );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->handle_error_response( $response, $request_url );
</ins><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="lines" style="display: block; padding: 0 10px; color: #888">@@ -167,7 +200,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"> } else {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->handle_error_response( $response );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->handle_error_response( $response, $request_url );
</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 ( ! empty( $this->error->get_error_messages() ) ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -294,6 +327,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $error['message']
</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">+ } elseif ( isset( $data['error'], $data['error_description'] ) ) {
+ $this->error->add(
+ $data['error'],
+ $data['error_description']
+ );
</ins><span class="cx" style="display: block; padding: 0 10px"> } elseif ( isset( $data['code'] ) && isset( $data['details'] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $this->error->add(
</span><span class="cx" style="display: block; padding: 0 10px"> $data['code'],
</span></span></pre></div>
<a id="sitestrunkwordpressorgpublic_htmlwpcontentpluginsofficialwordpresseventsmeetupclassmeetupoauth2clientphp"></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/meetup/class-meetup-oauth2-client.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/meetup/class-meetup-oauth2-client.php 2019-08-16 18:50:58 UTC (rev 9106)
+++ sites/trunk/wordpress.org/public_html/wp-content/plugins/official-wordpress-events/meetup/class-meetup-oauth2-client.php 2019-08-17 00:35:04 UTC (rev 9107)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -96,6 +96,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 404, // Unable to find group
</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">+
+ // Pre-cache the oauth token.
+ $this->get_oauth_token();
</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="lines" style="display: block; padding: 0 10px; color: #888">@@ -310,6 +313,24 @@
</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">+ * Un-cache any existing oauth token and request a new one.
+ *
+ * This also resets the error property so that it has a clean slate when it attempts to request a new token.
+ *
+ * Useful if a token stops working during a batch of requests :/
+ *
+ * @return void
+ */
+ public function reset_oauth_token() {
+ delete_site_option( self::SITE_OPTION_KEY_OAUTH );
+
+ $this->oauth_token = array();
+ $this->error = new WP_Error();
+
+ $this->get_oauth_token();
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Check if a token array has the required keys.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $token The token array to check.
</span></span></pre>
</div>
</div>
</body>
</html>