<!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>[3156] sites/trunk/wordcamp.org/public_html/wp-content: WordCamp QBO: Log remote requests to aid in troubleshooting.</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/3156">3156</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/3156","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-05-17 00:32:00 +0000 (Tue, 17 May 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'>WordCamp QBO: Log remote requests to aid in troubleshooting.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#sitestrunkwordcamporgpublic_htmlwpcontentpluginswordcampqbowordcampqbophp">sites/trunk/wordcamp.org/public_html/wp-content/plugins/wordcamp-qbo/wordcamp-qbo.php</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li><a href="#sitestrunkwordcamporgpublic_htmlwpcontentmuplugins0loggerphp">sites/trunk/wordcamp.org/public_html/wp-content/mu-plugins/0-logger.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="sitestrunkwordcamporgpublic_htmlwpcontentmuplugins0loggerphp"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: sites/trunk/wordcamp.org/public_html/wp-content/mu-plugins/0-logger.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/mu-plugins/0-logger.php (rev 0)
+++ sites/trunk/wordcamp.org/public_html/wp-content/mu-plugins/0-logger.php 2016-05-17 00:32:00 UTC (rev 3156)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,68 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+
+namespace WordCamp\Logger;
+defined( 'WPINC' ) or die();
+
+/**
+ * Log an event, with optional additional data
+ *
+ * SECURITY WARNING: You must redact any sensitive info before it's written to the log file. The best way to do
+ * that is to add entries to wcorg_log_redact_keys(), so that the caller remain clean. You can also do it before
+ * passing the data to this function, though. Right now this only redacts array keys, but it can be made more
+ * sophisticated in the future to handle additional cases.
+ *
+ * In the future, it may be helpful to decode JSON values and search them for redactable values, and to allow
+ * the caller to pass an array of strings that are sensitive and should be redacted. The latter would allow for
+ * redacting values that aren't known until runtime, and could be helpful in other cases too.
+ *
+ * @param string $error_code
+ * @param array $data
+ */
+function log( $error_code, $data = array() ) {
+ $backtrace = debug_backtrace( DEBUG_BACKTRACE_PROVIDE_OBJECT, 2 );
+
+ if ( $data && ! is_scalar( $data ) ) {
+ $data = (array) $data;
+ redact_keys( $data );
+ $data = str_replace( "\n", '[newline]', serialize( $data ) );
+ }
+
+ $log_entry = sprintf(
+ '%s:%s - %s:%s%s',
+ basename( $backtrace[0]['file'] ),
+ $backtrace[0]['line'],
+ $backtrace[1]['function'],
+ $error_code,
+ $data ? ' - ' . $data : ''
+ );
+
+ error_log( $log_entry );
+}
+
+/**
+ * Redact sensitive values from log entries
+ *
+ * @param array $data
+ *
+ * @return array
+ */
+function redact_keys( & $data ) {
+ $redacted_keys = array( 'Authorization' );
+ $redacted_keys = array_map( 'strtolower', $redacted_keys ); // to avoid human error
+
+ foreach ( $data as $key => $value ) {
+ if ( is_object( $value ) ) {
+ $value = (array) $value;
+ }
+
+ if ( in_array( strtolower( $key ), $redacted_keys, true ) ) {
+ $data[ $key ] = '[redacted]';
+ }
+
+ if ( is_array( $value ) ) {
+ $data[ $key ] = redact_keys( $value );
+ }
+ }
+
+ return $data;
+}
</ins></span></pre></div>
<a id="sitestrunkwordcamporgpublic_htmlwpcontentpluginswordcampqbowordcampqbophp"></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/wordcamp-qbo/wordcamp-qbo.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/wordcamp-qbo/wordcamp-qbo.php 2016-05-16 21:44:45 UTC (rev 3155)
+++ sites/trunk/wordcamp.org/public_html/wp-content/plugins/wordcamp-qbo/wordcamp-qbo.php 2016-05-17 00:32:00 UTC (rev 3156)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3,6 +3,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Plugin Name: WordCamp.org QBO Integration
</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">+use WordCamp\Logger;
+
</ins><span class="cx" style="display: block; padding: 0 10px"> class WordCamp_QBO {
</span><span class="cx" style="display: block; padding: 0 10px"> const REMOTE_REQUEST_TIMEOUT = 10; // seconds
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -178,6 +180,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'Accept' => 'application/json',
</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">+ Logger\log( 'remote_request_sync_token', compact( 'response' ) );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( is_wp_error( $response ) || wp_remote_retrieve_response_code( $response ) != 200 )
</span><span class="cx" style="display: block; padding: 0 10px"> return new WP_Error( 'error', 'Could not find purchase to update.' );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -204,6 +207,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'body' => $payload,
</span><span class="cx" style="display: block; padding: 0 10px"> ) );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ Logger\log( 'remote_request_create_expense', compact( 'payload', 'response' ) );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( is_wp_error( $response ) || wp_remote_retrieve_response_code( $response ) != 200 )
</span><span class="cx" style="display: block; padding: 0 10px"> return new WP_Error( 'error', 'Could not create purchase.' );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -266,6 +270,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"> );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ Logger\log( 'remote_request', compact( 'args', 'response' ) );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( is_wp_error( $response ) || wp_remote_retrieve_response_code( $response ) !== 200 ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return new WP_Error( 'error', 'Could not fetch classes.' );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -357,6 +362,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"> $response = wp_remote_post( $qbo_request['url'], $qbo_request['args'] );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ Logger\log( 'remote_request', compact( 'qbo_request', 'response' ) );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( is_wp_error( $response ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $result = $response;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -545,6 +551,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> protected static function send_invoice( $invoice_id ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $qbo_request = self::build_qbo_send_invoice_request( $invoice_id );
</span><span class="cx" style="display: block; padding: 0 10px"> $response = wp_remote_post( $qbo_request['url'], $qbo_request['args'] );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ Logger\log( 'remote_request', compact( 'qbo_request', 'response' ) );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( is_wp_error( $response ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $result = $response;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -627,6 +634,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $valid_pdf_footer = '%%EOF' === substr( $body, strlen( $body ) - 7, 5 );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $valid_pdf_header && $valid_pdf_footer ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $response['body'] = '[valid pdf body removed]'; // because the binary contents aren't printable
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $filename = sprintf(
</span><span class="cx" style="display: block; padding: 0 10px"> '%sWPCS-invoice-%d.pdf',
</span><span class="cx" style="display: block; padding: 0 10px"> get_temp_dir(),
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -643,6 +652,8 @@
</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">+ Logger\log( 'remote_request', compact( 'qbo_request', 'response' ) ); // call after processing response, because body is removed if pdf is valid
+
</ins><span class="cx" style="display: block; padding: 0 10px"> return $result;
</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">@@ -741,6 +752,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"> $response = wp_remote_get( $qbo_request['url'], $qbo_request['args'] );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ Logger\log( 'remote_request', compact( 'qbo_request', 'response' ) );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( is_wp_error( $response ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $result = $response;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -847,6 +859,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"> $response = wp_remote_post( $qbo_request['url'], $qbo_request['args'] );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ Logger\log( 'remote_request', compact( 'qbo_request', 'response' ) );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( is_wp_error( $response ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $result = $response;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -969,6 +982,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"> $response = wp_remote_get( $qbo_request['url'], $qbo_request['args'] );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ Logger\log( 'remote_request', compact( 'qbo_request', 'response' ) );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( is_wp_error( $response ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $result = $response;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1148,6 +1162,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'Accept' => 'application/json',
</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">+ Logger\log( 'remote_request', compact( 'response' ) );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( is_wp_error( $response ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> wp_die( 'Could not obtain company information.' );
</span></span></pre>
</div>
</div>
</body>
</html>