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 image support (for image/gif at least)
  38  */
  39
  40 class ImageMagickPlugin extends Plugin
  41 {
  42     protected $resize_animated = false;
  43
  44     /**
  45      * @param ImageFile $file An ImageFile object we're getting metadata for
  46      * @param array $info The response from getimagesize()
  47      */
  48     public function onFillImageFileMetadata(ImageFile $imagefile) {
  49         switch ($imagefile->type) {
  50         case IMAGETYPE_GIF:
  51             $magick = new Imagick($imagefile->filepath);
  52             $magick = $magick->coalesceImages();
  53             $imagefile->animated = $magick->getNumberImages()>1;
  54             return false;
  55         }
  56
  57         return true;
  58     }
  59
  60     public function onStartResizeImageFile(ImageFile $imagefile, $outpath, array $box) {
  61         // So far we only take over the resize for IMAGETYPE_GIF
  62         // (and only animated for gifs!)
  63         if ($imagefile->type == IMAGETYPE_GIF && $imagefile->animated) {
  64             if (!$this->resize_animated) {
  65                 // Don't resize if not desired, due to CPU/time limitations
  66                 return false;
  67             }
  68             $magick = new Imagick($imagefile->filepath);
  69             $magick = $magick->coalesceImages();
  70             $magick->setIteratorIndex(0);
  71             do {
  72                 $magick->cropImage($box['w'], $box['h'], $box['x'], $box['y']);
  73                 $magick->thumbnailImage($box['width'], $box['height']);
  74                 $magick->setImagePage($box['width'], $box['height'], 0, 0);
  75             } while ($magick->nextImage());
  76             $magick = $magick->deconstructImages();
  77
  78             // $magick->writeImages($outpath, true); did not work, had to use filehandle
  79             // There's been bugs for writeImages in php5-imagick before, probably now too
  80             $fh = fopen($outpath, 'w+');
  81             $success = $magick->writeImagesFile($fh);
  82             fclose($fh);
  83
  84             return !$success;
  85         }
  86         return true;
  87     }
  88
  89     public function onPluginVersion(&$versions)
  90     {
  91         $versions[] = array('name' => 'ImageMagick',
  92                             'version' => GNUSOCIAL_VERSION,
  93                             'author' => 'Mikael Nordfeldth',
  94                             'homepage' => 'http://gnu.io/social',
  95                             'rawdescription' =>
  96                             // TRANS: Plugin description.
  97                             _m('Use ImageMagick for better image support.'));
  98         return true;
  99     }
 100 }
 101