Changeset 7769

Timestamp:

02/02/2014 07:09:47 PM (11 years ago)

Author:

boonebgorges

Message:

Improve default avatar handling in bp_core_fetch_avatar()

Changes to Gravatar over the last few years have placed restrictions on the way
that a default gravatar (to be used as a fallback for when no actual Gravatar
is found) can be served to gravatar.com. In particular, Gravatar cannot cache
and serve default images that are not publicly available (as in dev
environments) or are only available over SSL.

Because BuddyPress's default behavior was to provide a local copy of the
mystery-man avatar, switching to Gravatar's hosted mystery-man solves these
problems for sites that are using the default mystery-man as a fallback image.

This changeset also reconfigures the way that the BP_AVATAR_DEFAULT constant
is respected, to ensure that it's possible to override the avatar fallback when
no_grav is set to true.

Fixes #4571

Props r-a-y

File:

• trunk/bp-core/bp-core-avatars.php (modified) (6 diffs)

trunk/bp-core/bp-core-avatars.php

@@ -38 +38 @@
         }
     }
-
-    if ( !defined( 'BP_AVATAR_DEFAULT' ) )
-        define( 'BP_AVATAR_DEFAULT', $bp->plugin_url . 'bp-core/images/mystery-man.jpg' );
-
-    if ( !defined( 'BP_AVATAR_DEFAULT_THUMB' ) )
-        define( 'BP_AVATAR_DEFAULT_THUMB', $bp->plugin_url . 'bp-core/images/mystery-man-50.jpg' );
 
     if ( ! defined( 'BP_SHOW_AVATARS' ) ) {
@@ -74 +68 @@
 
     // Defaults
-    $bp->avatar->thumb->default = BP_AVATAR_DEFAULT_THUMB;
-    $bp->avatar->full->default  = BP_AVATAR_DEFAULT;
+    $bp->avatar->thumb->default = bp_core_avatar_default_thumb();
+    $bp->avatar->full->default  = bp_core_avatar_default();
 
     // These have to be set on page load in order to avoid infinite filter loops at runtime
@@ -440 +434 @@
             $default_grav = 'wavatar';
         } else if ( 'mystery' == $bp->grav_default->{$object} ) {
-            $default_grav = apply_filters( 'bp_core_mysteryman_src', bp_core_avatar_default(), $grav_size );
+            $default_grav = apply_filters( 'bp_core_mysteryman_src', 'mm', $grav_size );
         } else {
             $default_grav = $bp->grav_default->{$object};
@@ -472 +466 @@
     // No avatar was found, and we've been told not to use a gravatar.
     } else {
-        $gravatar = apply_filters( "bp_core_default_avatar_$object", $bp->plugin_url . 'bp-core/images/mystery-man.jpg', $params );
+        $gravatar = apply_filters( "bp_core_default_avatar_$object", bp_core_avatar_default( 'local' ), $params );
     }
 
@@ -1117 +1111 @@
  * @since BuddyPress (1.5.0)
  *
+ * @param string $type 'local' if the fallback should be the locally-hosted
+ *        version of the mystery-man, 'gravatar' if the fallback should be
+ *        Gravatar's version. Default: 'gravatar'.
  * @return string The URL of the default avatar.
  */
-function bp_core_avatar_default() {
-    return apply_filters( 'bp_core_avatar_default', buddypress()->avatar->full->default );
+function bp_core_avatar_default( $type = 'gravatar' ) {
+    // Local override
+    if ( defined( 'BP_AVATAR_DEFAULT' ) ) {
+        $avatar = BP_AVATAR_DEFAULT;
+
+    // Use the local default image
+    } else if ( 'local' === $type ) {
+        $avatar = buddypress()->plugin_url . 'bp-core/images/mystery-man.jpg';
+
+    // Use Gravatar's mystery man as fallback
+    } else {
+        if ( is_ssl() ) {
+            $host = 'https://secure.gravatar.com';
+        } else {
+            $host = 'http://www.gravatar.com';
+        }
+
+        $avatar = $host . '/avatar/00000000000000000000000000000000?d=mm&s=' . bp_core_avatar_full_width();
+    }
+
+    return apply_filters( 'bp_core_avatar_default', $avatar );
 }
 
@@ -1126 +1142 @@
  * Get the URL of the 'thumb' default avatar.
  *
+ * Uses Gravatar's mystery-man avatar, unless BP_AVATAR_DEFAULT_THUMB has been
+ * defined.
+ *
  * @since BuddyPress (1.5.0)
  *
+ * @param string $type 'local' if the fallback should be the locally-hosted
+ *        version of the mystery-man, 'gravatar' if the fallback should be
+ *        Gravatar's version. Default: 'gravatar'.
  * @return string The URL of the default avatar thumb.
  */
-function bp_core_avatar_default_thumb() {
-    return apply_filters( 'bp_core_avatar_thumb', buddypress()->avatar->thumb->default );
-}
+function bp_core_avatar_default_thumb( $type = 'gravatar' ) {
+    // Local override
+    if ( defined( 'BP_AVATAR_DEFAULT_THUMB' ) ) {
+        $avatar = BP_AVATAR_DEFAULT_THUMB;
+
+    // Use the local default image
+    } else if ( 'local' === $type ) {
+        $avatar = buddypress()->plugin_url . 'bp-core/images/mystery-man-50.jpg';
+
+    // Use Gravatar's mystery man as fallback
+    } else {
+        if ( is_ssl() ) {
+            $host = 'https://secure.gravatar.com';
+        } else {
+            $host = 'http://www.gravatar.com';
+        }
+
+        $avatar = $host . '/avatar/00000000000000000000000000000000?d=mm&s=' . bp_core_avatar_thumb_width();
+    }
+
+    return apply_filters( 'bp_core_avatar_thumb', $avatar );
+}