<!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>[12161] sites/trunk/wordpress.org/public_html/wp-content/plugins/support-forums/inc: Support Forums: Create a user notes entry every time a user is flagged or unflagged.</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/12161">12161</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/12161","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-10-31 03:47:05 +0000 (Mon, 31 Oct 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: Create a user notes entry every time a user is flagged or unflagged.

This also adds a generic User_Notes function that updates the previous user-note if made within 5 minutes, as used by the forum role changer, so that the flagged/unflagged note is added to any recent descriptive reason.

Fixes <a href="http://meta.trac.wordpress.org/ticket/6554">#6554</a>.</pre>

<h3>Modified Paths</h3>
<ul>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentpluginssupportforumsincclasshooksphp">sites/trunk/wordpress.org/public_html/wp-content/plugins/support-forums/inc/class-hooks.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_htmlwpcontentpluginssupportforumsincclasshooksphp"></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-hooks.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-hooks.php       2022-10-31 03:27:30 UTC (rev 12160)
+++ sites/trunk/wordpress.org/public_html/wp-content/plugins/support-forums/inc/class-hooks.php 2022-10-31 03:47:05 UTC (rev 12161)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -135,6 +135,10 @@
</span><span class="cx" style="display: block; padding: 0 10px">                // Don't embed WordPress.org links with anchors included.
</span><span class="cx" style="display: block; padding: 0 10px">                add_filter( 'pre_oembed_result', array( $this, 'pre_oembed_result_dont_embed_wordpress_org_anchors' ), 20, 2 );
</span><span class="cx" style="display: block; padding: 0 10px"> 
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+                // Add a user note when flagging/unflagging a user.
+               add_filter( 'wporg_bbp_flag_user', array( $this, 'log_user_flag_changes' ) );
+               add_filter( 'wporg_bbp_unflag_user', array( $this, 'log_user_flag_changes' ) );
+
</ins><span class="cx" style="display: block; padding: 0 10px">                 // Break users sessions / passwords when they get blocked, on the main forums only.
</span><span class="cx" style="display: block; padding: 0 10px">                if ( 'wordpress.org' === get_blog_details()->domain ) {
</span><span class="cx" style="display: block; padding: 0 10px">                        add_action( 'bbp_set_user_role', array( $this, 'user_blocked_password_handler' ), 10, 3 );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1449,34 +1453,25 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 
</span><span class="cx" style="display: block; padding: 0 10px">                if ( $note_text ) {
</span><span class="cx" style="display: block; padding: 0 10px">                        // Add a user note about this action.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-                        $notes   = Plugin::get_instance()->user_notes->get_user_notes( $user->ID );
-                       $note_id = 0;
-
-                       // Check to see if the last note added was from the current user in the last few minutes, and if so, append to it.
-                       if ( $notes->count ) {
-                               $last_note_id = array_key_last( $notes->raw );
-                               $last_note    = $notes->raw[ $last_note_id ];
-                               if (
-                                       // Note from the current user
-                                       $last_note->moderator === wp_get_current_user()->user_nicename &&
-                                       // ..and created within 5 minutes.
-                                       absint( time() - strtotime( $last_note->date ) ) <= 5 * MINUTE_IN_SECONDS
-                               ) {
-                                       $note_id = $last_note_id;
-
-                                       // Prefix the existing message.
-                                       $note_text = trim( $last_note->text . "\n\n" . $note_text );
-                               }
-                       }
-
-                       // Add a user note about this action.
-                       Plugin::get_instance()->user_notes->add_user_note(
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+                 Plugin::get_instance()->user_notes->add_user_note_or_update_previous(
</ins><span class="cx" style="display: block; padding: 0 10px">                                 $user->ID,
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-                                $note_text,
-                               null,
-                               $note_id
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+                         $note_text
</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="cx" style="display: block; padding: 0 10px">        }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+       /**
+        * Add a user note when a user is flagged / unflagged.
+        */
+       function log_user_flag_changes( $user_id ) {
+               $flag_action = ( 'wporg_bbp_flag_user' === current_filter () ) ? 'flaged' : 'unflagged';
+
+               $note_text = "User {$flag_action}.";
+
+               Plugin::get_instance()->user_notes->add_user_note_or_update_previous(
+                       $user_id,
+                       $note_text
+               );
+       }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</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  2022-10-31 03:27:30 UTC (rev 12160)
+++ sites/trunk/wordpress.org/public_html/wp-content/plugins/support-forums/inc/class-user-notes.php    2022-10-31 03:47:05 UTC (rev 12161)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -146,6 +146,41 @@
</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">+         * Saves a note to a users meta data. Suffixes to previous user note if by same moderator within a timeframe.
+        * 
+        * @param int    $user_id   The user ID.
+        * @param string $note_text The note text to add.
+        * @param int    $post_id   The support thread this text is related to. Optional.
+        * @param int    $timeframe The timeframe used to determine if the previous note should be updated. Optional. Default 5 minutes.
+        */
+       public function add_user_note_or_update_previous( $user_id, $note_text, $post_id = 0, $timeframe = 300 ) {
+               // Default to adding a new note..
+               $note_id = 0;
+
+               // Add a user note about this action.
+               $existing_notes = $this->get_user_notes( $user_id );
+
+               // Check to see if the last note added was from the current user in the last few minutes, and if so, append to it.
+               if ( $existing_notes->count ) {
+                       $last_note_id = array_key_last( $existing_notes->raw );
+                       $last_note    = $existing_notes->raw[ $last_note_id ];
+                       if (
+                               // Note from the current user
+                               $last_note->moderator === wp_get_current_user()->user_nicename &&
+                               // ..and created within $timeframe seconds
+                               absint( time() - strtotime( $last_note->date ) ) <= $timeframe
+                       ) {
+                               $note_id = $last_note_id;
+
+                               // Prefix the existing message.
+                               $note_text = trim( $last_note->text . "\n\n" . $note_text );
+                       }
+               }
+
+               return $this->add_user_note( $user_id, $note_text, $post_id, $note_id );
+       }
+
+       /**
</ins><span class="cx" style="display: block; padding: 0 10px">          * Deletes a previously added note from user's meta data.
</span><span class="cx" style="display: block; padding: 0 10px">         *
</span><span class="cx" style="display: block; padding: 0 10px">         * @param string $action Requested action.
</span></span></pre>
</div>
</div>

</body>
</html>