Changeset 4709 for trunk/bp-core/bp-core-classes.php

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

File:

• trunk/bp-core/bp-core-classes.php (modified) (1 diff)

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 );
+    }
+}
 ?>