Changeset 10178

Timestamp:

10/03/2015 10:42:02 PM (9 years ago)

Author:

imath

Message:

Make sure uploaded images are oriented the right way.

When using a mobile device to set an avatar or a cover image, there are cases when the image can be saved upside down. We need to check the exif Orientation of uploaded images and rotate them if needed.

Introduce 2 new methods into the BP_Attachment class:

• BP_Attachment->get_image_data() to get an array of all image datas (including exif datas)
• BP_Attachment->edit_image() to edit the image orientation and/or resize the image.

Use these two new methods within the BP_Attachment_Avatar->shrink() and BP_Attachment_Cover_Image()->fit() methods.

Finally include a unit test for the BP_Attachment->get_image_data() method to check we get the orientation meta for all supported WorPress versions.

Props modemlooper, shanebp, r-a-y, DJPaul

Fixes #5089
See #6570

Location:

trunk

Files:

• src/bp-core/classes/class-bp-attachment-avatar.php (modified) (2 diffs)
• src/bp-core/classes/class-bp-attachment-cover-image.php (modified) (1 diff)
• src/bp-core/classes/class-bp-attachment.php (modified) (1 diff)
• tests/phpunit/testcases/core/class-bp-attachment.php (modified) (1 diff)

trunk/src/bp-core/classes/class-bp-attachment-avatar.php

@@ -120 +120 @@
      *
      * @uses  bp_core_avatar_original_max_width()
-     * @uses  wp_get_image_editor()
      *
      * @param string $file the absolute path to the file.
@@ -128 +127 @@
     public static function shrink( $file = '' ) {
         // Get image size
-        $size   = @getimagesize( $file );
-        $retval = false;
-
-        // Check image size and shrink if too large
-        if ( $size[0] > bp_core_avatar_original_max_width() ) {
-            $editor = wp_get_image_editor( $file );
-
-            if ( ! is_wp_error( $editor ) ) {
-                $editor->set_quality( 100 );
-
-                $resized = $editor->resize( bp_core_avatar_original_max_width(), bp_core_avatar_original_max_width(), false );
-                if ( ! is_wp_error( $resized ) ) {
-                    $thumb = $editor->save( $editor->generate_filename() );
-                } else {
-                    $retval = $resized;
-                }
-
-                // Check for thumbnail creation errors
-                if ( ( false === $retval ) && is_wp_error( $thumb ) ) {
-                    $retval = $thumb;
-                }
-
-                // Thumbnail is good so proceed
-                if ( false === $retval ) {
-                    $retval = $thumb;
-                }
-
-            } else {
-                $retval = $editor;
-            }
-        }
-
-        return $retval;
+        $avatar_data = parent::get_image_data( $file );
+
+        // Init the edit args
+        $edit_args = array();
+
+        // Do we need to resize the image ?
+        if ( isset( $avatar_data['width'] ) && $avatar_data['width'] > bp_core_avatar_original_max_width() ) {
+            $edit_args = array(
+                'max_w' => bp_core_avatar_original_max_width(),
+                'max_h' => bp_core_avatar_original_max_width(),
+            );
+        }
+
+        // Do we need to rotate the image ?
+        $angles = array(
+            3 => 180,
+            6 => -90,
+            8 =>  90,
+        );
+
+        if ( isset( $avatar_data['meta']['orientation'] ) && isset( $angles[ $avatar_data['meta']['orientation'] ] ) ) {
+            $edit_args['rotate'] = $angles[ $avatar_data['meta']['orientation'] ];
+        }
+
+        // No need to edit the avatar, original file will be used
+        if ( empty( $edit_args ) ) {
+            return false;
+
+        // Add the file to the edit arguments
+        } else {
+            $edit_args['file'] = $file;
+        }
+
+        return parent::edit_image( 'avatar', $edit_args );
     }
 

trunk/src/bp-core/classes/class-bp-attachment-cover-image.php

@@ -139 +139 @@
 
         // Get image size
-        $size   = @getimagesize( $file );
-        $retval = false;
-
-        // Check image size and shrink if too large
-        if ( $size[0] > $dimensions['width'] || $size[1] > $dimensions['height'] ) {
-            $editor = wp_get_image_editor( $file );
-
-            if ( ! is_wp_error( $editor ) ) {
-                $editor->set_quality( 100 );
-
-                $resized = $editor->resize( $dimensions['width'], $dimensions['height'], true );
-                if ( ! is_wp_error( $resized ) ) {
-                    $cover   = $editor->save( $this->generate_filename( $file ) );
-                } else {
-                    $retval = $resized;
-                }
-
-                // Check for cover creation errors
-                if ( ( false === $retval ) && is_wp_error( $cover ) ) {
-                    $retval = $cover;
-                }
-
-                // Cover is good so proceed
-                if ( false === $retval ) {
-                    $retval = $cover;
-                }
-
-            } else {
-                $retval = $editor;
-            }
-        }
-
-        return $retval;
+        $cover_data = parent::get_image_data( $file );
+
+        // Init the edit args
+        $edit_args = array();
+
+        // Do we need to resize the image ?
+        if ( ( isset( $cover_data['width'] ) && $cover_data['width'] > $dimensions['width'] ) ||
+        ( isset( $cover_data['height'] ) && $cover_data['height'] > $dimensions['height'] ) ) {
+            $edit_args = array(
+                'max_w' => $dimensions['width'],
+                'max_h' => $dimensions['height'],
+                'crop'  => true,
+            );
+        }
+
+        // Do we need to rotate the image ?
+        $angles = array(
+            3 => 180,
+            6 => -90,
+            8 =>  90,
+        );
+
+        if ( isset( $cover_data['meta']['orientation'] ) && isset( $angles[ $cover_data['meta']['orientation'] ] ) ) {
+            $edit_args['rotate'] = $angles[ $cover_data['meta']['orientation'] ];
+        }
+
+        // No need to edit the avatar, original file will be used
+        if ( empty( $edit_args ) ) {
+            return false;
+
+        // Add the file to the edit arguments
+        } else {
+            $edit_args = array_merge( $edit_args, array( 'file' => $file, 'save' => false ) );
+        }
+
+        // Get the editor so that we can use a specific save method
+        $editor = parent::edit_image( 'cover_image', $edit_args );
+
+        if ( is_wp_error( $editor ) )  {
+            return $editor;
+        } elseif ( ! is_a( $editor, 'WP_Image_Editor' ) ) {
+            return false;
+        }
+
+        // Save the new image file
+        return $editor->save( $this->generate_filename( $file ) );
     }
 

trunk/src/bp-core/classes/class-bp-attachment.php

@@ -522 +522 @@
         return $script_data;
     }
+
+    /**
+     * Get full data for an image
+     *
+     * @since  2.4.0
+     *
+     * @param  string $file Absolute path to the uploaded image.
+     * @return bool|array   An associate array containing the width, height and metadatas.
+     *                      False in case an important image attribute is missing.
+     */
+    public static function get_image_data( $file ) {
+        // Try to get image basic data
+        list( $width, $height, $sourceImageType ) = @getimagesize( $file );
+
+        // No need to carry on if we couldn't get image's basic data.
+        if ( is_null( $width ) || is_null( $height ) || is_null( $sourceImageType ) ) {
+            return false;
+        }
+
+        // Initialize the image data
+        $image_data = array(
+            'width'  => $width,
+            'height' => $height,
+        );
+
+        /**
+         * Make sure the wp_read_image_metadata function is reachable for the old Avatar UI
+         * or if WordPress < 3.9 (New Avatar UI is not available in this case)
+         */
+        if ( ! function_exists( 'wp_read_image_metadata' ) ) {
+            require_once( ABSPATH . 'wp-admin/includes/image.php' );
+        }
+
+        // Now try to get image's meta data
+        $meta = wp_read_image_metadata( $file );
+
+        if ( ! empty( $meta ) ) {
+            // Before 4.0 the Orientation wasn't included
+            if ( ! isset( $meta['orientation'] ) &&
+                is_callable( 'exif_read_data' ) &&
+                in_array( $sourceImageType, apply_filters( 'wp_read_image_metadata_types', array( IMAGETYPE_JPEG, IMAGETYPE_TIFF_II, IMAGETYPE_TIFF_MM ) ) )
+            ) {
+                $exif = exif_read_data( $file );
+
+                if ( ! empty( $exif['Orientation'] ) ) {
+                    $meta['orientation'] = $exif['Orientation'];
+                }
+            }
+
+            // Now add the metas to image data
+            $image_data['meta'] = $meta;
+        }
+
+        /**
+         * Filter here to add/remove/edit data to the image full data
+         *
+         * @since  2.4.0
+         *
+         * @param  array $image_data An associate array containing the width, height and metadatas.
+         */
+        return apply_filters( 'bp_attachments_get_image_data', $image_data );
+    }
+
+    /**
+     * Edit an image file to resize it or rotate it
+     *
+     * @since  2.4.0
+     *
+     * @param  string $attachment_type The attachment type (eg: avatar or cover_image). Required.
+     * @param  array  array $args {
+     *     @type string $file     Absolute path to the image file (required).
+     *     @type int    $max_w    Max width attribute for the editor's resize method (optional).
+     *     @type int    $max_h    Max height attribute for the editor's resize method (optional).
+     *     @type bool   $crop     Crop attribute for the editor's resize method (optional).
+     *     @type float  $rotate   Angle for the editor's rotate method (optional).
+     *     @type int    $quality  Compression quality on a 1-100% scale (optional).
+     *     @type bool   $save     Whether to use the editor's save method or not (optional).
+     * }
+     *
+     * @return string|WP_Image_Editor|WP_Error The edited image path or the WP_Image_Editor object in case of success,
+     *                                         an WP_Error object otherwise.
+     */
+    public static function edit_image( $attachment_type, $args = array() ) {
+        if ( empty( $attachment_type ) ) {
+            return new WP_Error( 'missing_parameter' );
+        }
+
+        $r = bp_parse_args( $args, array(
+            'file'   => '',
+            'max_w'   => 0,
+            'max_h'   => 0,
+            'crop'    => false,
+            'rotate'  => 0,
+            'quality' => 90,
+            'save'    => true,
+        ), 'attachment_' . $attachment_type . '_edit_image' );
+
+        // Make sure we have to edit the image.
+        if ( empty( $r['max_w'] ) && empty( $r['max_h'] ) && empty( $r['rotate'] ) && empty( $r['file'] ) ) {
+            return new WP_Error( 'missing_parameter' );
+        }
+
+        // Get the image editor
+        $editor = wp_get_image_editor( $r['file'] );
+
+        if ( is_wp_error( $editor ) ) {
+            return $editor;
+        }
+
+        $editor->set_quality( $r['quality'] );
+
+        if ( ! empty( $r['rotate'] ) ) {
+            $rotated = $editor->rotate( $r['rotate'] );
+
+            // Stop in case of error
+            if ( is_wp_error( $rotated ) ) {
+                return $rotated;
+            }
+        }
+
+        if ( ! empty( $r['max_w'] ) || ! empty( $r['max_h'] ) ) {
+            $resized = $editor->resize( $r['max_w'], $r['max_h'], $r['crop'] );
+
+            // Stop in case of error
+            if ( is_wp_error( $resized ) ) {
+                return $resized;
+            }
+        }
+
+        // Use the editor save method to get a path to the edited image
+        if ( true === $r['save'] ) {
+            return $editor->save( $editor->generate_filename() );
+
+        // Need to do some other edit actions or use a specific method to save file
+        } else {
+            return $editor;
+        }
+    }
 }

trunk/tests/phpunit/testcases/core/class-bp-attachment.php

@@ -444 +444 @@
         $this->clean_files( 'buddypress' );
     }
+
+    /**
+     * @group avatars
+     * @group cover_images
+     */
+    public function test_bp_attachment_get_image_data() {
+        $image_data = BP_Attachment::get_image_data( BP_TESTS_DIR . 'assets/upside-down.jpg' );
+
+        $this->assertTrue( 3 === $image_data['meta']['orientation'] );
+    }
 }