GIFHandler.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Media;
 
use Exception;
use MediaWiki\Context\IContextSource;
use MediaWiki\FileRepo\File\File;
use MediaWiki\MainConfigNames;
use MediaWiki\MediaWikiServices;
use Wikimedia\RequestTimeout\TimeoutException;
 
class GIFHandler extends BitmapHandler {
    private const BROKEN_FILE = '0';
 
    public function getSizeAndMetadata( $state, $filename ) {
        try {
            $parsedGIFMetadata = BitmapMetadataHandler::GIF( $filename );
        } catch ( TimeoutException $e ) {
            throw $e;
        } catch ( Exception $e ) {
            // Broken file?
            wfDebug( __METHOD__ . ': ' . $e->getMessage() );
 
            return [ 'metadata' => [ '_error' => self::BROKEN_FILE ] ];
        }
 
        return [
            'width' => $parsedGIFMetadata['width'],
            'height' => $parsedGIFMetadata['height'],
            'bits' => $parsedGIFMetadata['bits'],
            'metadata' => array_diff_key(
                $parsedGIFMetadata,
                [ 'width' => true, 'height' => true, 'bits' => true ]
            )
        ];
    }
 
    public function formatMetadata( $image, $context = false ) {
        $meta = $this->getCommonMetaArray( $image );
        if ( !$meta ) {
            return false;
        }
 
        return $this->formatMetadataHelper( $meta, $context );
    }
 
    public function getCommonMetaArray( File $image ) {
        $meta = $image->getMetadataArray();
        if ( !isset( $meta['metadata'] ) ) {
            return [];
        }
        unset( $meta['metadata']['_MW_GIF_VERSION'] );
 
        return $meta['metadata'];
    }
 
    public function getImageArea( $image ) {
        $metadata = $image->getMetadataArray();
        if ( isset( $metadata['frameCount'] ) && $metadata['frameCount'] > 0 ) {
            return $image->getWidth() * $image->getHeight() * $metadata['frameCount'];
        }
        return $image->getWidth() * $image->getHeight();
    }
 
    public function isAnimatedImage( $image ) {
        $metadata = $image->getMetadataArray();
        if ( isset( $metadata['frameCount'] ) && $metadata['frameCount'] > 1 ) {
            return true;
        }
 
        return false;
    }
 
    public function canAnimateThumbnail( $file ) {
        $maxAnimatedGifArea = MediaWikiServices::getInstance()->getMainConfig()
            ->get( MainConfigNames::MaxAnimatedGifArea );
 
        return $this->getImageArea( $file ) <= $maxAnimatedGifArea;
    }
 
    public function getMetadataType( $image ) {
        return 'parsed-gif';
    }
 
    public function isFileMetadataValid( $image ) {
        $data = $image->getMetadataArray();
        if ( $data === [ '_error' => self::BROKEN_FILE ] ) {
            // Do not repetitively regenerate metadata on broken file.
            return self::METADATA_GOOD;
        }
 
        if ( !$data || isset( $data['_error'] ) ) {
            wfDebug( __METHOD__ . " invalid GIF metadata" );
 
            return self::METADATA_BAD;
        }
 
        if ( !isset( $data['metadata']['_MW_GIF_VERSION'] )
            || $data['metadata']['_MW_GIF_VERSION'] !== GIFMetadataExtractor::VERSION
        ) {
            wfDebug( __METHOD__ . " old but compatible GIF metadata" );
 
            return self::METADATA_COMPATIBLE;
        }
 
        return self::METADATA_GOOD;
    }
 
    public function getLongDesc( $image ) {
        global $wgLang;
 
        $original = parent::getLongDesc( $image );
 
        $metadata = $image->getMetadataArray();
 
        if ( !$metadata || isset( $metadata['_error'] ) || $metadata['frameCount'] <= 0 ) {
            return $original;
        }
 
        /* Preserve original image info string, but strip the last char ')' so we can add even more */
        $info = [];
        $info[] = $original;
 
        if ( $metadata['looped'] ) {
            $info[] = wfMessage( 'file-info-gif-looped' )->parse();
        }
 
        if ( $metadata['frameCount'] > 1 ) {
            $info[] = wfMessage( 'file-info-gif-frames' )->numParams( $metadata['frameCount'] )->parse();
        }
 
        if ( $metadata['duration'] ) {
            $info[] = htmlspecialchars( $wgLang->formatTimePeriod( $metadata['duration'] ), ENT_QUOTES );
        }
 
        return $wgLang->commaList( $info );
    }
 
    public function getLength( $file ) {
        $metadata = $file->getMetadataArray();
 
        if ( !$metadata || !isset( $metadata['duration'] ) || !$metadata['duration'] ) {
            return 0.0;
        }
        return (float)$metadata['duration'];
    }
}
 
class_alias( GIFHandler::class, 'GIFHandler' );