<!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>[12479] sites/trunk/api.wordpress.org/public_html/dotorg/helpscout/common.php: Helpscout: Use the Helpscout API client to validate the Webhook payloads.</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/12479">12479</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/12479","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>dd32</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2023-03-17 08:13:25 +0000 (Fri, 17 Mar 2023)</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'>Helpscout: Use the Helpscout API client to validate the Webhook payloads.
See https://github.com/WordPress/wporg-mu-plugins/commit/a2a7005bb5396382de7ab9ac6d3418954b069bf7</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#sitestrunkapiwordpressorgpublic_htmldotorghelpscoutcommonphp">sites/trunk/api.wordpress.org/public_html/dotorg/helpscout/common.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="sitestrunkapiwordpressorgpublic_htmldotorghelpscoutcommonphp"></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/dotorg/helpscout/common.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- sites/trunk/api.wordpress.org/public_html/dotorg/helpscout/common.php 2023-03-17 07:08:20 UTC (rev 12478)
+++ sites/trunk/api.wordpress.org/public_html/dotorg/helpscout/common.php 2023-03-17 08:13:25 UTC (rev 12479)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -9,13 +9,33 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // function to verify signature from HelpScout
</span><span class="cx" style="display: block; padding: 0 10px"> function is_from_helpscout( $data, $signature ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( ! defined( 'HELPSCOUT_SECRET_KEY' ) || ! $signature ) {
- return false;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $instances = [ 'wordpress', 'foundation' ];
+
+ foreach ( $instances as $instance ) {
+ $client = get_client( $instance );
+
+ if ( $client && $client->validate_webhook_signature( $data, $signature ) ) {
+ define( 'HELPSCOUT_WEBHOOK_INSTANCE', $instance->name );
+
+ return true;
+ }
</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">- $calculated = base64_encode( hash_hmac( 'sha1', $data, HELPSCOUT_SECRET_KEY, true ) );
</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><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return hash_equals( $signature, $calculated );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+/**
+ * Fetch the appropriate HelpScout API client.
+ *
+ * @param string $instance The instance to fetch. Accepts 'wordpress', 'foundation', from ?instance=..., or if a webhook based on the calling webhook secret.
+ * @return HelpScout
+ */
+function get_client( $instance = false ) {
+ if ( ! $instance && defined( 'HELPSCOUT_WEBHOOK_INSTANCE' ) ) {
+ $instance = HELPSCOUT_WEBHOOK_INSTANCE;
+ }
+
+ return Helpscout::instance( $instance );
</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">@@ -24,15 +44,22 @@
</span><span class="cx" style="display: block; padding: 0 10px"> function get_email_thread( $thread_id, $force = false ) {
</span><span class="cx" style="display: block; padding: 0 10px"> wp_cache_add_global_groups( 'helpscout-thread' );
</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 ( $thread = wp_cache_get( $thread_id, 'helpscout-thread' ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! $thread_id ) {
+ return false;
+ }
+
+ $client = get_client();
+ $cache_key = "{$client->name}:{$thread_id}";
+
+ if ( $thread = wp_cache_get( $cache_key, 'helpscout-thread' ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( ! $force ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return $thread;
</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">- $email_obj = Helpscout::instance()->get( '/v2/conversations/' . $thread_id . '?embed=threads' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $email_obj = $client->get( '/v2/conversations/' . $thread_id . '?embed=threads' );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- wp_cache_set( $thread_id, $email_obj, 'helpscout-thread', 6 * HOUR_IN_SECONDS );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ wp_cache_set( $cache_key, $email_obj, 'helpscout-thread', 6 * HOUR_IN_SECONDS );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> return $email_obj;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -87,9 +114,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> str_contains( $subject_lower, 'mail delivery failure' )
</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">-
</del><span class="cx" style="display: block; padding: 0 10px"> // Fetch the email.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $email_obj = get_email_thread( $request->ticket->id );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $email_obj = get_email_thread( $request->ticket->id ?? 0 );
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( ! empty( $email_obj->_embedded->threads ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $email_obj->_embedded->threads as $thread ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( 'customer' !== $thread->type ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -169,7 +195,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"> // Fetch the email.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $email_obj = get_email_thread( $request->ticket->id );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $email_obj = get_email_thread( $request->ticket->id ?? 0 );
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( ! empty( $email_obj->_embedded->threads ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $email_obj->_embedded->threads as $thread ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( empty( $thread->body ) ) {
</span></span></pre>
</div>
</div>
</body>
</html>