<!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>[11978] sites/trunk/wordpress.org/public_html/wp-content/plugins/support-forums/inc/class-emails.php: Support Forums: Attempt to send notifications for new topics/replies when it's caught within the moderation or spam queue.</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/11978">11978</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/11978","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>2022-07-19 06:01:45 +0000 (Tue, 19 Jul 2022)</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'>Support Forums: Attempt to send notifications for new topics/replies when it's caught within the moderation or spam queue.
bbPress subscription notifications (and WordPress.org's) are hooked to the `bbp_new_topic` action, however they also verify that the thread is public before notifying.
Unfortunately, bbPress does not trigger the notifications upon the thread being unspammed/approved, and neither do the WordPress.org notifications.
This fixes this condition by triggering the "new topic created" hook after a topic/reply is unspammed/approved for the first time, causing the subscriptions codes to run as if it's a brand-new thread.
This should fix plugin subscription notifications not being sent to some plugin authors, and topic authors who are unaware of a reply because the responding author was caught in a moderation queue.
It's worth noting that replies still only trigger notifications (matchers, topic/forum subscriptions, @mention's, etc) if the topic is public AND the reply will be public.
If a reply is added to a pending topic, notifications for that reply will NOT be re-sent, unless the reply was also in a pending state unrelated to the topic and is then approved after the topic is.
See <a href="http://meta.trac.wordpress.org/ticket/3674">#3674</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentpluginssupportforumsincclassemailsphp">sites/trunk/wordpress.org/public_html/wp-content/plugins/support-forums/inc/class-emails.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="sitestrunkwordpressorgpublic_htmlwpcontentpluginssupportforumsincclassemailsphp"></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/support-forums/inc/class-emails.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/support-forums/inc/class-emails.php 2022-07-19 04:13:17 UTC (rev 11977)
+++ sites/trunk/wordpress.org/public_html/wp-content/plugins/support-forums/inc/class-emails.php 2022-07-19 06:01:45 UTC (rev 11978)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -4,9 +4,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Support Forum Email modifications.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * This filters outgoing bbPress emails to 'unroll' subscription emails from a set of BCC's to individual emails.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * This provides some overrides to work around limitations / bugs in bbPress related to email.
+ * 1. Filters outgoing bbPress emails to 'unroll' subscription emails from a set of BCC's to individual emails.
+ * 2. Sends subscription emails upon approval for topics/replies.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> class Emails {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ const SUBSCRIPTIONS_TRIGGER_KEY = '_wporg_trigger_notifications_on_approve';
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> public function __construct() {
</span><span class="cx" style="display: block; padding: 0 10px"> // Forum subscribers. This is also for Term (Plugin/Theme/Tag) subscriptions new topics.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -16,8 +19,22 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // Topic subscribers. This is also for Term (Plugin/Theme/Tag) subscriptions new replies.
</span><span class="cx" style="display: block; padding: 0 10px"> add_action( 'bbp_pre_notify_subscribers', [ $this, 'start_unroll' ] );
</span><span class="cx" style="display: block; padding: 0 10px"> add_action( 'bbp_post_notify_subscribers', [ $this, 'stop_unroll' ] );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ // Subscriptions - Send subscriptions after approval/unspam.
+ add_action( 'bbp_new_topic', [ $this, 'bbp_new_topic' ], 20, 2 );
+ add_action( 'bbp_new_reply', [ $this, 'bbp_new_reply' ], 20, 3 );
+
+ add_action( 'bbp_unspammed_topic', [ $this, 'maybe_trigger_bbp_new_topic' ], 10, 1 );
+ add_action( 'bbp_approved_topic', [ $this, 'maybe_trigger_bbp_new_topic' ], 10, 1 );
+ //add_action( 'bbp_untrashed_topic', [ $this, 'maybe_trigger_bbp_new_topic' ], 10, 1 );
+
+ add_action( 'bbp_unspammed_reply', [ $this, 'maybe_trigger_bbp_new_reply' ], 10, 1 );
+ add_action( 'bbp_approved_reply', [ $this, 'maybe_trigger_bbp_new_reply' ], 10, 1 );
+ //add_action( 'bbp_untrashed_reply', [ $this, 'maybe_trigger_bbp_new_reply' ], 10, 1 );
</ins><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">+ // --- Email BCC unrolling...
+
</ins><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Attached to the filter to start filtering outgoing emails on.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -107,4 +124,80 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // We've sent the emails, we return the last emails result here, even tho calling function probably won't look at it.
</span><span class="cx" style="display: block; padding: 0 10px"> return $filter_return;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ // --- bbPress not sending notifications if it's caught in spam/moderation queue
+
+ /**
+ * Add postmeta to new unpublished replies, to send notifications once it's published.
+ */
+ public function bbp_new_reply( $reply_id, $topic_id, $forum_id ) {
+ if ( bbp_is_reply_published( $reply_id ) && bbp_is_topic_public( $topic_id ) ) {
+ return;
+ }
+
+ add_post_meta( $reply_id, self::SUBSCRIPTIONS_TRIGGER_KEY, 1 );
+ }
+
+ /**
+ * Add postmeta to new unpublished topics, to send notifications once it's published.
+ */
+ public function bbp_new_topic( $topic_id, $forum_id ) {
+ if ( bbp_is_topic_public( $topic_id ) ) {
+ return;
+ }
+
+ add_post_meta( $topic_id, self::SUBSCRIPTIONS_TRIGGER_KEY, 1 );
+ }
+
+ /**
+ * Send forum subscriptions for a previously-unpublished topic.
+ */
+ public function maybe_trigger_bbp_new_topic( $topic_id ) {
+ if ( ! get_post_meta( $topic_id, self::SUBSCRIPTIONS_TRIGGER_KEY, true) ) {
+ return;
+ }
+
+ if ( ! bbp_is_topic_public( $topic_id ) ) {
+ return;
+ }
+
+ $forum_id = bbp_get_topic_forum_id( $topic_id );
+ $topic_author = bbp_get_reply_author_id( $reply_id );
+
+ // Remove the bbPress topic update handler
+ remove_action( 'bbp_new_topic', 'bbp_update_topic' );
+
+ // Call the bbp_new_topic action..
+ do_action( 'bbp_new_topic', $topic_id, $forum_id, array(), $topic_author );
+
+ add_action( 'bbp_new_topic', 'bbp_update_topic', 10, 5 ); // bbPress requests 5, but calls it with 4..
+
+ delete_post_meta( $topic_id, self::SUBSCRIPTIONS_TRIGGER_KEY );
+ }
+
+ /**
+ * Send topic subscriptions for a previously-unpublished topic.
+ */
+ public function maybe_trigger_bbp_new_reply( $reply_id ) {
+ if ( ! get_post_meta( $reply_id, self::SUBSCRIPTIONS_TRIGGER_KEY, true ) ) {
+ return;
+ }
+
+ $topic_id = bbp_get_reply_topic_id( $reply_id );
+ $forum_id = bbp_get_topic_forum_id( $topic_id );
+ $reply_author = bbp_get_reply_author_id( $reply_id );
+
+ if ( ! bbp_is_reply_published( $reply_id ) || ! bbp_is_topic_public( $topic_id ) ) {
+ return;
+ }
+
+ remove_action( 'bbp_new_reply', 'bbp_update_reply' );
+
+ do_action( 'bbp_new_reply', $reply_id, $topic_id, $forum_id, array(), $reply_author, false, false );
+
+ add_action( 'bbp_new_reply', 'bbp_update_reply', 10, 7 );
+
+ delete_post_meta( $reply_id, self::SUBSCRIPTIONS_TRIGGER_KEY );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of file
</span></span></pre>
</div>
</div>
</body>
</html>