<!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>[10121] sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory: Plugin Directory: Add a notification email to committers when a new committer or support rep is added.</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/10121">10121</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/10121","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>2020-08-06 07:44:59 +0000 (Thu, 06 Aug 2020)</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: Add a notification email to committers when a new committer or support rep is added.
Fixes <a href="http://meta.trac.wordpress.org/ticket/5351">#5351</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentpluginsplugindirectoryclasstoolsphp">sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/class-tools.php</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li>sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/email/</li>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentpluginsplugindirectoryemailclassbasephp">sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/email/class-base.php</a></li>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentpluginsplugindirectoryemailclasscommitteraddednotificationphp">sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/email/class-committer-added-notification.php</a></li>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentpluginsplugindirectoryemailclasssupportrepaddednotificationphp">sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/email/class-support-rep-added-notification.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="sitestrunkwordpressorgpublic_htmlwpcontentpluginsplugindirectoryclasstoolsphp"></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/class-tools.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/class-tools.php 2020-08-05 04:42:12 UTC (rev 10120)
+++ sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/class-tools.php 2020-08-06 07:44:59 UTC (rev 10121)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2,6 +2,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> namespace WordPressdotorg\Plugin_Directory;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> use WP_User;
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+use WordPressdotorg\Plugin_Directory\Email\Committer_Added_Notification;
+use WordPressdotorg\Plugin_Directory\Email\Support_Rep_Added_Notification;
</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"> * Various functions used by other processes, will make sense to move to specific classes.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -205,6 +207,26 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $plugin_slug
</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">+ // Only notify if the current process is interactive - a user is logged in.
+ $should_notify = (bool) get_current_user_id();
+ // Don't notify if a plugin admin is taking action on a plugin they're not (yet) a committer for.
+ if ( current_user_can( 'plugin_approve' ) && ! in_array( wp_get_current_user()->user_login, $existing_committers, true ) ) {
+ $should_notify = false;
+ }
+
+ if ( $should_notify ) {
+ $existing_committers[] = $user->user_login;
+
+ $email = new Committer_Added_Notification(
+ $plugin_slug,
+ $existing_committers,
+ [
+ 'committer' => $user,
+ ]
+ );
+ $email->send();
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> return $result;
</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">@@ -352,6 +374,26 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $plugin_slug
</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">+ $committers = self::get_plugin_committers( $plugin_slug );
+
+ // Only notify if the current process is interactive - a user is logged in.
+ $should_notify = (bool) get_current_user_id();
+ // Don't notify if a plugin admin is taking action on a plugin they're not a committer for.
+ if ( current_user_can( 'plugin_approve' ) && ! in_array( wp_get_current_user()->user_login, $committers, true ) ) {
+ $should_notify = false;
+ }
+
+ if ( $should_notify ) {
+ $email = new Support_Rep_Added_Notification(
+ $plugin_slug,
+ $committers,
+ [
+ 'rep' => $user,
+ ]
+ );
+ $email->send();
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> return $result;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre></div>
<a id="sitestrunkwordpressorgpublic_htmlwpcontentpluginsplugindirectoryemailclassbasephp"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/email/class-base.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/email/class-base.php (rev 0)
+++ sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/email/class-base.php 2020-08-06 07:44:59 UTC (rev 10121)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,159 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+namespace WordPressdotorg\Plugin_Directory\Email;
+
+use WP_User;
+use WordPressdotorg\Plugin_Directory\Plugin_Directory;
+
+const PLUGIN_TEAM_EMAIL = 'plugins@wordpress.org';
+
+abstract class Base {
+ // Emails should use the following properties to customise content:
+ protected $plugin = false; // The plugin this email relates to.
+ protected $user = false; // The user this email is being sent to - Always singular.
+ protected $who = false; // The user triggering this email, who performed the action, which may not be the currently logged in user.
+ protected $args = []; // The arguments passed for this email.
+
+ // Email subclass should set this if needed - Not an error, only prevents the email from being sent.
+ protected $required_args = [];
+
+ // These must be set by the email.
+ abstract public function subject();
+ abstract public function body();
+
+ // Internal use only.
+ protected $users = false;
+
+ /**
+ * @param $plugin The plugin this email relates to.
+ * @param $users[] A list of users to email.
+ * @param $args[] A list of args that the email requires.
+ */
+ public function __construct( $plugin, $users, $args = array() ) {
+ $this->plugin = Plugin_Directory::get_plugin_post( $plugin );
+
+ foreach ( (array) $users as $user ) {
+ if ( is_string( $user ) && is_email( $user ) ) {
+ $user = get_user_by( 'email', $user );
+ } elseif ( ! ( $user instanceof WP_User ) ) {
+ $user = new WP_User( $user );
+ }
+
+ if ( $user->exists() ) {
+ $this->users[] = $user;
+ }
+
+ // TODO: Email non-account holders?
+ }
+ $this->user = $this->users[0] ?? false;
+
+ $this->args = $args;
+ $this->who = $this->args['who'] ?? wp_get_current_user();
+ }
+
+ /**
+ * Trigger the sending process for each email.
+ */
+ public function send() {
+ $success = [];
+
+ // Process `body()` and `subject()` for each user, so that the email can be personalised.
+ foreach ( $this->users as $u ) {
+ // TODO: Set user locale?
+ $this->user = $u;
+
+ $success[] = $this->_send();
+ }
+
+ // As long as one email succeeds, it's truthful.
+ return in_array( true, $success, true );
+ }
+
+ /**
+ * Send an individual email.
+ */
+ protected function _send() {
+ if ( ! $this->should_send() ) {
+ return false;
+ }
+
+ $subject = sprintf(
+ /* translators: Email subject prefix. 1: The email subject. */
+ __( '[WordPress Plugin Directory] %1$s', 'wporg-plugins' ),
+ $this->subject()
+ );
+
+ $email = $this->user->user_email;
+ $body = $this->body();
+ $body .= "\n\n" . $this->get_email_signature();
+
+ return wp_mail(
+ $email,
+ $subject,
+ $body,
+ sprintf(
+ 'From: "%s" <%s>',
+ 'WordPress Plugin Directory',
+ PLUGIN_TEAM_EMAIL
+ )
+ );
+ }
+
+ /**
+ * Checks that an email should be sent.
+ */
+ public function should_send() {
+ // Check all the required datas are set.
+ if ( ! $this->have_required_data() ) {
+ return false;
+ }
+
+ // Blocked users don't need emails.
+ if ( !empty( $this->user->caps[ 'bbp_blocked'] ) ) {
+ return false;
+ }
+
+ return true;
+ }
+
+ /**
+ * Validate that all the required states are set before sending an email.
+ */
+ public function have_required_data() {
+ if ( ! $this->plugin || ! $this->users ) {
+ return false;
+ }
+
+ foreach ( $this->required_args as $arg ) {
+ if ( ! isset( $this->args[ $arg ] ) ) {
+ return false;
+ }
+ }
+
+ return true;
+ }
+
+ /**
+ * A common email signature to attach to the bottom of all emails.
+ */
+ public function get_email_signature() {
+ /* translators: This is an email signature. Do not translate the URL. */
+ return __( '--
+The WordPress Plugin Directory Team
+https://make.wordpress.org/plugins', 'wporg-plugins' );
+ }
+
+ /**
+ * A simple way to convert a WP_User object to a displayable username.
+ * This shouldn't be needed, but unfortunately often is on WordPress.org.
+ */
+ public function user_text( $user ) {
+ if ( ! $user instanceof WP_User ) {
+ $user = new WP_User( $user );
+ }
+ if ( ! $user || ! $user->exists() ) {
+ return 'Unknown';
+ }
+
+ return $user->display_name ?: $user->user_login;
+ }
+}
</ins><span class="cx" style="display: block; padding: 0 10px">Property changes on: sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/email/class-base.php
</span><span class="cx" style="display: block; padding: 0 10px">___________________________________________________________________
</span></span></pre></div>
<a id="svneolstyle"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: svn:eol-style</h4></div>
<ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+native
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span><a id="sitestrunkwordpressorgpublic_htmlwpcontentpluginsplugindirectoryemailclasscommitteraddednotificationphp"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/email/class-committer-added-notification.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/email/class-committer-added-notification.php (rev 0)
+++ sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/email/class-committer-added-notification.php 2020-08-06 07:44:59 UTC (rev 10121)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,50 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+namespace WordPressdotorg\Plugin_Directory\Email;
+
+use WordPressdotorg\Plugin_Directory\Tools;
+
+class Committer_Added_Notification extends Base {
+ protected $required_args = [ 'committer' ];
+
+ function subject() {
+ return sprintf(
+ /* translators: 1: Plugin Name */
+ __( 'New committer added to %s', 'wporg-plugins' ),
+ $this->plugin->post_title
+ );
+ }
+
+ function body() {
+ /* translators: 1: Receivers display name, 2: New Committer Name, 3: Plugin Name, 4: User who added committer, 5: List of users, 6: Plugin Management URL, 7: Plugins Team email */
+ $email_text = __( 'Howdy %1$s,
+
+%2$s has been added as a committer to %3$s by %4$s.
+
+The following people now have write-access to %3$s:
+%5$s
+
+You can manage your plugin committers here:
+%6$s
+
+If you believe this to be in error, please contact %7$s.', 'wporg-plugins' );
+
+ $committer_list = '';
+ foreach ( Tools::get_plugin_committers( $this->plugin->post_name ) as $c ) {
+ $committer_list .= ' * ' . $this->user_text( $c ) . "\n";
+ }
+ $committer_list = rtrim( $committer_list );
+
+ $advanced_url = get_permalink( $this->plugin ) . 'advanced/';
+
+ return sprintf(
+ $email_text,
+ $this->user_text( $this->user ),
+ $this->user_text( $this->args['committer'] ),
+ $this->plugin->post_title,
+ $this->user_text( $this->who ),
+ $committer_list,
+ $advanced_url,
+ PLUGIN_TEAM_EMAIL
+ );
+ }
+}
</ins><span class="cx" style="display: block; padding: 0 10px">Property changes on: sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/email/class-committer-added-notification.php
</span><span class="cx" style="display: block; padding: 0 10px">___________________________________________________________________
</span></span></pre></div>
<a id="svneolstyle"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: svn:eol-style</h4></div>
<ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+native
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span><a id="sitestrunkwordpressorgpublic_htmlwpcontentpluginsplugindirectoryemailclasssupportrepaddednotificationphp"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/email/class-support-rep-added-notification.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/email/class-support-rep-added-notification.php (rev 0)
+++ sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/email/class-support-rep-added-notification.php 2020-08-06 07:44:59 UTC (rev 10121)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,50 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+namespace WordPressdotorg\Plugin_Directory\Email;
+
+use WordPressdotorg\Plugin_Directory\Tools;
+
+class Support_Rep_Added_Notification extends Base {
+ protected $required_args = [ 'rep' ];
+
+ function subject() {
+ return sprintf(
+ /* translators: 1: Plugin Name */
+ __( 'New support rep added to %s', 'wporg-plugins' ),
+ $this->plugin->post_title
+ );
+ }
+
+ function body() {
+ /* translators: 1: Receivers display name, 2: New Support Rep Name, 3: Plugin Name, 4: User who added rep, 5: List of reps, 6: Plugin Management URL, 7: Plugins Team email */
+ $email_text = __( 'Howdy %1$s,
+
+%2$s has been added as a support rep to %3$s by %4$s.
+
+The following people are now suport representatives for %3$s:
+%5$s
+
+You can manage your plugin support representatives here:
+%6$s
+
+If you believe this to be in error, please contact %7$s.', 'wporg-plugins' );
+
+ $rep_list = '';
+ foreach ( Tools::get_plugin_support_reps( $this->plugin->post_name ) as $rep ) {
+ $rep_list .= ' * ' . $this->user_text( $rep ) . "\n";
+ }
+ $rep_list = rtrim( $rep_list );
+
+ $advanced_url = get_permalink( $this->plugin ) . 'advanced/';
+
+ return sprintf(
+ $email_text,
+ $this->user_text( $this->user ),
+ $this->user_text( $this->args['rep'] ),
+ $this->plugin->post_title,
+ $this->user_text( $this->who ),
+ $rep_list,
+ $advanced_url,
+ PLUGIN_TEAM_EMAIL
+ );
+ }
+}
</ins><span class="cx" style="display: block; padding: 0 10px">Property changes on: sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/email/class-support-rep-added-notification.php
</span><span class="cx" style="display: block; padding: 0 10px">___________________________________________________________________
</span></span></pre></div>
<a id="svneolstyle"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: svn:eol-style</h4></div>
<ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+native
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span></div>
</body>
</html>