Changeset 8125 for trunk/bp-activity/bp-activity-classes.php

Timestamp:

03/13/2014 06:34:06 PM (11 years ago)

Author:

boonebgorges

Message:

Generate activity actions dynamically, instead of using static values stored in the database

Activity actions - like 'Joe became a registered member' - have always been
stored as static strings in the activity table. This has been a perennial thorn
in the side of BP site administrators. For one thing, static strings cannot be
translated for multilingual audiences (without unreasonable workarounds).
For another, information in these static strings becomes out of date as users
change their display names, groups change their names, and so on.

This changeset makes it possible for activity types to be registered with a
new $format_callback function, passed to bp_activity_set_action(), which BP
will use to generate the action dynamically when building the activity loop.
This makes the activity stream fully localizable, continually up-to-date, and
generally the bomb dot com.

Existing plugins that do not register format_callback functions will continue
to have their actions pulled directly from the database. Likewise, since a copy
of the static string is saved in the activity table, static strings can be
served if the given component is disabled at any point (and thus the callback
is no longer available).

The original argument for caching the action strings was that generating them
inline was too resource intensive; it often requires pulling up display names,
user permalinks, group links, blog post names, and so forth. To address this
problem, each component can now prefetch required data at the beginning of an
activity loop by hooking to bp_activity_prefetch_object_data, and loading any
relevant data into the cache. The Activity, Friends, Groups, and Blogs
component now do this natively. It's likely that this prefetching will have
other performance benefits, as plugin authors will now be able to access user
data etc inline without performance penalties.

The case of the Blogs component is a special one; it's not practical to
prefetch data from multiple blogs at the beginning of a loop, due to the
resources required by switch_to_blog(). For this reason, the format_callback
functions in the blog component cache some relevant data (like the post name)
in blogmeta, where it's readily accessible within the loop.

Fixes #3856

File:

• trunk/bp-activity/bp-activity-classes.php (modified) (3 diffs)

trunk/bp-activity/bp-activity-classes.php

@@ -161 +161 @@
             $this->mptt_right        = $row->mptt_right;
             $this->is_spam           = $row->is_spam;
+        }
+
+        // Generate dynamic 'action' when possible
+        $action = bp_activity_generate_action_string( $this );
+        if ( false !== $action ) {
+            $this->action = $action;
+
+        // If no callback is available, use the literal string from
+        // the database row
+        } else if ( ! empty( $row->action ) ) {
+            $this->action = $row->action;
+
+        // Provide a fallback to avoid PHP notices
+        } else {
+            $this->action = '';
         }
     }
@@ -443 +458 @@
             $activities = BP_Activity_Activity::append_comments( $activities, $spam );
 
+        // Pre-fetch data associated with activity users and other objects
+        BP_Activity_Activity::prefetch_object_data( $activities );
+
+        // Generate action strings
+        $activities = BP_Activity_Activity::generate_action_strings( $activities );
+
         // If $max is set, only return up to the max results
         if ( !empty( $max ) ) {
@@ -540 +561 @@
                 }
             }
+        }
+
+        return $activities;
+    }
+
+    /**
+     * Pre-fetch data for objects associated with activity items.
+     *
+     * Activity items are associated with users, and often with other
+     * BuddyPress data objects. Here, we pre-fetch data about these
+     * associated objects, so that inline lookups - done primarily when
+     * building action strings - do not result in excess database queries.
+     *
+     * The only object data required for activity component activity types
+     * (activity_update and activity_comment) is related to users, and that
+     * info is fetched separately in BP_Activity_Activity::get_activity_data().
+     * So this method contains nothing but a filter that allows other
+     * components, such as bp-friends and bp-groups, to hook in and prime
+     * their own caches at the beginning of an activity loop.
+     *
+     * @since BuddyPress (2.0.0)
+     *
+     * @param array $activities Array of activities.
+     */
+    protected static function prefetch_object_data( $activities ) {
+        return apply_filters( 'bp_activity_prefetch_object_data', $activities );
+    }
+
+    /**
+     * Generate action strings for the activities located in BP_Activity_Activity::get().
+     *
+     * If no string can be dynamically generated for a given item
+     * (typically because the activity type has not been properly
+     * registered), the static 'action' value pulled from the database will
+     * be left in place.
+     *
+     * @since BuddyPress (2.0.0)
+     *
+     * @param array $activities Array of activities.
+     * @return array
+     */
+    protected static function generate_action_strings( $activities ) {
+        foreach ( $activities as $key => $activity ) {
+            $generated_action = bp_activity_generate_action_string( $activity );
+            if ( false !== $generated_action ) {
+                $activity->action = $generated_action;
+            }
+
+            $activities[ $key ] = $activity;
         }