<!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>[12609] sites/trunk/api.wordpress.org/public_html/dotorg/helpscout: API: Helpscout: Keep a DB table of Helpscout emails for querying.</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/12609">12609</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/12609","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 06:29:45 +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: Keep a DB table of Helpscout emails for querying.</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_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-06-01 02:48:05 UTC (rev 12608)
+++ sites/trunk/api.wordpress.org/public_html/dotorg/helpscout/common.php 2023-06-01 06:29:45 UTC (rev 12609)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -103,11 +103,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Get the user associated with a HelpScout email.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function get_user_email_for_email( $request ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $customer = $request->customer ?? ( $request->primaryCustomer ?? false );
- $email = $customer->email ?? false;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $email_id = $request->ticket->id ?? ( $request->id ?? false );
</ins><span class="cx" style="display: block; padding: 0 10px"> $subject = $request->ticket->subject ?? ( $request->subject ?? '' );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $customer = $request->customer ?? ( $request->primaryCustomer ?? false );
+ $email = $customer->email ?? false;
</ins><span class="cx" style="display: block; padding: 0 10px"> $user = get_user_by( 'email', $email );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $email_id = $request->ticket->id ?? ( $request->id ?? false );
</del><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // If this is related to a slack user, fetch their details instead.
</span><span class="cx" style="display: block; padding: 0 10px"> if (
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -147,11 +147,11 @@
</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( $email_id );
- if ( ! empty( $email_obj->_embedded->threads ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $threads = $request->_embedded->threads ?? ( get_email_thread( $email_id )->_embedded->threads ?? [] );
+ if ( $threads ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $attachment_api_urls = [];
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- foreach ( $email_obj->_embedded->threads as $thread ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ foreach ( $threads as $thread ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( 'customer' !== $thread->type ) {
</span><span class="cx" style="display: block; padding: 0 10px"> continue;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -252,8 +252,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Get the possible plugins or themes from the email.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-function get_plugin_or_theme_from_email( $request ) {
- $subject = $request->subject ?? ( $request->ticket->subject ?? '' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+function get_plugin_or_theme_from_email( $request, $validate_slugs = false ) {
+ $subject = $request->subject ?? ( $request->ticket->subject ?? '' );
+ $email_id = $request->id ?? ( $request->ticket->id ?? 0 );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $possible = [
</span><span class="cx" style="display: block; padding: 0 10px"> 'themes' => [],
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -281,12 +282,6 @@
</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">- // Often a slug is mentioned in the title, so let's try to extract that.
- if ( preg_match_all( '!\b(?P<slug>[a-z0-9\-]{10,})!', $subject, $m ) ) {
- $possible['plugins'] = array_merge( $possible['plugins'], $m['slug'] );
- $possible['themes'] = array_merge( $possible['themes'], $m['slug'] );
- }
-
</del><span class="cx" style="display: block; padding: 0 10px"> $regexes = [
</span><span class="cx" style="display: block; padding: 0 10px"> '!/([^/]+\.)?wordpress.org/(?<type>plugins|themes)/(?P<slug>[a-z0-9-]+)/?!im',
</span><span class="cx" style="display: block; padding: 0 10px"> '!(?P<type>Plugin|Theme):\s*(?P<slug>[a-z0-9-]+)$!im',
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -293,10 +288,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> '!(?P<type>plugins|themes)\.(trac|svn)\.wordpress\.org/(browser/)?(?P<slug>[a-z0-9-]+)!im',
</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">- // Fetch the email.
- $email_obj = get_email_thread( $request->ticket->id ?? 0 );
- if ( ! empty( $email_obj->_embedded->threads ) ) {
- foreach ( $email_obj->_embedded->threads as $thread ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Fetch the email threads.
+ $threads = $request->_embedded->threads ?? ( get_email_thread( $email_id )->_embedded->threads ?? [] );
+ if ( $threads ) {
+ foreach ( $threads as $thread ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( empty( $thread->body ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> continue;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -326,9 +321,46 @@
</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">+ // Often a slug is mentioned in the title, so let's try to extract that if we didn't find a better item.
+ if ( preg_match_all( '!\b(?P<slug>[a-z0-9\-]{10,})\b!', $subject, $m ) ) {
+ if ( ! $possible['plugins'] ) {
+ $possible['plugins'] = array_merge( $possible['plugins'], $m['slug'] );
+ }
+
+ if ( ! $possible['themes'] ) {
+ $possible['themes'] = array_merge( $possible['themes'], $m['slug'] );
+ }
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $possible['themes'] = array_unique( $possible['themes'] );
</span><span class="cx" style="display: block; padding: 0 10px"> $possible['plugins'] = array_unique( $possible['plugins'] );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // If we only want valid slugs back, better validate them..
+ if ( $validate_slugs ) {
+ if ( $possible['themes'] ) {
+ switch_to_blog( WPORG_THEME_DIRECTORY_BLOGID );
+ $themes = get_posts( [
+ 'post_name__in' => $possible['themes'],
+ 'post_type' => 'repopackage',
+ 'post_status' => 'any',
+ ] );
+ restore_current_blog();
+
+ $possible['themes'] = wp_list_pluck( $themes, 'post_name' );
+ }
+ if ( $possible['plugins'] ) {
+ switch_to_blog( WPORG_PLUGIN_DIRECTORY_BLOGID );
+ $plugins = get_posts( [
+ 'post_name__in' => $possible['plugins'],
+ 'post_type' => 'plugin',
+ 'post_status' => 'any',
+ ] );
+ restore_current_blog();
+
+ $possible['plugins'] = wp_list_pluck( $plugins, 'post_name' );
+ }
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> return array_filter( $possible );
</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">@@ -429,3 +461,86 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> return sanitize_title( $mailbox->name );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+/**
+ * Keep a cached copy of the received emails in the database for querying.
+ *
+ * @param object $request Helpscout request object / Conversation object.
+ */
+function log_email( $request ) {
+ global $wpdb;
+
+ if ( empty( $request->id ) ) {
+ return;
+ }
+
+ $row = $wpdb->get_row( $wpdb->prepare( 'SELECT * FROM %i WHERE id = %d', "{$wpdb->base_prefix}helpscout", $request->id ) );
+ $meta = $row ? $wpdb->get_results( $wpdb->prepare( 'SELECT meta_key, meta_value FROM %i WHERE helpscout_id = %d', "{$wpdb->base_prefix}helpscout_meta", $request->id ), ARRAY_A ) : [];
+
+ // We don't need to know about spam.
+ if ( 'spam' === $request->status ) {
+ if ( $row ) {
+ $wpdb->delete( 'wporg_helpscout', [ 'id' => $request->id ] );
+ $wpdb->delete( 'wporg_helpscout_meta', [ 'helpscout_id' => $request->id ] );
+ }
+ return;
+ }
+
+ foreach ( get_plugin_or_theme_from_email( $request, true ) as $type => $slugs ) {
+ foreach ( $slugs as $slug ) {
+ if ( ! wp_list_filter( $meta, [ 'meta_key' => $type, 'meta_value' => $slug ] ) ) {
+ $meta[] = [
+ 'meta_key' => $type,
+ 'meta_value' => $slug,
+ ];
+ }
+ }
+ }
+
+ $user_id = $row->user_id ?? 0;
+ if ( ! $user_id ) {
+ $user_email = get_user_email_for_email( $request );
+ if ( $user_email ) {
+ $user_id = get_user_by( 'email', $user_email )->ID ?? 0;
+ }
+ }
+
+ $email = $request->primaryCustomer->email ?? ( $row->email ?? '' );
+ $name = '';
+ if ( ! empty( $request->primaryCustomer ) ) {
+ $name = $request->primaryCustomer->first ?? '';
+ $name .= ' ' . ( $request->primaryCustomer->last ?? '' );
+ $name = trim( $name );
+ }
+ $email = $name ? "{$name} <{$email}>" : $email;
+
+ $data = [
+ 'id' => $request->id,
+ 'number' => $request->number,
+ 'user_id' => $user_id,
+ 'mailbox' => get_mailbox_name( $request->mailboxId ),
+ 'status' => $request->status,
+ 'email' => $email,
+ 'subject' => $request->subject ?? ( $row->subject ?? '' ),
+ 'preview' => $request->preview ?? ( $row->preview ?? '' ),
+ 'created' => gmdate( 'Y-m-d H:i:s', strtotime( $request->createdAt ) ),
+ 'closed' => empty( $request->closedAt ) ? '' : gmdate( 'Y-m-d H:i:s', strtotime( $request->closedAt ) ),
+ 'modified' => gmdate( 'Y-m-d H:i:s', max( array_filter( [ strtotime( $request->createdAt ), strtotime( $request->userUpdatedAt ), strtotime( $request->closedAt ?? '' ) ] ) ) ),
+ ];
+
+ if ( $row ) {
+ $wpdb->update( "{$wpdb->base_prefix}helpscout", $data, [ 'id' => $data['id'] ] );
+ } else {
+ $wpdb->insert( "{$wpdb->base_prefix}helpscout", $data );
+ }
+
+ foreach ( $meta as $kv ) {
+ $wpdb->query( $wpdb->prepare(
+ 'INSERT INTO %i ( helpscout_id, meta_key, meta_value ) VALUES ( %d, %s, %s ) ON DUPLICATE KEY UPDATE meta_value = VALUES( meta_value )',
+ "{$wpdb->base_prefix}helpscout_meta",
+ $data['id'],
+ $kv['meta_key'],
+ $kv['meta_value']
+ ) );
+ }
+}
</ins></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-06-01 02:48:05 UTC (rev 12608)
+++ sites/trunk/api.wordpress.org/public_html/dotorg/helpscout/webhook.php 2023-06-01 06:29:45 UTC (rev 12609)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -19,6 +19,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // Record stats.
</span><span class="cx" style="display: block; padding: 0 10px"> contributor_stats( $event, $request );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+// Record the email in the database.
+if ( str_starts_with( $event, 'convo.' ) ) {
+ log_email( $request );
+}
+
</ins><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Ping the Openverse webhook.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span></span></pre>
</div>
</div>
</body>
</html>