<!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>[13115] sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/shortcodes/class-upload-handler.php: Plugin Directory: Submission: When a pending plugin has a new ZIP uploaded, instruct the author to email the team, but also re-open the ticket with a note about the new upload.</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/13115">13115</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/13115","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>2024-01-16 05:10:27 +0000 (Tue, 16 Jan 2024)</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'>Plugin Directory: Submission: When a pending plugin has a new ZIP uploaded, instruct the author to email the team, but also re-open the ticket with a note about the new upload.
See <a href="http://meta.trac.wordpress.org/ticket/7384">#7384</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentpluginsplugindirectoryshortcodesclassuploadhandlerphp">sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/shortcodes/class-upload-handler.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="sitestrunkwordpressorgpublic_htmlwpcontentpluginsplugindirectoryshortcodesclassuploadhandlerphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/shortcodes/class-upload-handler.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/shortcodes/class-upload-handler.php 2024-01-16 05:05:42 UTC (rev 13114)
+++ sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/shortcodes/class-upload-handler.php 2024-01-16 05:10:27 UTC (rev 13115)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -7,6 +7,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> use WordPressdotorg\Plugin_Directory\Plugin_Directory;
</span><span class="cx" style="display: block; padding: 0 10px"> use WordPressdotorg\Plugin_Directory\Tools\Filesystem;
</span><span class="cx" style="display: block; padding: 0 10px"> use WordPressdotorg\Plugin_Directory\Admin\Tools\Upload_Token;
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+use WordPressdotorg\Plugin_Directory\Clients\HelpScout;
</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"> * The [wporg-plugin-upload] shortcode handler to display a plugin uploader.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -466,10 +467,20 @@
</span><span class="cx" style="display: block; padding: 0 10px"> do_action( 'plugin_upload', $this->plugin, $plugin_post );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $updating_existing ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return sprintf(
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ // Update HelpScout, if in review.
+ $this->update_review_email( $plugin_post, $attachment );
+
+ $message = sprintf(
</ins><span class="cx" style="display: block; padding: 0 10px"> __( 'New version of %s uploaded for review.', 'wporg-plugins' ),
</span><span class="cx" style="display: block; padding: 0 10px"> esc_html( $this->plugin['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">+
+ if ( 'pending' === $plugin_post->post_status ) {
+ $message .= '<br>' . __( 'Please respond to the review email to let us know, and address any feedback that was given to you.', 'wporg-plugins' );
+ }
+
+ return $message;
</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"> // Send plugin author an email for peace of mind.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -785,7 +796,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Saves zip file and attaches it to the plugin post.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $post_id Post ID.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return int|WP_Error Attachment ID or upload error.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return WP_Post|WP_Error Attachment post or upload error.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function save_zip_file( $post_id ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $zip_hash = sha1_file( $_FILES['zip_file']['tmp_name'] );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -805,21 +816,23 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'post_title' => sprintf( '%s Version %s', $this->plugin['Name'], $this->plugin['Version'] ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'post_excerpt' => $this->plugin['Description'],
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $attachment_id = media_handle_upload( 'zip_file', $post_id, $post_details );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $attachment = media_handle_upload( 'zip_file', $post_id, $post_details );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> remove_filter( 'site_option_upload_filetypes', array( $this, 'whitelist_zip_files' ) );
</span><span class="cx" style="display: block; padding: 0 10px"> remove_filter( 'default_site_option_upload_filetypes', array( $this, 'whitelist_zip_files' ) );
</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 ( ! is_wp_error( $attachment_id ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! is_wp_error( $attachment ) ) {
+ $attachment = get_post( $attachment );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // Save some basic details with the ZIP.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- update_post_meta( $attachment_id, 'version', $this->plugin['Version'] );
- update_post_meta( $attachment_id, 'submitted_name', $original_name );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ update_post_meta( $attachment->ID, 'version', $this->plugin['Version'] );
+ update_post_meta( $attachment->ID, 'submitted_name', $original_name );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // And record this ZIP as having been uploaded.
</span><span class="cx" style="display: block; padding: 0 10px"> add_post_meta( $post_id, 'uploaded_zip_hash', $zip_hash );
</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">- return $attachment_id;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return $attachment;
</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">@@ -892,4 +905,73 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return $token && Upload_Token::instance()->is_valid_for_user( get_current_user_id(), $token );
</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">+ /**
+ * Locate the HelpScout review email and it's status.
+ *
+ * @param WP_Post $post The plugin post.
+ *
+ * @return array|false
+ */
+ public static function find_review_email( $post ) {
+ global $wpdb;
+
+ if ( 'pending' !== $post->post_status ) {
+ return false;
+ }
+
+ // Find the latest email for this plugin that looks like a review email.
+ return $wpdb->get_row( $wpdb->prepare(
+ "SELECT emails.*
+ FROM %i emails
+ JOIN %i meta ON emails.id = meta.helpscout_id
+ WHERE meta.meta_key = 'plugins' AND meta.meta_value = %s
+ AND emails.subject LIKE %s
+ ORDER BY `created` DESC
+ LIMIT 1",
+ "{$wpdb->base_prefix}helpscout",
+ "{$wpdb->base_prefix}helpscout_meta",
+ $post->post_name,
+ '%Review in Progress:%' // The subject line of the review email.
+ ) );
+ }
+
+ /**
+ * Update the HelpScout review email.
+ *
+ * @param WP_Post $post The plugin post.
+ * @param WP_Post $attachment The uploaded attachment post.
+ *
+ * @return bool True if the email was updated, false otherwise.
+ */
+ public function update_review_email( $post, $attachment ) {
+ $review_email = self::find_review_email( $post );
+ if ( ! $review_email ) {
+ return false;
+ }
+
+ // Don't update the review email if the plugin author isn't the one who uploaded the ZIP.
+ if ( $post->post_author != get_current_user_id() ) {
+ return false;
+ }
+
+ $text = sprintf(
+ "New ZIP uploaded by %s, version %s.\n%s\n%s",
+ wp_get_current_user()->user_login,
+ $attachment->version,
+ get_edit_post_link( $post ),
+ wp_get_attachment_url( $attachment->ID )
+ );
+
+ $result = HelpScout::api(
+ '/v2/conversations/' . $review_email->id . '/notes',
+ [
+ 'text' => $text,
+ 'status' => 'active',
+ ],
+ 'POST',
+ $http_response_code
+ );
+
+ return ( 201 === $http_response_code );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>