Ticket #41544: 41544.diff

src/wp-includes/link-template.php

@@ -3877 +3877 @@
                 return apply_filters( 'get_avatar_data', $args, $id_or_email );
         }
 
-        $email_hash = '';
-        $user = $email = false;
-
         if ( is_object( $id_or_email ) && isset( $id_or_email->comment_ID ) ) {
                 $id_or_email = get_comment( $id_or_email );
         }
 
-        // Process the user identifier.
-        if ( is_numeric( $id_or_email ) ) {
-                $user = get_user_by( 'id', absint( $id_or_email ) );
-        } elseif ( is_string( $id_or_email ) ) {
-                if ( strpos( $id_or_email, '@md5.gravatar.com' ) ) {
-                        // md5 hash
-                        list( $email_hash ) = explode( '@', $id_or_email );
-                } else {
-                        // email address
-                        $email = $id_or_email;
-                }
-        } elseif ( $id_or_email instanceof WP_User ) {
-                // User Object
-                $user = $id_or_email;
-        } elseif ( $id_or_email instanceof WP_Post ) {
-                // Post Object
-                $user = get_user_by( 'id', (int) $id_or_email->post_author );
-        } elseif ( $id_or_email instanceof WP_Comment ) {
-                /**
-                 * Filters the list of allowed comment types for retrieving avatars.
-                 *
-                 * @since 3.0.0
-                 *
-                 * @param array $types An array of content types. Default only contains 'comment'.
-                 */
-                $allowed_comment_types = apply_filters( 'get_avatar_comment_types', array( 'comment' ) );
-                if ( ! empty( $id_or_email->comment_type ) && ! in_array( $id_or_email->comment_type, (array) $allowed_comment_types ) ) {
-                        $args['url'] = false;
-                        /** This filter is documented in wp-includes/link-template.php */
-                        return apply_filters( 'get_avatar_data', $args, $id_or_email );
-                }
-
-                if ( ! empty( $id_or_email->user_id ) ) {
-                        $user = get_user_by( 'id', (int) $id_or_email->user_id );
-                }
-                if ( ( ! $user || is_wp_error( $user ) ) && ! empty( $id_or_email->comment_author_email ) ) {
-                        $email = $id_or_email->comment_author_email;
-                }
-        }
-
-        if ( ! $email_hash ) {
-                if ( $user ) {
-                        $email = $user->user_email;
-                }
+        $parsed = wp_parse_id_or_email( $id_or_email );
 
-                if ( $email ) {
-                        $email_hash = md5( strtolower( trim( $email ) ) );
-                }
+        if( 'comment-disallowed-type' === $parsed['context'] ) {
+                $args['url'] = false;
+                /** This filter is documented in wp-includes/link-template.php */
+                return apply_filters( 'get_avatar_data', $args, $id_or_email );
         }
 
-        if ( $email_hash ) {
+        if ( ! empty( $parsed['email_hash'] ) ) {
                 $args['found_avatar'] = true;
-                $gravatar_server = hexdec( $email_hash[0] ) % 3;
+                $gravatar_server = hexdec( $parsed['email_hash'][0] ) % 3;
         } else {
                 $gravatar_server = rand( 0, 2 );
         }
@@ -3949 +3904 @@
         );
 
         if ( is_ssl() ) {
-                $url = 'https://secure.gravatar.com/avatar/' . $email_hash;
+                $url = 'https://secure.gravatar.com/avatar/' . $parsed['email_hash'];
         } else {
-                $url = sprintf( 'http://%d.gravatar.com/avatar/%s', $gravatar_server, $email_hash );
+                $url = sprintf( 'http://%d.gravatar.com/avatar/%s', $gravatar_server, $parsed['email_hash'] );
         }
 
         $url = add_query_arg(
@@ -3984 +3939 @@
 }
 
 /**
+ * Parse `$id_or_email`
+ *
+ * Parse the generic `$id_or_email` input into user_id, email, email_hash and context.
+ *
+ * @since x.x.x
+ *
+ * @param mixed $id_or_email The Gravatar to retrieve. Accepts a user_id, gravatar md5 hash,
+ *                           user email, WP_User object, WP_Post object, or WP_Comment object.
+ * @return array $parsed_args {
+ *     Parsed data from the `$id_or_email` input.
+ *
+ *     @type int    $user_id    User ID if we were able to find a user. Default 0.
+ *     @type string $email      The email. Default empty.
+ *     @type string $email_hash The hashed email. Default empty.
+ *     @type string $context    The input context. Possible values are 'user_id', 
+ *                              'email-md5-gravatar', 'email', 'user', 'post', 
+ *                              'comment-allowed-type', 'comment-disallowed-type',
+ * }
+ */
+function wp_parse_id_or_email( $id_or_email ) {
+        $email_hash = $email = $context = '';
+        $user = null;
+        
+        // Process the user identifier.
+        if ( is_numeric( $id_or_email ) ) {
+                $user = get_user_by( 'id', absint( $id_or_email ) );
+                $context = 'user_id';
+        } elseif ( is_string( $id_or_email ) ) {
+                if ( strpos( $id_or_email, '@md5.gravatar.com' ) ) {
+                        // md5 hash
+                        list( $email_hash ) = explode( '@', $id_or_email );
+                        $context = 'email-md5-gravatar';
+                } else {
+                        // email address
+                        $email = $id_or_email;
+                        $context = 'email';
+                }
+        } elseif ( $id_or_email instanceof WP_User ) {
+                // User Object
+                $user = $id_or_email;
+                $context = 'user';
+        } elseif ( $id_or_email instanceof WP_Post ) {
+                // Post Object
+                $user = get_user_by( 'id', (int) $id_or_email->post_author );
+                $context = 'post';
+        } elseif ( $id_or_email instanceof WP_Comment ) {
+                if ( is_object( $id_or_email ) && isset( $id_or_email->comment_ID ) ) {
+                        $id_or_email = get_comment( $id_or_email );
+                }
+
+                /**
+                 * Filters the list of allowed comment types for retrieving avatars.
+                 *
+                 * @since 3.0.0
+                 *
+                 * @param array $types An array of content types. Default only contains 'comment'.
+                 */
+                $allowed_comment_types = apply_filters( 'get_avatar_comment_types', array( 'comment' ) );
+
+                if ( ! empty( $id_or_email->comment_type ) && ! in_array( $id_or_email->comment_type, (array) $allowed_comment_types ) ) {
+                        return array( 
+                                'user_id'    => 0,
+                                'email'      => '',
+                                'email_hash' => '',
+                                'context'    => 'comment-disallowed-type',
+                        );
+                }
+
+                if ( ! empty( $id_or_email->user_id ) ) {                        
+                        $user = get_user_by( 'id', (int) $id_or_email->user_id );
+                }
+                
+                if ( ( ! $user || is_wp_error( $user ) ) && ! empty( $id_or_email->comment_author_email ) ) {
+                        $email = $id_or_email->comment_author_email;
+                }        
+
+                $context = 'comment-allowed-type';
+        }
+
+        if ( empty( $email_hash ) ) {
+                if ( $user instanceof WP_User ) {
+                        $email = $user->user_email;
+                }
+                
+                if ( ! empty( $email ) ) {
+                        $email_hash = md5( strtolower( trim( $email ) ) );
+                }        
+        }
+        
+        return array( 
+                'user_id'    => ( $user instanceof WP_User ) ? $user->ID : 0,
+                'email'      => $email,
+                'email_hash' => $email_hash,
+                'context'    => $context,
+        );
+}
+
+
+
+/**
  * Retrieves the URL of a file in the theme.
  *
  * Searches in the stylesheet directory before the template directory so themes

tests/phpunit/tests/avatar.php

@@ -229 +229 @@
                 return $this->fakeURL;
         }
 
+        /**
+         * @ticket 41544
+         * @dataProvider data_test_wp_parse_id_or_email
+         */
+        public function test_wp_parse_id_or_email( $id_or_email, $expected ) {
+                $this->assertSame( $expected,  wp_parse_id_or_email( $id_or_email ) );
+        }
+
+        public function data_test_wp_parse_id_or_email() {
+                // Create a user
+                $user = self::factory()->user->create_and_get( array( 
+                        'user_email' => 'user_for_testing_wp_parse_id_or_email@example.org',
+                ) );
+                $user_id = $user->ID;
+                $email = $user->user_email;
+                $email_hash = md5( strtolower( trim( $email ) ) );
+
+                // Create a post
+                $post_id = self::factory()->post->create( array( 'post_author' => 1 ) );
+
+                // Create a comment with allowed type
+                $comment_id = self::factory()->comment->create( array( 
+                        'comment_post_ID' => $post_id,
+                        'user_id' => $user_id
+                ) );
+                $comment_with_allowed_type = get_comment( $comment_id );
+
+                // Create a comment with disllowed type
+                $comment_id = self::factory()->comment->create( array( 
+                        'comment_post_ID' => $post_id,
+                        'user_id'         => $user_id,
+                        'comment_type'    => 'pingback',
+                ) );
+                $comment_with_disallowed_type = get_comment( $comment_id );
+                
+                return array(
+                        'Null' => array(
+                                'id_or_email' => null,
+                                'expected' => array( 
+                                        'user_id'     => 0,
+                                        'email'       => '',
+                                        'email_hash'  => '',
+                                        'context'     => '',
+                                )
+                        ),
+                        'Empty email address' => array(
+                                'id_or_email' => '',
+                                'expected' => array( 
+                                        'user_id'     => 0,
+                                        'email'       => '',
+                                        'email_hash'  => '',
+                                        'context'     => 'email',
+                                )
+                        ),
+                        'Email address' => array(
+                                'id_or_email' => $email,
+                                'expected' => array( 
+                                        'user_id'     => 0,
+                                        'email'       => $email,
+                                        'email_hash'  => $email_hash,
+                                        'context'     => 'email',
+                                )
+                        ),
+                        'md5 gravatar email address' => array(
+                                'id_or_email' =>  $email_hash . '@md5.gravatar.com',
+                                'expected' => array( 
+                                        'user_id'     => 0,
+                                        'email'       => '',
+                                        'email_hash'  => $email_hash,
+                                        'context'     => 'email-md5-gravatar',
+                                )
+                        ),
+                        'User ID' => array(
+                                'id_or_email' => $user_id,
+                                'expected' => array( 
+                                        'user_id'     => $user_id,
+                                        'email'       => $email,
+                                        'email_hash'  => $email_hash,
+                                        'context'     => 'user_id',
+                                )
+                        ),
+                        'Non-existing user ID' => array(
+                                'id_or_email' => 0,
+                                'expected' => array( 
+                                        'user_id'     => 0,
+                                        'email'       => '',
+                                        'email_hash'  => '',
+                                        'context'     => 'user_id',
+                                )
+                        ),
+                        'Post object' => array(
+                                'id_or_email' => 0,
+                                'expected' => array( 
+                                        'user_id'     => 0,
+                                        'email'       => '',
+                                        'email_hash'  => '',
+                                        'context'     => 'user_id',
+                                )
+                        ),
+                        'User object' => array(
+                                'id_or_email' => $user,
+                                'expected' => array( 
+                                        'user_id'     => $user_id,
+                                        'email'       => $email,
+                                        'email_hash'  => $email_hash,
+                                        'context'     => 'user',
+                                )
+                        ),
+                        'Comment with allowed type' => array(
+                                'id_or_email' => $comment_with_allowed_type,
+                                'expected' => array( 
+                                        'user_id'     => $user_id,
+                                        'email'       => $email,
+                                        'email_hash'  => $email_hash,
+                                        'context'     => 'comment-allowed-type',
+                                )
+                        ),
+                        'Comment with disallowed type' => array(
+                                'id_or_email' => $comment_with_disallowed_type,
+                                'expected' => array( 
+                                        'user_id'     => 0,
+                                        'email'       => '',
+                                        'email_hash'  => '',
+                                        'context'     => 'comment-disallowed-type',
+                                )
+                        ),
+                );
+        }
 }