Add support for plugins to resize images

This also adds an event hook to get more metadata of the ImageFile.
Such as if it's animated or so.

diff --git a/EVENTS.txt b/EVENTS.txt
index fffaa20fd06d1a6f7cf032a0eca858a76a876cbc..1a6cba63165b3337485cd9b71ae4a1cad65c1705 100644 (file)
--- a/EVENTS.txt
+++ b/EVENTS.txt
@@ -1459,6 +1459,11 @@ CreateFileImageThumbnailSource: Hook to create image thumbnail source from a Fil
 - &$imgPath: Path to image file which can be used as source for our thumbnail algorithm.
 - $media:   MIME media type ('image', 'video', 'audio' etc.)
 
+StartResizeImageFile: Hook to resize an image and output it to a file. No matching End event yet.
+- $imagefile: ImageFile object we're resizing.
+- $outpath:   string with output filepath
+- $box:       array with size ('width', 'height') and boundary box('x', 'y', 'w', 'h').
+
 StartShowAttachmentRepresentation: Attachment representation, full file (or in rare cases thumbnails/previews).
 - $out:     HTMLOutputter class to use for outputting HTML.
 - $file:    'File' object which we're going to show representation for.

diff --git a/classes/File.php b/classes/File.php
index 9b703aa425ae25d9fc3b6e4c976b8fd778897151..b5bcec404168b8bbf9fbabfc3d58b69d6257ef93 100644 (file)
--- a/classes/File.php
+++ b/classes/File.php
@@ -418,13 +418,6 @@ class File extends Managed_DataObject
         list($width, $height, $x, $y, $w2, $h2) =
                                 $image->scaleToFit($width, $height, $crop);
 
-        // Doublecheck that parameters are sane and integers.
-        if ($width < 1 || $width > common_config('thumbnail', 'maxsize')
-                || $height < 1 || $height > common_config('thumbnail', 'maxsize')) {
-            // Fail on bad width parameter. If this occurs, it's due to algorithm in ImageFile->scaleToFit
-            throw new ServerException('Bad thumbnail size parameters.');
-        }
-
         $params = array('file_id'=> $this->id,
                         'width'  => $width,
                         'height' => $height);
@@ -437,7 +430,9 @@ class File extends Managed_DataObject
         $outname = "thumb-{$width}x{$height}-" . $this->filename;
         $outpath = self::path($outname);
 
-        $image->resizeTo($outpath, $width, $height, $x, $y, $w2, $h2);
+        $image->resizeTo($outpath, array('width'=>$width, 'height'=>$height,
+                                         'x'=>$x,         'y'=>$y,
+                                         'w'=>$w2,        'h'=>$h2));
 
         // Avoid deleting the original
         if ($image->getPath() != $this->getPath()) {

diff --git a/lib/imagefile.php b/lib/imagefile.php
index 1beac97bc442ba08203cdf5955039954d5b82ad8..535afaacb678ff58d4d932bf05bf88b774a97453 100644 (file)
--- a/lib/imagefile.php
+++ b/lib/imagefile.php
@@ -52,6 +52,7 @@ class ImageFile
     var $height;
     var $width;
     var $rotate=0;  // degrees to rotate for properly oriented image (extrapolated from EXIF etc.)
+    var $animated = false;  // Animated image? (has more than 2 frames)
 
     function __construct($id=null, $filepath=null, $type=null, $width=null, $height=null)
     {
@@ -97,6 +98,8 @@ class ImageFile
                 // If we ever write this back, Orientation should be set to '1'
             }
         }
+
+        Event::handle('FillImageFileMetadata', array($this));
     }
 
     public static function fromFileObject(File $file)
@@ -193,7 +196,9 @@ class ImageFile
                                     $size,
                                     common_timestamp());
         $outpath = Avatar::path($outname);
-        $this->resizeTo($outpath, $size, $size, $x, $y, $w, $h);
+        $this->resizeTo($outpath, array('width'=>$size, 'height'=>$size,
+                                        'x'=>$x,        'y'=>$y,
+                                        'w'=>$w,        'h'=>$h));
         return $outname;
     }
 
@@ -207,26 +212,35 @@ class ImageFile
      */
     function copyTo($outpath)
     {
-        return $this->resizeTo($outpath, $this->width, $this->height);
+        return $this->resizeTo($outpath, array('width' =>$this->width,
+                                               'height'=>$this->height));
     }
 
     /**
      * Create and save a thumbnail image.
      *
      * @param string $outpath
-     * @param int $width target width
-     * @param int $height target height
-     * @param int $x (default 0) upper-left corner to crop from
-     * @param int $y (default 0) upper-left corner to crop from
-     * @param int $w (default full) width of image area to crop
-     * @param int $h (default full) height of image area to crop
+     * @param array $box    width, height, boundary box (x,y,w,h) defaults to full image
      * @return string full local filesystem filename
      */
-    function resizeTo($outpath, $width, $height, $x=0, $y=0, $w=null, $h=null)
+    function resizeTo($outpath, array $box=array())
     {
-        $w = ($w === null) ? $this->width:$w;
-        $h = ($h === null) ? $this->height:$h;
-        $targetType = $this->preferredType();
+        $box['width'] = isset($box['width']) ? intval($box['width']) : $this->width;
+        $box['height'] = isset($box['height']) ? intval($box['height']) : $this->height;
+        $box['x'] = isset($box['x']) ? intval($box['x']) : 0;
+        $box['y'] = isset($box['y']) ? intval($box['y']) : 0;
+        $box['w'] = isset($box['w']) ? intval($box['w']) : $this->width;
+        $box['h'] = isset($box['h']) ? intval($box['h']) : $this->height;
+
+        // Doublecheck that parameters are sane and integers.
+        if ($box['width'] < 1 || $box['width'] > common_config('thumbnail', 'maxsize')
+                || $box['height'] < 1 || $box['height'] > common_config('thumbnail', 'maxsize')
+                || $box['w'] < 1 || $box['x'] >= $this->width
+                || $box['h'] < 1 || $box['y'] >= $this->height) {
+            // Fail on bad width parameter. If this occurs, it's due to algorithm in ImageFile->scaleToFit
+            common_debug("Boundary box parameters for resize of {$this->filepath} : ".var_export($box,true));
+            throw new ServerException('Bad thumbnail size parameters.');
+        }
 
         if (!file_exists($this->filepath)) {
             // TRANS: Exception thrown during resize when image has been registered as present, but is no longer there.
@@ -234,38 +248,47 @@ class ImageFile
         }
 
         // Don't crop/scale if it isn't necessary
-        if ($width === $this->width
-            && $height === $this->height
-            && $x === 0
-            && $y === 0
-            && $w === $this->width
-            && $h === $this->height
-            && $this->type == $targetType) {
+        if ($box['width'] === $this->width
+            && $box['height'] === $this->height
+            && $box['x'] === 0
+            && $box['y'] === 0
+            && $box['w'] === $this->width
+            && $box['h'] === $this->height
+            && $this->type == $this->preferredType()) {
 
             @copy($this->filepath, $outpath);
             return $outpath;
         }
 
+        if (Event::handle('StartResizeImageFile', array($this, $outpath, $box))) {
+            $this->resizeToFile($outpath, $box);
+        }
+
+        return $outpath;
+    }
+
+    protected function resizeToFile($outpath, array $box)
+    {
         switch ($this->type) {
-         case IMAGETYPE_GIF:
+        case IMAGETYPE_GIF:
             $image_src = imagecreatefromgif($this->filepath);
             break;
-         case IMAGETYPE_JPEG:
+        case IMAGETYPE_JPEG:
             $image_src = imagecreatefromjpeg($this->filepath);
             break;
-         case IMAGETYPE_PNG:
+        case IMAGETYPE_PNG:
             $image_src = imagecreatefrompng($this->filepath);
             break;
-         case IMAGETYPE_BMP:
+        case IMAGETYPE_BMP:
             $image_src = imagecreatefrombmp($this->filepath);
             break;
-         case IMAGETYPE_WBMP:
+        case IMAGETYPE_WBMP:
             $image_src = imagecreatefromwbmp($this->filepath);
             break;
-         case IMAGETYPE_XBM:
+        case IMAGETYPE_XBM:
             $image_src = imagecreatefromxbm($this->filepath);
             break;
-         default:
+        default:
             // TRANS: Exception thrown when trying to resize an unknown file type.
             throw new Exception(_('Unknown file type'));
         }
@@ -274,7 +297,7 @@ class ImageFile
             $image_src = imagerotate($image_src, $this->rotate, 0);
         }
 
-        $image_dest = imagecreatetruecolor($width, $height);
+        $image_dest = imagecreatetruecolor($box['width'], $box['height']);
 
         if ($this->type == IMAGETYPE_GIF || $this->type == IMAGETYPE_PNG || $this->type == IMAGETYPE_BMP) {
 
@@ -297,9 +320,9 @@ class ImageFile
             }
         }
 
-        imagecopyresampled($image_dest, $image_src, 0, 0, $x, $y, $width, $height, $w, $h);
+        imagecopyresampled($image_dest, $image_src, 0, 0, $box['x'], $box['y'], $box['width'], $box['height'], $box['w'], $box['h']);
 
-        switch ($targetType) {
+        switch ($this->preferredType()) {
          case IMAGETYPE_GIF:
             imagegif($image_dest, $outpath);
             break;
@@ -316,10 +339,9 @@ class ImageFile
 
         imagedestroy($image_src);
         imagedestroy($image_dest);
-
-        return $outpath;
     }
 
+
     /**
      * Several obscure file types should be normalized to PNG on resize.
      *