plugins/ImageMagick/ImageMagickPlugin.php

   1 <?php
   2 /**
   3  * GNU social - a federating social network
   4  *
   5  * Plugin to handle more kinds of image formats thanks to ImageMagick
   6  *
   7  * PHP version 5
   8  *
   9  * LICENCE: This program is free software: you can redistribute it and/or modify
  10  * it under the terms of the GNU Affero General Public License as published by
  11  * the Free Software Foundation, either version 3 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU Affero General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Affero General Public License
  20  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  21  *
  22  * @category  Plugin
  23  * @package   GNUsocial
  24  * @author    Mikael Nordfeldth <mmn@hethane.se>
  25  * @copyright 2014 Free Software Foundation http://fsf.org
  26  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  27  * @link      https://www.gnu.org/software/social/
  28  */
  29
  30 if (!defined('GNUSOCIAL')) { exit(1); }
  31
  32 /*
  33  * Dependencies:
  34  *  php5-imagick
  35  *
  36  * Provides:
  37  *  Animated GIF resize support
  38  *
  39  * Comments:
  40  *  Animated GIF resize requires setting $config['thumbnail']['animated'] = true;
  41  *
  42  * Bugs:
  43  *  Not even ImageMagick is very good at resizing animated GIFs.
  44  *  We are not infinitely fast, so resizing animated GIFs is _not_ recommended.
  45  */
  46
  47 class ImageMagickPlugin extends Plugin
  48 {
  49     /**
  50      * @param ImageFile $file An ImageFile object we're getting metadata for
  51      * @param array $info The response from getimagesize()
  52      */
  53     public function onFillImageFileMetadata(ImageFile $imagefile) {
  54         if (is_null($imagefile->animated) && $imagefile->mimetype === 'image/gif') {
  55             $magick = new Imagick($imagefile->filepath);
  56             $magick = $magick->coalesceImages();
  57             $imagefile->animated = $magick->getNumberImages()>1;
  58         }
  59
  60         return true;
  61     }
  62
  63     public function onStartResizeImageFile(ImageFile $imagefile, $outpath, array $box)
  64     {
  65         switch ($imagefile->mimetype) {
  66         case 'image/gif':
  67             // If GIF, then only for animated gifs! (and only if we really want to resize the animation!)
  68             if ($imagefile->animated && common_config('thumbnail', 'animated')) {
  69                 return $this->resizeImageFileAnimatedGif($imagefile, $outpath, $box);
  70             }
  71             break;
  72         }
  73         return true;
  74     }
  75
  76     protected function resizeImageFileAnimatedGif(ImageFile $imagefile, $outpath, array $box)
  77     {
  78         $magick = new Imagick($imagefile->filepath);
  79         $magick = $magick->coalesceImages();
  80         $magick->setIteratorIndex(0);
  81         do {
  82             $magick->cropImage($box['w'], $box['h'], $box['x'], $box['y']);
  83             $magick->thumbnailImage($box['width'], $box['height']);
  84             $magick->setImagePage($box['width'], $box['height'], 0, 0);
  85         } while ($magick->nextImage());
  86         $magick = $magick->deconstructImages();
  87
  88         // $magick->writeImages($outpath, true); did not work, had to use filehandle
  89         // There's been bugs for writeImages in php5-imagick before, probably now too
  90         $fh = fopen($outpath, 'w+');
  91         $success = $magick->writeImagesFile($fh);
  92         fclose($fh);
  93         $magick->destroy();
  94
  95         return !$success;
  96     }
  97
  98     public function onPluginVersion(&$versions)
  99     {
 100         $versions[] = array('name' => 'ImageMagick',
 101                             'version' => GNUSOCIAL_VERSION,
 102                             'author' => 'Mikael Nordfeldth',
 103                             'homepage' => 'http://gnu.io/social',
 104                             'rawdescription' =>
 105                             // TRANS: Plugin description.
 106                             _m('Use ImageMagick for some more image support.'));
 107         return true;
 108     }
 109 }