<!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>[12608] sites/trunk/api.wordpress.org/public_html/dotorg/helpscout: API: Helpscout: Handle both the result of the Conversation API, and that of the payload sent with dynamic widgets.</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/12608">12608</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/12608","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:48:05 +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: Handle both the result of the Conversation API, and that of the payload sent with dynamic widgets.
Add a method to find the human readable mailbox name.</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_htmldotorghelpscoutprofilephp">sites/trunk/api.wordpress.org/public_html/dotorg/helpscout/profile.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:21:32 UTC (rev 12607)
+++ sites/trunk/api.wordpress.org/public_html/dotorg/helpscout/common.php 2023-06-01 02:48:05 UTC (rev 12608)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -103,9 +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">- $email = $request->customer->email ?? false;
- $subject = $request->ticket->subject ?? '';
- $user = get_user_by( 'email', $email );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $customer = $request->customer ?? ( $request->primaryCustomer ?? false );
+ $email = $customer->email ?? false;
+ $subject = $request->ticket->subject ?? ( $request->subject ?? '' );
+ $user = get_user_by( 'email', $email );
+ $email_id = $request->ticket->id ?? ( $request->id ?? false );
</ins><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">@@ -116,8 +118,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"> // If the customer object has alternative emails listed, check to see if they have a profile.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( ! $user && ! empty( $request->customer->emails ) ) {
- $user = get_user_from_emails( $request->customer->emails );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! $user && ! empty( $customer->emails ) ) {
+ $user = get_user_from_emails( $customer->emails );
</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"> // Ignore @wordpress.org "users", unless it's literally the only match (The ?? $email fallback at the end).
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -126,8 +128,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"> // Determine if this is a bounce, and if so, find out who for.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( ! $user && $email && isset( $request->ticket->id ) ) {
- $from = strtolower( implode( ' ', array_filter( [ $email, ( $request->customer->fname ?? false ), ( $request->customer->lname ?? false ) ] ) ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! $user && $email && $email_id ) {
+ $from = strtolower( implode( ' ', array_filter( [ $email, ( $customer->fname ?? false ), ( $customer->first ?? false ), ( $customer->lname ?? false ), ( $customer->last ?? false ) ] ) ) );
</ins><span class="cx" style="display: block; padding: 0 10px"> $subject_lower = strtolower( $subject );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if (
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -145,7 +147,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 ?? 0 );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $email_obj = get_email_thread( $email_id );
</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"> $attachment_api_urls = [];
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -251,7 +253,7 @@
</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><span class="cx" style="display: block; padding: 0 10px"> function get_plugin_or_theme_from_email( $request ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $subject = $request->ticket->subject ?? '';
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $subject = $request->subject ?? ( $request->ticket->subject ?? '' );
</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">@@ -260,7 +262,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Reported themes, shortcut, assume the slug is the title.. since it always is..
</span><span class="cx" style="display: block; padding: 0 10px"> if ( str_starts_with( $subject, 'Reported Theme:' ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $possible['themes'][] = sanitize_title_with_dashes( trim( explode( ':', $request->ticket->subject )[1] ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $possible['themes'][] = sanitize_title_with_dashes( trim( explode( ':', $subject )[1] ) );
</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"> // Plugin reviews, match the format of "[WordPress Plugin Directory] {Type Of Email}: {Plugin Title}"
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -280,7 +282,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"> // Often a slug is mentioned in the title, so let's try to extract that.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( preg_match_all( '!(?P<slug>[a-z0-9\-]{10,})!', $subject, $m ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( preg_match_all( '!\b(?P<slug>[a-z0-9\-]{10,})!', $subject, $m ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $possible['plugins'] = array_merge( $possible['plugins'], $m['slug'] );
</span><span class="cx" style="display: block; padding: 0 10px"> $possible['themes'] = array_merge( $possible['themes'], $m['slug'] );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -391,3 +393,39 @@
</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><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+/**
+ * Find the human-readable name for a mailbox ID.
+ *
+ * @param int|object $mailbox_id_or_request Mailbox ID or request object.
+ */
+function get_mailbox_name( $mailbox_id_or_request ) {
+ $constants = [
+ 'data',
+ 'jobs',
+ 'openverse',
+ 'password_resets',
+ 'photos',
+ 'plugins',
+ 'themes',
+ ];
+
+ $mailbox_id = $mailbox_id_or_request->mailboxId ?? $mailbox_id_or_request;
+ if ( ! $mailbox_id || ! is_numeric( $mailbox_id ) ) {
+ return 0;
+ }
+
+ foreach ( $constants as $constant ) {
+ if ( constant( 'HELPSCOUT_' . strtoupper( $constant ) . '_MAILBOXID' ) == $mailbox_id ) {
+ return $constant;
+ }
+ }
+
+ // Fetch the mailbox..
+ $mailbox = cached_helpscout_get( "/mailboxes/{$mailbox_id}" );
+ if ( ! $mailbox ) {
+ return $mailbox_id;
+ }
+
+ return sanitize_title( $mailbox->name );
+}
</ins></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-06-01 02:21:32 UTC (rev 12607)
+++ sites/trunk/api.wordpress.org/public_html/dotorg/helpscout/profile.php 2023-06-01 02:48:05 UTC (rev 12608)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -24,7 +24,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $html .= '<p>Forums: <a href="https://wordpress.org/support/users/'. $user->user_nicename . '/">'. $user->user_nicename .'</a></p>';
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // When the Displayed account email doesn't match the email being displayed, output the user email address too.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( ! empty( $request->customer->email ) && $request->customer->email !== $user->user_email ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! empty( $request->customer->email ) && strcasecmp( $request->customer->email, $user->user_email ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $html .= '<p>Account Email: ' . esc_html( $user->user_email ) . '</p>';
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -57,7 +57,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> '<li><a href="%s">%s <strong>%s</strong></a></li>',
</span><span class="cx" style="display: block; padding: 0 10px"> esc_url( add_query_arg( 's', urlencode( $u->user_email ), 'https://login.wordpress.org/wp-admin/admin.php?page=user-registrations&s=' ) ),
</span><span class="cx" style="display: block; padding: 0 10px"> esc_html( $u->user_login ) . (
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $request->customer->email == $u->user_email ? '' : ' (' . esc_html( $u->user_email ) . ')'
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ strcasecmp( $request->customer->email, $u->user_email ) ? ' (' . esc_html( $u->user_email ) . ')' : ''
</ins><span class="cx" style="display: block; padding: 0 10px"> ),
</span><span class="cx" style="display: block; padding: 0 10px"> esc_html( $match_status( $u ) )
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span></span></pre>
</div>
</div>
</body>
</html>