Changeset 7207 for trunk/bp-activity/bp-activity-actions.php

Timestamp:

06/12/2013 10:08:10 PM (10 years ago)

Author:

boonebgorges

Message:

Introduces BP_Activity_Feed class, and migrates existing feeds

RSS feeds for BP activity have historically been generated on a one-by-one
basis, with separate template files used for each theme. This resulted in a
huge amount of unnecessarily duplicated code. Moreover, it made the process
of customizing feeds, or providing new feeds, unnecessarily cumbersome.

BP_Activity_Feed abstracts the central parts of RSS feed building, allowing for
easier customization, and fewer points of failure.

This changeset also fixes our RSS implementation to match best practices with
respect to encoding content inside of the <description> element.

Fixes #5020

Props r-a-y

File:

• trunk/bp-activity/bp-activity-actions.php (modified) (6 diffs)

trunk/bp-activity/bp-activity-actions.php

@@ -422 +422 @@
  */
 function bp_activity_action_sitewide_feed() {
-    global $bp, $wp_query;
-
-    if ( !bp_is_activity_component() || !bp_is_current_action( 'feed' ) || bp_is_user() || !empty( $bp->groups->current_group ) )
-        return false;
-
-    $wp_query->is_404 = false;
-    status_header( 200 );
-
-    include_once( 'feeds/bp-activity-sitewide-feed.php' );
-    die;
+    global $bp;
+
+    if ( ! bp_is_activity_component() || ! bp_is_current_action( 'feed' ) || bp_is_user() || ! empty( $bp->groups->current_group ) )
+        return false;
+
+    // setup the feed
+    buddypress()->activity->feed = new BP_Activity_Feed( array(
+        'id'            => 'sitewide',
+
+        /* translators: Sitewide activity RSS title - "[Site Name] | Site Wide Activity" */
+        'title'         => sprintf( __( '%s | Site Wide Activity', 'buddypress' ), bp_get_site_name() ),
+
+        'link'          => bp_get_activity_directory_permalink(),
+        'description'   => __( 'Activity feed for the entire site.', 'buddypress' ),
+        'activity_args' => 'display_comments=threaded'
+    ) );
 }
 add_action( 'bp_actions', 'bp_activity_action_sitewide_feed' );
@@ -448 +454 @@
  */
 function bp_activity_action_personal_feed() {
-    global $wp_query;
-
-    if ( !bp_is_user_activity() || !bp_is_current_action( 'feed' ) )
-        return false;
-
-    $wp_query->is_404 = false;
-    status_header( 200 );
-
-    include_once( 'feeds/bp-activity-personal-feed.php' );
-    die;
+    if ( ! bp_is_user_activity() || ! bp_is_current_action( 'feed' ) ) {
+        return false;
+    }
+
+    // setup the feed
+    buddypress()->activity->feed = new BP_Activity_Feed( array(
+        'id'            => 'personal',
+
+        /* translators: Personal activity RSS title - "[Site Name] | [User Display Name] | Activity" */
+        'title'         => sprintf( __( '%1$s | %2$s | Activity', 'buddypress' ), bp_get_site_name(), bp_get_displayed_user_fullname() ),
+
+        'link'          => trailingslashit( bp_displayed_user_domain() . bp_get_activity_slug() ),
+        'description'   => sprintf( __( 'Activity feed for %s.', 'buddypress' ), bp_get_displayed_user_fullname() ),
+        'activity_args' => 'user_id=' . bp_displayed_user_id()
+    ) );
 }
 add_action( 'bp_actions', 'bp_activity_action_personal_feed' );
@@ -477 +488 @@
  */
 function bp_activity_action_friends_feed() {
-    global $wp_query;
-
-    if ( !bp_is_active( 'friends' ) || !bp_is_user_activity() || !bp_is_current_action( bp_get_friends_slug() ) || !bp_is_action_variable( 'feed', 0 ) )
-        return false;
-
-    $wp_query->is_404 = false;
-    status_header( 200 );
-
-    include_once( 'feeds/bp-activity-friends-feed.php' );
-    die;
+    if ( ! bp_is_active( 'friends' ) || ! bp_is_user_activity() || ! bp_is_current_action( bp_get_friends_slug() ) || ! bp_is_action_variable( 'feed', 0 ) ) {
+        return false;
+    }
+
+    // setup the feed
+    buddypress()->activity->feed = new BP_Activity_Feed( array(
+        'id'            => 'friends',
+
+        /* translators: Friends activity RSS title - "[Site Name] | [User Display Name] | Friends Activity" */
+        'title'         => sprintf( __( '%1$s | %2$s | Friends Activity', 'buddypress' ), bp_get_site_name(), bp_get_displayed_user_fullname() ),
+
+        'link'          => trailingslashit( bp_displayed_user_domain() . bp_get_activity_slug() . '/' . bp_get_friends_slug() ),
+        'description'   => sprintf( __( "Activity feed for %s' friends.", 'buddypress' ), bp_get_displayed_user_fullname() ),
+        'activity_args' => 'scope=friends'
+    ) );
 }
 add_action( 'bp_actions', 'bp_activity_action_friends_feed' );
@@ -506 +522 @@
  */
 function bp_activity_action_my_groups_feed() {
+    if ( ! bp_is_active( 'groups' ) || ! bp_is_user_activity() || ! bp_is_current_action( bp_get_groups_slug() ) || ! bp_is_action_variable( 'feed', 0 ) ) {
+        return false;
+    }
+
+    // get displayed user's group IDs
+    $groups    = groups_get_user_groups();
+    $group_ids = implode( ',', $groups['groups'] );
+
+    // setup the feed
+    buddypress()->activity->feed = new BP_Activity_Feed( array(
+        'id'            => 'mygroups',
+
+        /* translators: Member groups activity RSS title - "[Site Name] | [User Display Name] | Groups Activity" */
+        'title'         => sprintf( __( '%1$s | %2$s | Group Activity', 'buddypress' ), bp_get_site_name(), bp_get_displayed_user_fullname() ),
+
+        'link'          => trailingslashit( bp_displayed_user_domain() . bp_get_activity_slug() . '/' . bp_get_groups_slug() ),
+        'description'   => sprintf( __( "Public group activity feed of which %s is a member of.", 'buddypress' ), bp_get_displayed_user_fullname() ),
+        'activity_args' => array(
+            'object'           => buddypress()->groups->id,
+            'primary_id'       => $group_ids,
+            'display_comments' => 'threaded'
+        )
+    ) );
+}
+add_action( 'bp_actions', 'bp_activity_action_my_groups_feed' );
+
+/**
+ * Load a user's @mentions feed.
+ *
+ * @since BuddyPress (1.2)
+ *
+ * @global object $wp_query
+ * @uses bp_is_user_activity()
+ * @uses bp_is_current_action()
+ * @uses bp_is_action_variable()
+ * @uses status_header()
+ *
+ * @return bool False on failure
+ */
+function bp_activity_action_mentions_feed() {
     global $wp_query;
 
-    if ( !bp_is_active( 'groups' ) || !bp_is_user_activity() || !bp_is_current_action( bp_get_groups_slug() ) || !bp_is_action_variable( 'feed', 0 ) )
+    if ( ! bp_activity_do_mentions() ) {
+        return false;
+    }
+
+    if ( !bp_is_user_activity() || !bp_is_current_action( 'mentions' ) || !bp_is_action_variable( 'feed', 0 ) )
         return false;
 
@@ -514 +574 @@
     status_header( 200 );
 
-    include_once( 'feeds/bp-activity-mygroups-feed.php' );
+    include_once( 'feeds/bp-activity-mentions-feed.php' );
     die;
 }
-add_action( 'bp_actions', 'bp_activity_action_my_groups_feed' );
-
-/**
- * Load a user's @mentions feed.
+add_action( 'bp_actions', 'bp_activity_action_mentions_feed' );
+
+/**
+ * Load a user's favorites feed.
  *
  * @since BuddyPress (1.2)
@@ -532 +592 @@
  * @return bool False on failure
  */
-function bp_activity_action_mentions_feed() {
-    global $wp_query;
-
-    if ( ! bp_activity_do_mentions() ) {
-        return false;
-    }
-
-    if ( !bp_is_user_activity() || !bp_is_current_action( 'mentions' ) || !bp_is_action_variable( 'feed', 0 ) )
-        return false;
-
-    $wp_query->is_404 = false;
-    status_header( 200 );
-
-    include_once( 'feeds/bp-activity-mentions-feed.php' );
-    die;
-}
-add_action( 'bp_actions', 'bp_activity_action_mentions_feed' );
-
-/**
- * Load a user's favorites feed.
- *
- * @since BuddyPress (1.2)
- *
- * @global object $wp_query
- * @uses bp_is_user_activity()
- * @uses bp_is_current_action()
- * @uses bp_is_action_variable()
- * @uses status_header()
- *
- * @return bool False on failure
- */
 function bp_activity_action_favorites_feed() {
-    global $wp_query;
-
-    if ( !bp_is_user_activity() || !bp_is_current_action( 'favorites' ) || !bp_is_action_variable( 'feed', 0 ) )
-        return false;
-
-    $wp_query->is_404 = false;
-    status_header( 200 );
-
-    include_once( 'feeds/bp-activity-favorites-feed.php' );
-    die;
+    if ( ! bp_is_user_activity() || ! bp_is_current_action( 'favorites' ) || ! bp_is_action_variable( 'feed', 0 ) ) {
+        return false;
+    }
+
+    // get displayed user's favorite activity IDs
+    $favs = bp_activity_get_user_favorites( bp_displayed_user_id() );
+    $fav_ids = implode( ',', (array) $favs );
+
+    // setup the feed
+    buddypress()->activity->feed = new BP_Activity_Feed( array(
+        'id'            => 'favorites',
+
+        /* translators: User activity favorites RSS title - "[Site Name] | [User Display Name] | Favorites" */
+        'title'         => sprintf( __( '%1$s | %2$s | Favorites', 'buddypress' ), bp_get_site_name(), bp_get_displayed_user_fullname() ),
+
+        'link'          => bp_displayed_user_domain() . bp_get_activity_slug() . '/favorites/',
+        'description'   => sprintf( __( "Activity feed of %s' favorites.", 'buddypress' ), bp_get_displayed_user_fullname() ),
+        'activity_args' => 'include=' . $fav_ids
+    ) );
 }
 add_action( 'bp_actions', 'bp_activity_action_favorites_feed' );