Changeset 6923 for trunk/src/includes/topics/functions.php

Timestamp:

11/09/2019 05:35:42 AM (5 years ago)

Author:

johnjamesjacoby

Message:

Counts (meta-data): full audit of forum/topic/reply, public/non-public counts.

This commit is the result of a full count audit, exposing multiple inconsistencies and voids in relation to how public and non-public counts are (re)calculated.

For instance, hidden forum replies are not counted at all, until now. By introducing a new Repair tool, hidden forum reply counts are now counted.

In addition, there were multiple bugs with topic & reply moderation, where the act of approving or unapproving topics or replies would cause the numbers to be inaccurate, or where topics & replies being caught in moderation were still increasing public counts.

It was also possible to, as a Key Master, publicly reply to unapproved topics, which was a completely unanticipated side-effect of allowing Key Masters to do pretty much anything. Going forward, the default reply status is the topic status, but is still beholden to all existing moderation settings and user role capabilities. This results in a more sane user experience, and prevents the unusual circumstance of there being "0 topics and 30 replies" in public-facing forums.

Certain count increase/decrease actions have been reprioritized to avoid collisions and race conditions, proving once again that ya gotta get up to get down.

See #2838. Fixes #1799.

File:

• trunk/src/includes/topics/functions.php (modified) (14 diffs)

trunk/src/includes/topics/functions.php

@@ -844 +844 @@
 /**
  * Walks up the post_parent tree from the current topic_id, and updates the
- * counts of forums above it. This calls a few internal functions that all run
+ * meta data of forums above it. This calls several functions that all run
  * manual queries against the database to get their results. As such, this
  * function can be costly to run but is necessary to keep everything accurate.
@@ -994 +994 @@
     $old_forum_ancestors = array_values( array_unique( array_merge( array( $old_forum_id ), (array) get_post_ancestors( $old_forum_id ) ) ) );
 
-    // Get reply count.
-    $public_reply_count = bbp_get_public_child_count( $topic_id, bbp_get_reply_post_type() );
-
-    // Topic status.
-    $topic_status = get_post_field( 'post_status', $topic_id );
-
-    // Update old/new forum counts.
-    if ( $topic_status === bbp_get_public_status_id() ) {
+    // Public counts
+    if ( bbp_is_topic_public( $topic_id ) ) {
 
         // Update old forum counts.
         bbp_decrease_forum_topic_count( $old_forum_id );
-        bbp_bump_forum_reply_count( $old_forum_id, -$public_reply_count );
 
         // Update new forum counts.
         bbp_increase_forum_topic_count( $new_forum_id );
-        bbp_bump_forum_reply_count( $new_forum_id, $public_reply_count );
+
+    // Non-public counts
     } else {
 
@@ -1018 +1012 @@
         bbp_increase_forum_topic_count_hidden( $new_forum_id );
     }
+
+    // Get reply counts.
+    $public_reply_count = bbp_get_public_child_count( $topic_id, bbp_get_reply_post_type() );
+    $hidden_reply_count = bbp_get_non_public_child_count( $topic_id, bbp_get_reply_post_type() );
+
+    // Bump reply counts.
+    bbp_bump_forum_reply_count( $old_forum_id, -$public_reply_count );
+    bbp_bump_forum_reply_count( $new_forum_id, $public_reply_count );
+    bbp_bump_forum_reply_count_hidden( $old_forum_id, -$hidden_reply_count );
+    bbp_bump_forum_reply_count_hidden( $new_forum_id, $hidden_reply_count );
 
     // Loop through ancestors and update them
@@ -2319 +2323 @@
         $topic_id = bbp_get_reply_topic_id( $reply_id );
 
-        // If this is a new, unpublished, reply, update hidden count and bail.
-        if ( ! bbp_is_reply_published( $reply_id ) ) {
+        // Update inverse based on item status
+        if ( ! bbp_is_reply_public( $reply_id ) ) {
             bbp_increase_topic_reply_count_hidden( $topic_id );
             return;
@@ -2326 +2330 @@
     }
 
+    // Bump up
     bbp_bump_topic_reply_count( $topic_id );
 }
@@ -2347 +2352 @@
     // If it's a reply, get the topic id.
     if ( bbp_is_reply( $topic_id ) ) {
-        $topic_id = bbp_get_reply_topic_id( $topic_id );
-    }
-
+        $reply_id = $topic_id;
+        $topic_id = bbp_get_reply_topic_id( $reply_id );
+
+        // Update inverse based on item status
+        if ( ! bbp_is_reply_public( $reply_id ) ) {
+            bbp_decrease_topic_reply_count_hidden( $topic_id );
+            return;
+        }
+    }
+
+    // Bump down
     bbp_bump_topic_reply_count( $topic_id, -1 );
 }
@@ -2400 +2413 @@
     // If it's a reply, get the topic id.
     if ( bbp_is_reply( $topic_id ) ) {
-        $topic_id = bbp_get_reply_topic_id( $topic_id );
-    }
-
+        $reply_id = $topic_id;
+        $topic_id = bbp_get_reply_topic_id( $reply_id );
+
+        // Update inverse based on item status
+        if ( bbp_is_reply_public( $reply_id ) ) {
+            bbp_increase_topic_reply_count( $topic_id );
+            return;
+        }
+    }
+
+    // Bump up
     bbp_bump_topic_reply_count_hidden( $topic_id );
 }
@@ -2424 +2445 @@
     // If it's a reply, get the topic id.
     if ( bbp_is_reply( $topic_id ) ) {
-        $topic_id = bbp_get_reply_topic_id( $topic_id );
-    }
-
+        $reply_id = $topic_id;
+        $topic_id = bbp_get_reply_topic_id( $reply_id );
+
+        // Update inverse based on item status
+        if ( bbp_is_reply_public( $reply_id ) ) {
+            bbp_decrease_topic_reply_count( $topic_id );
+            return;
+        }
+    }
+
+    // Bump down
     bbp_bump_topic_reply_count_hidden( $topic_id, -1 );
 }
@@ -2509 +2538 @@
  * @return int Topic reply count
  */
-function bbp_update_topic_reply_count( $topic_id = 0, $reply_count = 0 ) {
+function bbp_update_topic_reply_count( $topic_id = 0, $reply_count = false ) {
 
     // If it's a reply, then get the parent (topic id)
@@ -2517 +2546 @@
 
     // Get replies of topic if not passed
-    $reply_count = empty( $reply_count )
+    $reply_count = ! is_int( $reply_count )
         ? bbp_get_public_child_count( $topic_id, bbp_get_reply_post_type() )
         : (int) $reply_count;
@@ -2537 +2566 @@
  * @return int Topic hidden reply count
  */
-function bbp_update_topic_reply_count_hidden( $topic_id = 0, $reply_count = 0 ) {
+function bbp_update_topic_reply_count_hidden( $topic_id = 0, $reply_count = false ) {
 
     // If it's a reply, then get the parent (topic id)
@@ -2545 +2574 @@
 
     // Get replies of topic
-    $reply_count = empty( $reply_count )
+    $reply_count = ! is_int( $reply_count )
         ? bbp_get_non_public_child_count( $topic_id, bbp_get_reply_post_type() )
         : (int) $reply_count;
@@ -2584 +2613 @@
 
     // Update only if published
-    if ( bbp_get_public_status_id() === get_post_status( $active_id ) ) {
-        update_post_meta( $topic_id, '_bbp_last_active_id', $active_id );
-    }
+    update_post_meta( $topic_id, '_bbp_last_active_id', $active_id );
 
     // Filter & return
@@ -2654 +2681 @@
 
     // Update if reply is published
-    if ( bbp_is_reply_published( $reply_id ) ) {
-        update_post_meta( $topic_id, '_bbp_last_reply_id', $reply_id );
-    }
+    update_post_meta( $topic_id, '_bbp_last_reply_id', $reply_id );
 
     // Filter & return