ExifRotationTest.php

Go to the documentation of this file.

<?php
class ExifRotationTest extends MediaWikiMediaTestCase {

    protected function setUp() {
        parent::setUp();
        $this->checkPHPExtension( 'exif' );

        $this->handler = new BitmapHandler();

        $this->setMwGlobals( array(
            'wgShowEXIF' => true,
            'wgEnableAutoRotation' => true,
        ) );
    }

    protected function createsThumbnails() {
        return true;
    }

    public function testMetadata( $name, $type, $info ) {
        if ( !$this->handler->canRotate() ) {
            $this->markTestSkipped( "This test needs a rasterizer that can auto-rotate." );
        }
        $file = $this->dataFile( $name, $type );
        $this->assertEquals( $info['width'], $file->getWidth(), "$name: width check" );
        $this->assertEquals( $info['height'], $file->getHeight(), "$name: height check" );
    }

    public function testMetadataAutoRotate( $name, $type, $info ) {
        $this->setMwGlobals( 'wgEnableAutoRotation', null );
        $this->setMwGlobals( 'wgUseImageMagick', true );
        $this->setMwGlobals( 'wgUseImageResize', true );

        $file = $this->dataFile( $name, $type );
        $this->assertEquals( $info['width'], $file->getWidth(), "$name: width check" );
        $this->assertEquals( $info['height'], $file->getHeight(), "$name: height check" );
    }

    public function testRotationRendering( $name, $type, $info, $thumbs ) {
        if ( !$this->handler->canRotate() ) {
            $this->markTestSkipped( "This test needs a rasterizer that can auto-rotate." );
        }
        foreach ( $thumbs as $size => $out ) {
            if ( preg_match( '/^(\d+)px$/', $size, $matches ) ) {
                $params = array(
                    'width' => $matches[1],
                );
            } elseif ( preg_match( '/^(\d+)x(\d+)px$/', $size, $matches ) ) {
                $params = array(
                    'width' => $matches[1],
                    'height' => $matches[2]
                );
            } else {
                throw new MWException( 'bogus test data format ' . $size );
            }

            $file = $this->dataFile( $name, $type );
            $thumb = $file->transform( $params, File::RENDER_NOW | File::RENDER_FORCE );

            $this->assertEquals(
                $out[0],
                $thumb->getWidth(),
                "$name: thumb reported width check for $size"
            );
            $this->assertEquals(
                $out[1],
                $thumb->getHeight(),
                "$name: thumb reported height check for $size"
            );

            $gis = getimagesize( $thumb->getLocalCopyPath() );
            if ( $out[0] > $info['width'] ) {
                // Physical image won't be scaled bigger than the original.
                $this->assertEquals( $info['width'], $gis[0], "$name: thumb actual width check for $size" );
                $this->assertEquals( $info['height'], $gis[1], "$name: thumb actual height check for $size" );
            } else {
                $this->assertEquals( $out[0], $gis[0], "$name: thumb actual width check for $size" );
                $this->assertEquals( $out[1], $gis[1], "$name: thumb actual height check for $size" );
            }
        }
    }

    public static function provideFiles() {
        return array(
            array(
                'landscape-plain.jpg',
                'image/jpeg',
                array(
                    'width' => 1024,
                    'height' => 768,
                ),
                array(
                    '800x600px' => array( 800, 600 ),
                    '9999x800px' => array( 1067, 800 ),
                    '800px' => array( 800, 600 ),
                    '600px' => array( 600, 450 ),
                )
            ),
            array(
                'portrait-rotated.jpg',
                'image/jpeg',
                array(
                    'width' => 768, // as rotated
                    'height' => 1024, // as rotated
                ),
                array(
                    '800x600px' => array( 450, 600 ),
                    '9999x800px' => array( 600, 800 ),
                    '800px' => array( 800, 1067 ),
                    '600px' => array( 600, 800 ),
                )
            )
        );
    }

    public function testMetadataNoAutoRotate( $name, $type, $info ) {
        $this->setMwGlobals( 'wgEnableAutoRotation', false );

        $file = $this->dataFile( $name, $type );
        $this->assertEquals( $info['width'], $file->getWidth(), "$name: width check" );
        $this->assertEquals( $info['height'], $file->getHeight(), "$name: height check" );
    }

    public function testMetadataAutoRotateUnsupported( $name, $type, $info ) {
        $this->setMwGlobals( 'wgEnableAutoRotation', null );
        $this->setMwGlobals( 'wgUseImageResize', false );

        $file = $this->dataFile( $name, $type );
        $this->assertEquals( $info['width'], $file->getWidth(), "$name: width check" );
        $this->assertEquals( $info['height'], $file->getHeight(), "$name: height check" );
    }

    public function testRotationRenderingNoAutoRotate( $name, $type, $info, $thumbs ) {
        $this->setMwGlobals( 'wgEnableAutoRotation', false );

        foreach ( $thumbs as $size => $out ) {
            if ( preg_match( '/^(\d+)px$/', $size, $matches ) ) {
                $params = array(
                    'width' => $matches[1],
                );
            } elseif ( preg_match( '/^(\d+)x(\d+)px$/', $size, $matches ) ) {
                $params = array(
                    'width' => $matches[1],
                    'height' => $matches[2]
                );
            } else {
                throw new MWException( 'bogus test data format ' . $size );
            }

            $file = $this->dataFile( $name, $type );
            $thumb = $file->transform( $params, File::RENDER_NOW | File::RENDER_FORCE );

            $this->assertEquals(
                $out[0],
                $thumb->getWidth(),
                "$name: thumb reported width check for $size"
            );
            $this->assertEquals(
                $out[1],
                $thumb->getHeight(),
                "$name: thumb reported height check for $size"
            );

            $gis = getimagesize( $thumb->getLocalCopyPath() );
            if ( $out[0] > $info['width'] ) {
                // Physical image won't be scaled bigger than the original.
                $this->assertEquals( $info['width'], $gis[0], "$name: thumb actual width check for $size" );
                $this->assertEquals( $info['height'], $gis[1], "$name: thumb actual height check for $size" );
            } else {
                $this->assertEquals( $out[0], $gis[0], "$name: thumb actual width check for $size" );
                $this->assertEquals( $out[1], $gis[1], "$name: thumb actual height check for $size" );
            }
        }
    }

    public static function provideFilesNoAutoRotate() {
        return array(
            array(
                'landscape-plain.jpg',
                'image/jpeg',
                array(
                    'width' => 1024,
                    'height' => 768,
                ),
                array(
                    '800x600px' => array( 800, 600 ),
                    '9999x800px' => array( 1067, 800 ),
                    '800px' => array( 800, 600 ),
                    '600px' => array( 600, 450 ),
                )
            ),
            array(
                'portrait-rotated.jpg',
                'image/jpeg',
                array(
                    'width' => 1024, // since not rotated
                    'height' => 768, // since not rotated
                ),
                array(
                    '800x600px' => array( 800, 600 ),
                    '9999x800px' => array( 1067, 800 ),
                    '800px' => array( 800, 600 ),
                    '600px' => array( 600, 450 ),
                )
            )
        );
    }

    const TEST_WIDTH = 100;
    const TEST_HEIGHT = 200;

    public function testBitmapExtractPreRotationDimensions( $rotation, $expected ) {
        $result = $this->handler->extractPreRotationDimensions( array(
            'physicalWidth' => self::TEST_WIDTH,
            'physicalHeight' => self::TEST_HEIGHT,
        ), $rotation );
        $this->assertEquals( $expected, $result );
    }

    public static function provideBitmapExtractPreRotationDimensions() {
        return array(
            array(
                0,
                array( self::TEST_WIDTH, self::TEST_HEIGHT )
            ),
            array(
                90,
                array( self::TEST_HEIGHT, self::TEST_WIDTH )
            ),
            array(
                180,
                array( self::TEST_WIDTH, self::TEST_HEIGHT )
            ),
            array(
                270,
                array( self::TEST_HEIGHT, self::TEST_WIDTH )
            ),
        );
    }
}