Changeset 4709

Timestamp:

07/18/2011 10:43:22 PM (14 years ago)

Author:

djpaul

Message:

Add oembed support to activity stream items and forum posts. Fixes #2707, massive props r-a-y

Location:

trunk

Files:

• bp-activity/bp-activity-functions.php (modified) (3 diffs)
• bp-core/bp-core-classes.php (modified) (1 diff)
• bp-core/bp-core-functions.php (modified) (12 diffs)
• bp-forums/bp-forums-functions.php (modified) (1 diff)

trunk/bp-activity/bp-activity-functions.php

@@ -117 +117 @@
  * @param int $secondary_item_id In the case of at-mentions, this is the mentioner's id
  * @param int $total_items The total number of notifications to format
- * @param str $format 'string' to get a BuddyBar-compatible notification, 'array' otherwise 
+ * @param str $format 'string' to get a BuddyBar-compatible notification, 'array' otherwise
  */
 function bp_activity_format_notifications( $action, $item_id, $secondary_item_id, $total_items, $format = 'string' ) {
@@ -139 +139 @@
         break;
     }
-                
+
     if ( 'string' == $format ) {
         $return = apply_filters( $filter, '<a href="' . $at_mention_link . '" title="' . $at_mention_title . '">' . $text . '</a>', $at_mention_link, (int)$total_items, $activity_id, $poster_user_id );
@@ -994 +994 @@
 }
 
+/** Embeds *******************************************************************/
+
+/**
+ * Grabs the activity ID and attempts to retrieve the oEmbed cache (if it exists)
+ * during the activity loop.  If no cache and link is embeddable, cache it.
+ *
+ * @see BP_Embed
+ * @see bp_embed_activity_cache()
+ * @see bp_embed_activity_save_cache()
+ * @package BuddyPress Activity
+ * @since 1.3
+ */
+function bp_activity_embed() {
+    add_filter( 'embed_post_id',         'bp_get_activity_id'                  );
+    add_filter( 'bp_embed_get_cache',    'bp_embed_activity_cache',      10, 3 );
+    add_action( 'bp_embed_update_cache', 'bp_embed_activity_save_cache', 10, 3 );
+}
+add_action( 'activity_loop_start', 'bp_activity_embed' );
+
+/**
+ * Wrapper function for {@link bp_activity_get_meta()}.
+ * Used during {@link BP_Embed::parse_oembed()} via {@link bp_activity_embed()}.
+ *
+ * @package BuddyPress Activity
+ * @since 1.3
+ */
+function bp_embed_activity_cache( $cache, $id, $cachekey ) {
+    return bp_activity_get_meta( $id, $cachekey );
+}
+
+/**
+ * Wrapper function for {@link bp_activity_update_meta()}.
+ * Used during {@link BP_Embed::parse_oembed()} via {@link bp_activity_embed()}.
+ *
+ * @package BuddyPress Activity
+ * @since 1.3
+ */
+function bp_embed_activity_save_cache( $cache, $cachekey, $id ) {
+    bp_activity_update_meta( $id, $cachekey, $cache );
+}
 ?>

trunk/bp-core/bp-core-classes.php

@@ -1083 +1083 @@
 }
 
+/**
+ * BP_Embed
+ *
+ * Extends WP_Embed class for use with BuddyPress.
+ *
+ * @package BuddyPress Core
+ * @since 1.3
+ * @see WP_Embed
+ */
+class BP_Embed extends WP_Embed {
+    /**
+     * Constructor
+     *
+     * @global unknown $wp_embed
+     */
+    function __construct() {
+        global $wp_embed;
+
+        // Make sure we populate the WP_Embed handlers array.
+        // These are providers that use a regex callback on the URL in question.
+        // Do not confuse with oEmbed providers, which require an external ping.
+        // Used in WP_Embed::shortcode()
+        $this->handlers = $wp_embed->handlers;
+
+        if ( bp_use_embed_in_activity() ) {
+            add_filter( 'bp_get_activity_content_body', array( &$this, 'autoembed' ), 8 );
+            add_filter( 'bp_get_activity_content_body', array( &$this, 'run_shortcode' ), 7 );
+        }
+
+        if ( bp_use_embed_in_activity_replies() ) {
+            add_filter( 'bp_get_activity_content', array( &$this, 'autoembed' ), 8 );
+            add_filter( 'bp_get_activity_content', array( &$this, 'run_shortcode' ), 7 );
+        }
+
+        if ( bp_use_embed_in_forum_posts() ) {
+            add_filter( 'bp_get_the_topic_post_content', array( &$this, 'autoembed' ), 8 );
+            add_filter( 'bp_get_the_topic_post_content', array( &$this, 'run_shortcode' ), 7 );
+        }
+    }
+
+    /**
+     * The {@link do_shortcode()} callback function.
+     *
+     * Attempts to convert a URL into embed HTML. Starts by checking the URL against the regex of the registered embed handlers.
+     * Next, checks the URL against the regex of registered {@link WP_oEmbed} providers if oEmbed discovery is false.
+     * If none of the regex matches and it's enabled, then the URL will be passed to {@link BP_Embed::parse_oembed()} for oEmbed parsing.
+     *
+     * @uses wp_parse_args()
+     * @uses wp_embed_defaults()
+     * @uses current_user_can()
+     * @uses _wp_oembed_get_object()
+     * @uses WP_Embed::maybe_make_link()
+     *
+     * @param array $attr Shortcode attributes.
+     * @param string $url The URL attempting to be embeded.
+     * @return string The embed HTML on success, otherwise the original URL.
+     */
+    function shortcode( $attr, $url = '' ) {
+        if ( empty( $url ) )
+            return '';
+
+        $rawattr = $attr;
+        $attr = wp_parse_args( $attr, wp_embed_defaults() );
+
+        // kses converts & into & and we need to undo this
+        // See http://core.trac.wordpress.org/ticket/11311
+        $url = str_replace( '&', '&', $url );
+
+        // Look for known internal handlers
+        ksort( $this->handlers );
+        foreach ( $this->handlers as $priority => $handlers ) {
+            foreach ( $handlers as $id => $handler ) {
+                if ( preg_match( $handler['regex'], $url, $matches ) && is_callable( $handler['callback'] ) ) {
+                    if ( false !== $return = call_user_func( $handler['callback'], $matches, $attr, $url, $rawattr ) )
+                        return apply_filters( 'embed_handler_html', $return, $url, $attr );
+                }
+            }
+        }
+
+        // Get object ID
+        $id = apply_filters( 'embed_post_id', $id );
+
+        // Is oEmbed discovery on?
+        $attr['discover'] = ( apply_filters( 'bp_embed_oembed_discover', false ) && current_user_can( 'unfiltered_html' ) );
+
+        // Set up a new WP oEmbed object to check URL with registered oEmbed providers
+        require_once( ABSPATH . WPINC . '/class-oembed.php' );
+        $oembed_obj = _wp_oembed_get_object();
+
+        // If oEmbed discovery is true, skip oEmbed provider check
+        $is_oembed_link = false;
+        if ( !$attr['discover'] ) {
+            foreach ( (array)$oembed_obj->providers as $provider_matchmask => $provider ) {
+                $regex = ( $is_regex = $provider[1] ) ? $provider_matchmask : '#' . str_replace( '___wildcard___', '(.+)', preg_quote( str_replace( '*', '___wildcard___', $provider_matchmask ), '#' ) ) . '#i';
+
+                if ( preg_match( $regex, $url ) )
+                    $is_oembed_link = true;
+            }
+
+            // If url doesn't match a WP oEmbed provider, stop parsing
+            if ( !$is_oembed_link )
+                return $this->maybe_make_link( $url );
+        }
+
+        return $this->parse_oembed( $id, $url, $attr, $rawattr );
+    }
+
+    /**
+     * Base function so BP components / plugins can parse links to be embedded.
+     * View an example to add support in {@link bp_activity_embed()}.
+     *
+     * @uses apply_filters() Filters cache.
+     * @uses do_action() To save cache.
+     * @uses wp_oembed_get() Connects to oEmbed provider and returns HTML on success.
+     * @uses WP_Embed::maybe_make_link() Process URL for hyperlinking on oEmbed failure.
+     * @param int $id ID to do the caching for.
+     * @param string $url The URL attempting to be embedded.
+     * @param array $attr Shortcode attributes from {@link WP_Embed::shortcode()}.
+     * @param array $rawattr Untouched shortcode attributes from {@link WP_Embed::shortcode()}.
+     * @return string The embed HTML on success, otherwise the original URL.
+     */
+    function parse_oembed( $id, $url, $attr, $rawattr ) {
+        if ( $id ) {
+            // Setup the cachekey
+            $cachekey = '_oembed_' . md5( $url . serialize( $attr ) );
+
+            // Let components / plugins grab their cache
+            $cache = '';
+            $cache = apply_filters( 'bp_embed_get_cache', $cache, $id, $cachekey, $url, $attr, $rawattr );
+
+            // Grab cache and return it if available
+            if ( !empty( $cache ) ) {
+                return apply_filters( 'embed_oembed_html', $cache, $url, $attr, $rawattr );
+
+            // If no cache, ping the oEmbed provider and cache the result
+            } else {
+                $html = wp_oembed_get( $url, $attr );
+                $cache = ( $html ) ? $html : $url;
+
+                // Let components / plugins save their cache
+                do_action( 'bp_embed_update_cache', $cache, $cachekey, $id );
+
+                // If there was a result, return it
+                if ( $html )
+                    return apply_filters( 'bp_embed_oembed_html', $html, $url, $attr, $rawattr );
+            }
+        }
+
+        // Still unknown
+        return $this->maybe_make_link( $url );
+    }
+}
 ?>

trunk/bp-core/bp-core-functions.php

@@ -19 +19 @@
 function bp_get_option( $option_name, $default = '' ) {
     $value = get_blog_option( bp_get_root_blog_id(), $option_name, $default );
-    
+
     return apply_filters( 'bp_get_option', $value );
 }
@@ -79 +79 @@
 function bp_core_get_page_meta() {
     $page_ids = bp_get_option( 'bp-pages' );
-  
+
     // Upgrading from an earlier version of BP pre-1.3
-    if ( !isset( $page_ids['members'] ) && $ms_page_ids = get_site_option( 'bp-pages' ) ) {  
+    if ( !isset( $page_ids['members'] ) && $ms_page_ids = get_site_option( 'bp-pages' ) ) {
         $page_blog_id = bp_is_multiblog_mode() ? get_current_blog_id() : bp_get_root_blog_id();
 
@@ -90 +90 @@
         }
     }
-    
+
     return apply_filters( 'bp_core_get_page_meta', $page_ids );
 }
@@ -698 +698 @@
 function bp_core_record_activity() {
     global $bp;
-    
+
     if ( !is_user_logged_in() )
         return false;
-    
+
     $user_id = $bp->loggedin_user->id;
-    
+
     if ( bp_core_is_user_spammer( $user_id ) || bp_core_is_user_deleted( $user_id ) )
         return false;
@@ -912 +912 @@
 }
 add_action( 'bp_init', 'bp_core_add_ajax_hook' );
+
+/**
+ * Initializes {@link BP_Embed} after everything is loaded.
+ *
+ * @global object $bp BuddyPress global settings
+ * @package BuddyPress Core
+ * @since 1.3
+ */
+function bp_embed_init() {
+    global $bp;
+
+    if ( empty( $bp->embed ) )
+        $bp->embed = new BP_Embed();
+}
+add_action( 'bp_init', 'bp_embed_init' );
 
 /**
@@ -1075 +1090 @@
  */
 function bp_is_root_blog( $blog_id = 0 ) {
-    
     // Assume false
     $is_root_blog = false;
@@ -1119 +1133 @@
 
         define( 'BP_ROOT_BLOG', $root_blog_id );
-        
+
     // Root blog is defined
     } else {
@@ -1221 +1235 @@
  *
  * @uses apply_filters() Filter 'bp_is_username_compatibility_mode' to alter
- * @return bool False when compatibility mode is disabled (default); true when enabled 
+ * @return bool False when compatibility mode is disabled (default); true when enabled
  */
 function bp_is_username_compatibility_mode() {
@@ -1232 +1246 @@
  * Note that BP_ENABLE_MULTIBLOG is different from (but dependent on) WP Multisite. "Multiblog" is
  * a BP setup that allows BP content to be viewed in the theme, and with the URL, of every blog
- * on the network. Thus, instead of having all 'boonebgorges' links go to 
+ * on the network. Thus, instead of having all 'boonebgorges' links go to
  *   http://example.com/members/boonebgorges
  * on the root blog, each blog will have its own version of the same profile content, eg
@@ -1245 +1259 @@
  *
  * @uses apply_filters() Filter 'bp_is_multiblog_mode' to alter
- * @return bool False when multiblog mode is disabled (default); true when enabled 
+ * @return bool False when multiblog mode is disabled (default); true when enabled
  */
 function bp_is_multiblog_mode() {
@@ -1264 +1278 @@
  *
  * @uses apply_filters() Filter 'bp_use_wp_admin_bar' to alter
- * @return bool False when WP Admin Bar support is disabled (default); true when enabled 
+ * @return bool False when WP Admin Bar support is disabled (default); true when enabled
  */
 function bp_use_wp_admin_bar() {
     return apply_filters( 'bp_use_wp_admin_bar', defined( 'BP_USE_WP_ADMIN_BAR' ) && BP_USE_WP_ADMIN_BAR );
+}
+
+/**
+ * Are oembeds allowed in activity items?
+ *
+ * @return bool False when activity embed support is disabled; true when enabled (default)
+ * @since 1.3
+ */
+function bp_use_embed_in_activity() {
+    return apply_filters( 'bp_use_oembed_in_activity', !defined( 'BP_EMBED_DISABLE_ACTIVITY' ) || !BP_EMBED_DISABLE_ACTIVITY );
+}
+
+/**
+ * Are oembeds allwoed in acitivity replies?
+ *
+ * @return bool False when activity replies embed support is disabled; true when enabled (default)
+ * @since 1.3
+ */
+function bp_use_embed_in_activity_replies() {
+    return apply_filters( 'bp_use_embed_in_activity_replies', !defined( 'BP_EMBED_DISABLE_ACTIVITY_REPLIES' ) || !BP_EMBED_DISABLE_ACTIVITY_REPLIES );
+}
+
+/**
+ * Are oembeds allowed on forum posts?
+ *
+ * @return bool False when form post embed support is disabled; true when enabled (default)
+ * @since 1.3
+ */
+function bp_use_embed_in_forum_posts() {
+    return apply_filters( 'bp_use_embed_in_forum_posts', !defined( 'BP_EMBED_DISABLE_FORUM_POSTS' ) || !BP_EMBED_DISABLE_FORUM_POSTS );
 }
 
@@ -1373 +1417 @@
     do_action( 'bp_do_404', $redirect );
 
-    $wp_query->set_404(); 
-    status_header( 404 ); 
+    $wp_query->set_404();
+    status_header( 404 );
     nocache_headers();
 

trunk/bp-forums/bp-forums-functions.php

@@ -515 +515 @@
 add_action( 'bp_forums_new_post',  'bp_core_clear_cache' );
 
+
+/** Embeds *******************************************************************/
+
+/**
+ * Grabs the topic post ID and attempts to retrieve the oEmbed cache (if it exists)
+ * during the forum topic loop.  If no cache and link is embeddable, cache it.
+ *
+ * @see BP_Embed
+ * @see bp_embed_forum_cache()
+ * @see bp_embed_forum_save_cache()
+ * @package BuddyPress_Forums
+ * @since 1.3
+ */
+function bp_forums_embed() {
+    add_filter( 'embed_post_id',         'bp_get_the_topic_post_id'         );
+    add_filter( 'bp_embed_get_cache',    'bp_embed_forum_cache',      10, 3 );
+    add_action( 'bp_embed_update_cache', 'bp_embed_forum_save_cache', 10, 3 );
+}
+add_action( 'topic_loop_start', 'bp_forums_embed' );
+
+/**
+ * Wrapper function for {@link bb_get_postmeta()}.
+ * Used during {@link BP_Embed::parse_oembed()} via {@link bp_forums_embed()}.
+ *
+ * @package BuddyPress_Forums
+ * @since 1.3
+ */
+function bp_embed_forum_cache( $cache, $id, $cachekey ) {
+    return bb_get_postmeta( $id, $cachekey );
+}
+
+/**
+ * Wrapper function for {@link bb_update_postmeta()}.
+ * Used during {@link BP_Embed::parse_oembed()} via {@link bp_forums_embed()}.
+ *
+ * @package BuddyPress_Forums
+ * @since 1.3
+ */
+function bp_embed_forum_save_cache( $cache, $cachekey, $id ) {
+    bb_update_postmeta( $id, $cachekey, $cache );
+}
 ?>