Changeset 8747

Timestamp:

08/01/2014 07:58:47 PM (12 years ago)

Author:

boonebgorges

Message:

Ensure that the 'Comments' dropdown filter on the activity directory includes new- and old-style comment activity

The change in BuddyPress 2.0 to storing blog comment activity in
activity_comment items resulted in the 'Comments' dropdown filter breaking: it
continued to return only 'new_blog_comment' items. This changeset introduces
a number of filters to ensure that both the appropriate 'activity_comment'
and 'new_blog_comment' items are included when passing 'action=new_blog_comment'
to bp_has_activities().

See #5608

Location:

trunk

Files:

• src/bp-blogs/bp-blogs-activity.php (modified) (1 diff)
• tests/phpunit/testcases/activity/template.php (modified) (1 diff)

trunk/src/bp-blogs/bp-blogs-activity.php

@@ -658 +658 @@
 
 /**
+ * Filter 'new_blog_comment' bp_has_activities() loop to include new- and old-style blog activity comment items.
+ *
+ * In BuddyPress 2.0, the schema for storing activity items related to blog
+ * posts changed. Instead creating new top-level 'new_blog_comment' activity
+ * items, blog comments are recorded in the activity stream as comments on the
+ * 'new_blog_post' activity items corresponding to the parent post. This filter
+ * ensures that the 'new_blog_comment' filter in bp_has_activities() (which
+ * powers the 'Comments' filter in the activity directory dropdown) includes
+ * both old-style and new-style activity comments.
+ *
+ * This implementation involves filtering the activity queries directly, and
+ * should be considered a stopgap. The proper solution would involve enabling
+ * multiple query condition clauses, connected by an OR, in the bp_has_activities()
+ * API.
+ *
+ * @since BuddyPress (2.1.0)
+ *
+ * @param array $args Arguments passed from bp_parse_args() in bp_has_activities().
+ * @return array $args
+ */
+function bp_blogs_new_blog_comment_query_backpat( $args ) {
+        // Bail if this is not a 'new_blog_comment' query
+        if ( 'new_blog_comment' !== $args['action'] ) {
+                return $args;
+        }
+
+        // display_comments=stream is required to show new-style
+        // 'activity_comment' items inline
+        $args['display_comments'] = 'stream';
+
+        // For the remaining clauses, we filter the SQL query directly
+        add_filter( 'bp_activity_paged_activities_sql', '_bp_blogs_new_blog_comment_query_backpat_filter' );
+        add_filter( 'bp_activity_total_activities_sql', '_bp_blogs_new_blog_comment_query_backpat_filter' );
+
+        // Return the original arguments
+        return $args;
+}
+add_filter( 'bp_after_has_activities_parse_args', 'bp_blogs_new_blog_comment_query_backpat' );
+
+/**
+ * Filter activity SQL to include new- and old-style 'new_blog_comment' activity items.
+ *
+ * @since BuddyPress (2.1.0)
+ *
+ * @access private
+ * @see bp_blogs_new_blog_comment_query_backpat()
+ *
+ * @param string $query SQL query as assembled in BP_Activity_Activity::get().
+ * @return string $query Modified SQL query.
+ */
+function _bp_blogs_new_blog_comment_query_backpat_filter( $query ) {
+        $bp = buddypress();
+
+        // The query passed to the filter is for old-style 'new_blog_comment'
+        // items. We include new-style 'activity_comment' items by running a
+        // subquery inside of a large OR clause.
+        $activity_comment_subquery = "SELECT a.id FROM {$bp->activity->table_name} a INNER JOIN {$bp->activity->table_name_meta} am ON (a.id = am.activity_id) WHERE am.meta_key = 'bp_blogs_post_comment_id' AND a.type = 'activity_comment'";
+
+        // WHERE ( [original WHERE clauses] OR a.id IN (activity_comment subquery) )
+        $query = preg_replace( '|WHERE (.*?) ORDER|', 'WHERE ( ( $1 ) OR ( a.id IN ( ' . $activity_comment_subquery . ' ) ) ) ORDER', $query );
+
+        // Don't run this on future queries
+        remove_filter( current_filter(), '_bp_blogs_new_blog_comment_query_backpat_filter' );
+
+        return $query;
+}
+
+/**
  * Utility function to set up some variables for use in the activity loop.
  *

trunk/tests/phpunit/testcases/activity/template.php

@@ -310 +310 @@
 
         /**
+         * @group bp_has_activities
+         */
+        public function test_bp_has_activities_with_type_new_blog_comments() {
+                add_filter( 'bp_disable_blogforum_comments', '__return_false' );
+
+                $now = time();
+                $a1 = $this->factory->activity->create( array(
+                        'content' => 'Life Rules',
+                        'component' => 'blogs',
+                        'type' => 'new_blog_post',
+                        'recorded_time' => date( 'Y-m-d H:i:s', $now ),
+                ) );
+                $a2 = $this->factory->activity->create( array(
+                        'content' => 'Life Drools',
+                        'component' => 'blogs',
+                        'type' => 'new_blog_comment',
+                        'recorded_time' => date( 'Y-m-d H:i:s', $now - 100 ),
+                ) );
+
+                // This one will show up in the stream because it's a comment
+                // on a blog post
+                $a3 = bp_activity_new_comment( array(
+                        'activity_id' => $a1,
+                        'content' => 'Candy is good',
+                        'recorded_time' => date( 'Y-m-d H:i:s', $now - 200 ),
+                ) );
+
+                $a4 = $this->factory->activity->create( array(
+                        'content' => 'Life Rulez',
+                        'component' => 'activity',
+                        'type' => 'activity_update',
+                        'recorded_time' => date( 'Y-m-d H:i:s', $now - 300 ),
+                ) );
+
+                // This one should not show up in the stream because it's a
+                // comment on an activity item
+                $a5 = bp_activity_new_comment( array(
+                        'activity_id' => $a4,
+                        'content' => 'Candy is great',
+                        'recorded_time' => date( 'Y-m-d H:i:s', $now - 400 ),
+                ) );
+                global $activities_template;
+
+                // prime
+                bp_has_activities( array(
+                        'component' => 'blogs',
+                        'action' => 'new_blog_comment',
+                ) );
+
+                $this->assertEquals( array( $a3, $a2 ), wp_parse_id_list( wp_list_pluck( $activities_template->activities, 'id' ) ) );
+
+                // Clean up
+                $activities_template = null;
+                remove_filter( 'bp_disable_blogforum_comments', '__return_false' );
+        }
+
+        /**
          * @group bp_activity_can_comment_reply
          */