<?php
/**
 * GNU social - a federating social network
 *
 * Plugin to handle more kinds of image formats thanks to ImageMagick
 *
 * PHP version 5
 *
 * LICENCE: This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * @category  Plugin
 * @package   GNUsocial
 * @author    Mikael Nordfeldth <mmn@hethane.se>
 * @copyright 2014 Free Software Foundation http://fsf.org
 * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
 * @link      https://www.gnu.org/software/social/
 */

if (!defined('GNUSOCIAL')) { exit(1); }

/*
 * Dependencies:
 *  php5-imagick
 *
 * Provides:
 *  Animated GIF resize support
 *
 * Comments:
 *  Animated GIF resize requires setting $config['thumbnail']['animated'] = true;
 *
 * Bugs:
 *  Not even ImageMagick is very good at resizing animated GIFs.
 *  We are not infinitely fast, so resizing animated GIFs is _not_ recommended.
 */

class ImageMagickPlugin extends Plugin
{
    const PLUGIN_VERSION = '2.0.0';

    public $preview_imageformat = 'PNG';    // Image format strings: http://www.imagemagick.org/script/formats.php#supported
    public $rasterize_vectors = false;       // Whether we want to turn SVG into PNG etc.

    /**
     * @param ImageFile $file An ImageFile object we're getting metadata for
     * @param array $info The response from getimagesize()
     */
    public function onFillImageFileMetadata(ImageFile $imagefile) {
        if (is_null($imagefile->animated) && $imagefile->mimetype === 'image/gif') {
            $magick = new Imagick($imagefile->filepath);
            $magick = $magick->coalesceImages();
            $imagefile->animated = $magick->getNumberImages()>1;
        }

        return true;
    }

    public function onStartResizeImageFile(ImageFile $imagefile, $outpath, array $box)
    {
        switch ($imagefile->mimetype) {
        case 'image/gif':
            // If GIF, then only for animated gifs! (and only if we really want to resize the animation!)
            if ($imagefile->animated && common_config('thumbnail', 'animated')) {
                return $this->resizeImageFileAnimatedGif($imagefile, $outpath, $box);
            }
            break;
        }
        return true;
    }

    protected function resizeImageFileAnimatedGif(ImageFile $imagefile, $outpath, array $box)
    {
        $magick = new Imagick($imagefile->filepath);
        $magick = $magick->coalesceImages();
        $magick->setIteratorIndex(0);
        do {
            $magick->cropImage($box['w'], $box['h'], $box['x'], $box['y']);
            $magick->thumbnailImage($box['width'], $box['height']);
            $magick->setImagePage($box['width'], $box['height'], 0, 0);
        } while ($magick->nextImage());
        $magick = $magick->deconstructImages();

        // $magick->writeImages($outpath, true); did not work, had to use filehandle
        // There's been bugs for writeImages in php5-imagick before, probably now too
        $fh = fopen($outpath, 'w+');
        $success = $magick->writeImagesFile($fh);
        fclose($fh);
        $magick->destroy();

        return !$success;
    }

    public function onCreateFileImageThumbnailSource(File $file, &$imgPath, $media=null)
    {
        switch ($file->mimetype) {
        case 'image/svg+xml':
            if (!$this->rasterize_vectors) {
                // ImageMagick seems to be hard to trick into scaling vector graphics...
                return true;
            }
            break;
        default:
            // If we don't know the format, let's try not to mess with anything.
            return true;
        }

        $imgPath = tempnam(sys_get_temp_dir(), 'socialthumb-');
        if (!$this->createImagePreview($file, $imgPath)) {
            common_debug('Could not create ImageMagick preview of File id=='.$file->id);
            @unlink($imgPath);
            $imgPath = null;
            return true;
        }
        return false;
    }

    protected function createImagePreview(File $file, $outpath)
    {
        $magick = new Imagick($file->getPath());
        $magick->setImageFormat($this->preview_imageformat);
        $magick->writeImage($outpath);
        $magick->destroy();

        return getimagesize($outpath);  // Verify that we wrote an understandable image.
    }

    public function onPluginVersion(array &$versions): bool
    {
        $versions[] = array('name' => 'ImageMagick',
                            'version' => self::PLUGIN_VERSION,
                            'author' => 'Mikael Nordfeldth',
                            'homepage' => GNUSOCIAL_ENGINE_URL,
                            'rawdescription' =>
                            // TRANS: Plugin description.
                            _m('Use ImageMagick for some more image support.'));
        return true;
    }
}