<!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>[4364] sites/trunk/wordcamp.org/public_html/wp-content/plugins/camptix-badge-generator/includes/indesign-badges.php: CampTix Badge Generator: Retry failed download attempts to avoid ruining batch</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/4364">4364</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/4364","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>2016-11-15 23:51:56 +0000 (Tue, 15 Nov 2016)</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'>CampTix Badge Generator: Retry failed download attempts to avoid ruining batch</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#sitestrunkwordcamporgpublic_htmlwpcontentpluginscamptixbadgegeneratorincludesindesignbadgesphp">sites/trunk/wordcamp.org/public_html/wp-content/plugins/camptix-badge-generator/includes/indesign-badges.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="sitestrunkwordcamporgpublic_htmlwpcontentpluginscamptixbadgegeneratorincludesindesignbadgesphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: sites/trunk/wordcamp.org/public_html/wp-content/plugins/camptix-badge-generator/includes/indesign-badges.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- sites/trunk/wordcamp.org/public_html/wp-content/plugins/camptix-badge-generator/includes/indesign-badges.php 2016-11-15 20:49:18 UTC (rev 4363)
+++ sites/trunk/wordcamp.org/public_html/wp-content/plugins/camptix-badge-generator/includes/indesign-badges.php 2016-11-15 23:51:56 UTC (rev 4364)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -72,25 +72,70 @@
</span><span class="cx" style="display: block; padding: 0 10px"> continue;
</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">- $request_url = str_replace( '=blank', '=404', $attendee->avatar_url );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $request_url = str_replace( '=blank', '=404', $attendee->avatar_url );
+ $gravatar_image = download_single_gravatar( $request_url );
+
+ if ( ! $gravatar_image ) {
+ continue;
+ }
+
+ $filename = get_gravatar_filename( $attendee );
+ $gravatar_file = fopen( $gravatar_folder . '/' . $filename, 'w' );
+
+ if ( ! $gravatar_file ) {
+ Logger\log( 'gravatar_open_failed', compact( 'attendee', 'gravatar_folder', 'filename' ) );
+ throw new \Exception( __( "Couldn't save all Gravatars.", 'wordcamporg' ) );
+ }
+
+ fwrite( $gravatar_file, $gravatar_image );
+ fclose( $gravatar_file );
+ }
+}
+
+/**
+ * Download a Gravatar
+ *
+ * Sometimes the HTTP request times out, or Varnish returns a `503` error, but the batch will be ruined if even a
+ * single existing Gravatar cannot be downloaded successfully. In order to mitigate that, we retry the download
+ * multiple times.
+ *
+ * @param string $request_url
+ *
+ * @return bool|string `false` when the user does not have a Gravatar, `string` of image binary data when the
+ * image was successfully retrieved.
+ *
+ * @throws \Exception when the HTTP failed even after multiple attempts
+ */
+function download_single_gravatar( $request_url ) {
+ $attempt_count = 1;
+
+ while ( true ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $response = wp_remote_get( $request_url );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $status_code = wp_remote_retrieve_response_code( $response );
</ins><span class="cx" style="display: block; padding: 0 10px"> $image = wp_remote_retrieve_body( $response );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $status_code = wp_remote_retrieve_response_code( $response );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $retry_after = wp_remote_retrieve_header( $response, 'retry-after' ) ?: 5;
+ $retry_after = min( $retry_after * $attempt_count, 30 );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // A 404 is expected when the attendee doesn't have a Gravatar setup, so don't retry them
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( 404 == $status_code ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- continue;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return false;
</ins><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">- if ( ! $image || 200 != $status_code ) {
- Logger\log( 'request_failed', compact( 'attendee', 'request_url', 'response' ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! is_wp_error( $response ) && $image ) {
+ return $image;
+ }
+
+ $response['body'] = '[redacted]'; // Avoid cluttering the logs with a ton of binary data
+
+ if ( $attempt_count < 3 ) {
+ Logger\log( 'request_failed_temporarily', compact( 'attendee', 'request_url', 'response', 'attempt_count', 'retry_after' ) );
+ sleep( $retry_after );
+ } else {
+ Logger\log( 'request_failed_permenantly', compact( 'attendee', 'request_url', 'response' ) );
</ins><span class="cx" style="display: block; padding: 0 10px"> throw new \Exception( __( "Couldn't download all Gravatars.", 'wordcamporg' ) );
</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">- $filename = get_gravatar_filename( $attendee );
- $gravatar_file = fopen( $gravatar_folder . '/' . $filename, 'w' );
-
- fwrite( $gravatar_file, $image );
- fclose( $gravatar_file );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $attempt_count++;
</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>