<!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>[12607] sites/trunk/api.wordpress.org/public_html/dotorg/helpscout: API: Helpscout: Cleanup the code and allow the functions to be used within a CLI script.</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/12607">12607</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/12607","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-06-01 02:21:32 +0000 (Thu, 01 Jun 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'>API: Helpscout: Cleanup the code and allow the functions to be used within a CLI script.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#sitestrunkapiwordpressorgpublic_htmldotorghelpscoutcommonphp">sites/trunk/api.wordpress.org/public_html/dotorg/helpscout/common.php</a></li>
<li><a href="#sitestrunkapiwordpressorgpublic_htmldotorghelpscoutdpophp">sites/trunk/api.wordpress.org/public_html/dotorg/helpscout/dpo.php</a></li>
<li><a href="#sitestrunkapiwordpressorgpublic_htmldotorghelpscoutforumsphp">sites/trunk/api.wordpress.org/public_html/dotorg/helpscout/forums.php</a></li>
<li><a href="#sitestrunkapiwordpressorgpublic_htmldotorghelpscoutpluginsthemesphp">sites/trunk/api.wordpress.org/public_html/dotorg/helpscout/plugins-themes.php</a></li>
<li><a href="#sitestrunkapiwordpressorgpublic_htmldotorghelpscoutprofilephp">sites/trunk/api.wordpress.org/public_html/dotorg/helpscout/profile.php</a></li>
<li><a href="#sitestrunkapiwordpressorgpublic_htmldotorghelpscoutwebhookphp">sites/trunk/api.wordpress.org/public_html/dotorg/helpscout/webhook.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-05-31 00:47:22 UTC (rev 12606)
+++ sites/trunk/api.wordpress.org/public_html/dotorg/helpscout/common.php 2023-06-01 02:21:32 UTC (rev 12607)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1,12 +1,39 @@
</span><span class="cx" style="display: block; padding: 0 10px"> <?php
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+namespace WordPressdotorg\API\HelpScout;
</ins><span class="cx" style="display: block; padding: 0 10px"> use WordPressdotorg\MU_Plugins\Utilities\HelpScout;
</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 ( ! isset( $wp_init_host ) ) {
- $wp_init_host = 'https://api.wordpress.org/';
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+/**
+ * Load WordPress.
+ */
+function load_wordpress( $wp_init_host = '' ) {
+ if ( ! $wp_init_host ) {
+ $wp_init_host = 'https://api.wordpress.org/';
+ }
+
+ $base_dir = dirname( dirname( __DIR__ ) );
+ require( $base_dir . '/wp-init.php' );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-$base_dir = dirname( dirname( __DIR__ ) );
-require( $base_dir . '/wp-init.php' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+// Always load WordPress, if WordPress is not loaded.
+if ( ! defined( 'ABSPATH' ) ) {
+ load_wordpress( $wp_init_host ?? '' );
+}
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+/**
+ * Retrieve the incoming payload, and verify it's from HelpScout.
+ */
+function get_request() {
+ // HelpScout sends json data in the POST, so grab it from the input directly.
+ $HTTP_RAW_POST_DATA = file_get_contents( 'php://input' );
+
+ // Check the signature matches.
+ if ( ! is_from_helpscout( $HTTP_RAW_POST_DATA, $_SERVER['HTTP_X_HELPSCOUT_SIGNATURE'] ?? '' ) ) {
+ exit;
+ }
+
+ // get the info from HS.
+ return json_decode( $HTTP_RAW_POST_DATA );
+}
+
</ins><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><span class="cx" style="display: block; padding: 0 10px"> $instances = [ 'wordpress', 'foundation' ];
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -364,14 +391,3 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> return $user;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-
-// HelpScout sends json data in the POST, so grab it from the input directly.
-$HTTP_RAW_POST_DATA = file_get_contents( 'php://input' );
-
-// Check the signature matches.
-if ( ! is_from_helpscout( $HTTP_RAW_POST_DATA, $_SERVER['HTTP_X_HELPSCOUT_SIGNATURE'] ?? '' ) ) {
- exit;
-}
-
-// get the info from HS.
-return json_decode( $HTTP_RAW_POST_DATA );
</del></span></pre></div>
<a id="sitestrunkapiwordpressorgpublic_htmldotorghelpscoutdpophp"></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/dpo.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/dpo.php 2023-05-31 00:47:22 UTC (rev 12606)
+++ sites/trunk/api.wordpress.org/public_html/dotorg/helpscout/dpo.php 2023-06-01 02:21:32 UTC (rev 12607)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1,9 +1,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> <?php
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+namespace WordPressdotorg\API\HelpScout;
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // Add current DPO Export/Erasure status for the customer.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+$wp_init_host = 'https://wordpress.org/'; // DPO site.
+include __DIR__ . '/common.php';
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // $request is the validated HelpScout request.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-$wp_init_host = 'https://wordpress.org/'; // DPO site.
-$request = include __DIR__ . '/common.php';
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+$request = get_request();
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( empty( $request->customer->email ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> die( json_encode( [ 'html' => 'No email found' ] ) );
</span></span></pre></div>
<a id="sitestrunkapiwordpressorgpublic_htmldotorghelpscoutforumsphp"></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/forums.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/forums.php 2023-05-31 00:47:22 UTC (rev 12606)
+++ sites/trunk/api.wordpress.org/public_html/dotorg/helpscout/forums.php 2023-06-01 02:21:32 UTC (rev 12607)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1,8 +1,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> <?php
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+namespace WordPressdotorg\API\HelpScout;
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // Simple User Notes sidebar panel.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+include __DIR__ . '/common.php';
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // $request is the validated HelpScout request.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-$request = include __DIR__ . '/common.php';
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+$request = get_request();
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // default empty output
</span><span class="cx" style="display: block; padding: 0 10px"> $html = '';
</span></span></pre></div>
<a id="sitestrunkapiwordpressorgpublic_htmldotorghelpscoutpluginsthemesphp"></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/plugins-themes.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/plugins-themes.php 2023-05-31 00:47:22 UTC (rev 12606)
+++ sites/trunk/api.wordpress.org/public_html/dotorg/helpscout/plugins-themes.php 2023-06-01 02:21:32 UTC (rev 12607)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -21,8 +21,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">+include __DIR__ . '/common.php';
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // $request is the validated HelpScout request.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-$request = include __DIR__ . '/common.php';
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+$request = get_request();
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // default empty output
</span><span class="cx" style="display: block; padding: 0 10px"> ob_start();
</span></span></pre></div>
<a id="sitestrunkapiwordpressorgpublic_htmldotorghelpscoutprofilephp"></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/profile.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/profile.php 2023-05-31 00:47:22 UTC (rev 12606)
+++ sites/trunk/api.wordpress.org/public_html/dotorg/helpscout/profile.php 2023-06-01 02:21:32 UTC (rev 12607)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1,8 +1,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> <?php
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+namespace WordPressdotorg\API\HelpScout;
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // Simple profile lookup for HelpScout sidebar. Returns w.org links to HS for emails received.
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+include __DIR__ . '/common.php';
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // $request is the validated HelpScout request.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-$request = include __DIR__ . '/common.php';
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+$request = get_request();
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // default empty output
</span><span class="cx" style="display: block; padding: 0 10px"> $html = '';
</span></span></pre></div>
<a id="sitestrunkapiwordpressorgpublic_htmldotorghelpscoutwebhookphp"></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/webhook.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/webhook.php 2023-05-31 00:47:22 UTC (rev 12606)
+++ sites/trunk/api.wordpress.org/public_html/dotorg/helpscout/webhook.php 2023-06-01 02:21:32 UTC (rev 12607)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -4,8 +4,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // Webhook fired when an event is fired for any inbox.
</span><span class="cx" style="display: block; padding: 0 10px"> // Events: Conversation Created (convo.created), convo.assigned, convo.customer.reply.created, convo.merged, convo.agent.reply.created, convo.deleted, convo.status, convo.moved
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+include __DIR__ . '/common.php';
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // $request is the validated HelpScout request.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-$request = include __DIR__ . '/common.php';
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+$request = get_request();
</ins><span class="cx" style="display: block; padding: 0 10px"> $event = $_SERVER['HTTP_X_HELPSCOUT_EVENT'] ?? '';
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Handle the openverse webhook.
</span></span></pre>
</div>
</div>
</body>
</html>