<!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>[12740] sites/trunk/wordpress.org/public_html/wp-content/plugins/support-forums/inc: Support Forums: Log note (and as a result, role changes) to Slack.</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/12740">12740</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/12740","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-07-14 08:04:18 +0000 (Fri, 14 Jul 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'>Support Forums: Log note (and as a result, role changes) to Slack.
See <a href="http://meta.trac.wordpress.org/ticket/5707">#5707</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentpluginssupportforumsincclassauditlogphp">sites/trunk/wordpress.org/public_html/wp-content/plugins/support-forums/inc/class-audit-log.php</a></li>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentpluginssupportforumsincclassusernotesphp">sites/trunk/wordpress.org/public_html/wp-content/plugins/support-forums/inc/class-user-notes.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="sitestrunkwordpressorgpublic_htmlwpcontentpluginssupportforumsincclassauditlogphp"></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-audit-log.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-audit-log.php 2023-07-14 07:50:36 UTC (rev 12739)
+++ sites/trunk/wordpress.org/public_html/wp-content/plugins/support-forums/inc/class-audit-log.php 2023-07-14 08:04:18 UTC (rev 12740)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -4,10 +4,20 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> class Audit_Log {
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * List of note IDs that have been edited, keyed by user ID.
+ *
+ * @var array
+ */
+ var $edited_notes = [];
+
</ins><span class="cx" style="display: block; padding: 0 10px"> function __construct() {
</span><span class="cx" style="display: block; padding: 0 10px"> // Audit-log entries for Term subscriptions (add/remove)
</span><span class="cx" style="display: block; padding: 0 10px"> add_action( 'wporg_bbp_add_user_term_subscription', array( $this, 'term_subscriptions' ), 10, 2 );
</span><span class="cx" style="display: block; padding: 0 10px"> add_action( 'wporg_bbp_remove_user_term_subscription', array( $this, 'term_subscriptions' ), 10, 2 );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ // Slack logs for Moderation notes.
+ add_action( 'wporg_bbp_note_added', [ $this, 'forums_notes_added' ], 10, 2 );
</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">@@ -41,6 +51,82 @@
</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">+ * Record Note changes to Slack.
+ *
+ * @param int $user_id
+ * @param int $note_id
+ */
+ function forums_notes_added( $user_id, $note_id ) {
+ $this->edited_notes[ $user_id ] ??= [];
+ $this->edited_notes[ $user_id ][] = $note_id;
+
+ if ( ! has_action( 'shutdown', [ $this, 'forums_notes_added_shutdown' ] ) ) {
+ add_action( 'shutdown', [ $this, 'forums_notes_added_shutdown' ] );
+ }
+ }
+
+ /**
+ * Send Slack notifications for Note changes.
+ */
+ function forums_notes_added_shutdown() {
+ if ( ! function_exists( 'notify_slack' ) || ! defined( 'FORUMS_MODACTIONS_SLACK_CHANNEL' ) ) {
+ return;
+ }
+
+ // Fetch all the notes altered.
+ foreach ( $this->edited_notes as $user_id => $note_ids ) {
+ $note_ids = array_unique( $note_ids );
+ $notes = Plugin::get_instance()->user_notes->get_user_notes( $user_id, false );
+
+ $notes = array_filter(
+ $notes->raw,
+ function( $note_id ) use ( $note_ids ) {
+ return in_array( $note_id, $note_ids );
+ },
+ ARRAY_FILTER_USE_KEY
+ );
+
+ $notes = array_map(
+ function( $note ) {
+ $pretext = '';
+ if ( strtotime( $note->date ) < time() - 5 ) {
+ $pretext = '_(Edited)_ ';
+ }
+
+ return $pretext . $note->text;
+ },
+ $notes
+ );
+
+ $note_text = trim( implode( "\n", $notes ) );
+
+ if ( str_contains( $note_text, 'Forum role changed' ) ) {
+ $action_text = 'Role changed';
+ } else {
+ $action_text = 'Note added';
+ }
+
+ $message = sprintf(
+ "*%s for %s*\n%s\n",
+ $action_text,
+ sprintf(
+ '<%s|%s>',
+ bbp_get_user_profile_edit_url( $user_id ),
+ get_userdata( $user_id )->display_name ?: get_userdata( $user_id )->user_login
+ ),
+ // Wrap the note in a blockquote.
+ '> ' . str_replace(
+ "\n",
+ "\n> ",
+ $note_text
+ )
+ );
+
+ notify_slack( FORUMS_MODACTIONS_SLACK_CHANNEL, $message, wp_get_current_user() );
+ }
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Log audit log entries into Stream.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * This is a shortcut past the Stream Connectors, reaching in and calling the logging function directly..
</span></span></pre></div>
<a id="sitestrunkwordpressorgpublic_htmlwpcontentpluginssupportforumsincclassusernotesphp"></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-user-notes.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-user-notes.php 2023-07-14 07:50:36 UTC (rev 12739)
+++ sites/trunk/wordpress.org/public_html/wp-content/plugins/support-forums/inc/class-user-notes.php 2023-07-14 08:04:18 UTC (rev 12740)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -142,6 +142,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> unset( $this->user_notes[ $user_id ] );
</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">+ // Fire an action to let others know about the note.
+ do_action( 'wporg_bbp_note_added', $user_id, $note_id, $user_notes[ $note_id ] );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> return true;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre>
</div>
</div>
</body>
</html>