GIFHandler.php

Go to the documentation of this file.

<?php
class GIFHandler extends BitmapHandler {
    const BROKEN_FILE = '0'; // value to store in img_metadata if error extracting metadata.

    public function getMetadata( $image, $filename ) {
        try {
            $parsedGIFMetadata = BitmapMetadataHandler::GIF( $filename );
        } catch ( Exception $e ) {
            // Broken file?
            wfDebug( __METHOD__ . ': ' . $e->getMessage() . "\n" );

            return self::BROKEN_FILE;
        }

        return serialize( $parsedGIFMetadata );
    }

    public function formatMetadata( $image, $context = false ) {
        $meta = $this->getCommonMetaArray( $image );
        if ( count( $meta ) === 0 ) {
            return false;
        }

        return $this->formatMetadataHelper( $meta, $context );
    }

    public function getCommonMetaArray( File $image ) {
        $meta = $image->getMetadata();

        if ( !$meta ) {
            return [];
        }
        $meta = unserialize( $meta );
        if ( !isset( $meta['metadata'] ) ) {
            return [];
        }
        unset( $meta['metadata']['_MW_GIF_VERSION'] );

        return $meta['metadata'];
    }

    function getImageArea( $image ) {
        $ser = $image->getMetadata();
        if ( $ser ) {
            $metadata = unserialize( $ser );
            if ( isset( $metadata['frameCount'] ) && $metadata['frameCount'] > 0 ) {
                return $image->getWidth() * $image->getHeight() * $metadata['frameCount'];
            } else {
                return $image->getWidth() * $image->getHeight();
            }
        } else {
            return $image->getWidth() * $image->getHeight();
        }
    }

    function isAnimatedImage( $image ) {
        $ser = $image->getMetadata();
        if ( $ser ) {
            $metadata = unserialize( $ser );
            if ( isset( $metadata['frameCount'] ) && $metadata['frameCount'] > 1 ) {
                return true;
            }
        }

        return false;
    }

    function canAnimateThumbnail( $file ) {
        global $wgMaxAnimatedGifArea;
        $answer = $this->getImageArea( $file ) <= $wgMaxAnimatedGifArea;

        return $answer;
    }

    function getMetadataType( $image ) {
        return 'parsed-gif';
    }

    public function isMetadataValid( $image, $metadata ) {
        if ( $metadata === self::BROKEN_FILE ) {
            // Do not repetitivly regenerate metadata on broken file.
            return self::METADATA_GOOD;
        }

        Wikimedia\suppressWarnings();
        $data = unserialize( $metadata );
        Wikimedia\restoreWarnings();

        if ( !$data || !is_array( $data ) ) {
            wfDebug( __METHOD__ . " invalid GIF metadata\n" );

            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\n" );

            return self::METADATA_COMPATIBLE;
        }

        return self::METADATA_GOOD;
    }

    public function getLongDesc( $image ) {
        global $wgLang;

        $original = parent::getLongDesc( $image );

        Wikimedia\suppressWarnings();
        $metadata = unserialize( $image->getMetadata() );
        Wikimedia\restoreWarnings();

        if ( !$metadata || $metadata['frameCount'] <= 1 ) {
            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[] = $wgLang->formatTimePeriod( $metadata['duration'] );
        }

        return $wgLang->commaList( $info );
    }

    public function getLength( $file ) {
        $serMeta = $file->getMetadata();
        Wikimedia\suppressWarnings();
        $metadata = unserialize( $serMeta );
        Wikimedia\restoreWarnings();

        if ( !$metadata || !isset( $metadata['duration'] ) || !$metadata['duration'] ) {
            return 0.0;
        } else {
            return (float)$metadata['duration'];
        }
    }
}