Changeset 5378

Timestamp:

06/06/2014 07:38:59 PM (12 years ago)

Author:

johnjamesjacoby

Message:

Introduce bbp_validate_reply_to() function, used to:

• Validate a parent reply is actually a reply post_type.
• A reply is not accidentally assigning itself as its own parent.
• An integer is returned.

Fixes hiesenbug where calls to bbp_get_reply_id() were unexpectedly and occasionally returning the current reply ID rather than 0.

See #2588. (trunk)

Location:

trunk/src/includes

Files:

• replies/functions.php (modified) (7 diffs)
• replies/template.php (modified) (1 diff)
• topics/functions.php (modified) (1 diff)

trunk/src/includes/replies/functions.php

@@ -250 +250 @@
         }
 
-        /** Reply To **************************************************************/
-
-        // Handle Reply To of the reply; $_REQUEST for non-JS submissions
-        if ( isset( $_REQUEST['bbp_reply_to'] ) ) {
-                $reply_to = (int) $_REQUEST['bbp_reply_to'];
-        }
-
-        $reply_to = bbp_get_reply_id( $reply_to );
-
         /** Unfiltered HTML *******************************************************/
 
@@ -312 +303 @@
         } else {
                 $reply_status = bbp_get_public_status_id();
+        }
+
+        /** Reply To **************************************************************/
+
+        // Handle Reply To of the reply; $_REQUEST for non-JS submissions
+        if ( isset( $_REQUEST['bbp_reply_to'] ) ) {
+                $reply_to = bbp_validate_reply_to( $_REQUEST['bbp_reply_to'] );
         }
 
@@ -563 +561 @@
         $forum_id = bbp_get_topic_forum_id( $topic_id );
 
-        /** Reply To **************************************************************/
-
-        $reply_to = bbp_get_reply_to( $reply_id );
-
         // Forum exists
         if ( !empty( $forum_id ) && ( $forum_id !== bbp_get_reply_forum_id( $reply_id ) ) ) {
@@ -635 +629 @@
         } else {
                 $reply_status = $reply->post_status;
+        }
+
+        /** Reply To **************************************************************/
+
+        // Handle Reply To of the reply; $_REQUEST for non-JS submissions
+        if ( isset( $_REQUEST['bbp_reply_to'] ) ) {
+                $reply_to = bbp_validate_reply_to( $_REQUEST['bbp_reply_to'] );
         }
 
@@ -794 +795 @@
         $topic_id = bbp_get_topic_id( $topic_id );
         $forum_id = bbp_get_forum_id( $forum_id );
-        $reply_to = bbp_get_reply_id( $reply_to );
+        $reply_to = bbp_validate_reply_to( $reply_to );
 
         // Bail if there is no reply
@@ -1113 +1114 @@
         // Validation
         $reply_id = bbp_get_reply_id( $reply_id );
-        $reply_to = bbp_get_reply_id( $reply_to );
-
-        // Return if no reply
-        if ( empty( $reply_id ) )
-                return;
-
-        // Set the reply to
-        if ( !empty( $reply_to ) ) {
-                update_post_meta( $reply_id, '_bbp_reply_to', $reply_to );
-
-        // Delete the reply to
-        } else {
-                delete_post_meta( $reply_id, '_bbp_reply_to' );
+        $reply_to = bbp_validate_reply_to( $reply_to );
+
+        // Update or delete the `reply_to` postmeta
+        if ( ! empty( $reply_id ) ) {
+
+                // Update the reply to
+                if ( !empty( $reply_to ) ) {
+                        update_post_meta( $reply_id, '_bbp_reply_to', $reply_to );
+
+                // Delete the reply to
+                } else {
+                        delete_post_meta( $reply_id, '_bbp_reply_to' );
+                }
         }
 
@@ -2220 +2221 @@
         bbpress()->reply_query->in_the_loop = false;
 }
+
+/**
+ * Validate a `reply_to` field for hierarchical replies
+ * 
+ * Checks for 2 scenarios:
+ * -- The reply to ID is actually a reply
+ * -- The reply to ID does not match the current reply
+ *
+ * @see https://bbpress.trac.wordpress.org/ticket/2588
+ * @see https://bbpress.trac.wordpress.org/ticket/2586
+ *
+ * @since bbPress (r5377)
+ *
+ * @param int $reply_to
+ * @param int $reply_id
+ *
+ * @return int $reply_to
+ */
+function bbp_validate_reply_to( $reply_to = 0, $reply_id = 0 ) {
+
+        // The parent reply must actually be a reply
+        if ( ! bbp_is_reply( $reply_to ) ) {
+                $reply_to = 0;
+        }
+
+        // The parent reply cannot be itself
+        if ( $reply_id === $reply_to ) {
+                $reply_to = 0;
+        }
+
+        return (int) $reply_to;
+}

trunk/src/includes/replies/template.php

@@ -2466 +2466 @@
                 // Get $_REQUEST data
                 if ( isset( $_REQUEST['bbp_reply_to'] ) ) {
-                        $reply_to = (int) $_REQUEST['bbp_reply_to'];
+                        $reply_to = bbp_validate_reply_to( $_REQUEST['bbp_reply_to'] );
                 }
 

trunk/src/includes/topics/functions.php

@@ -1673 +1673 @@
 
                         // New topic from reply can't be a reply to
-                        if ( ( $from_reply->ID === $destination_topic->ID && $from_reply->ID === $reply_to ) ) {
+                        if ( ( $from_reply->ID === $destination_topic->ID ) && ( $from_reply->ID === $reply_to ) ) {
                                 bbp_update_reply_to( $reply->ID, 0 );
                         }