lib/imagefile.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Abstraction for an image file
   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  Image
  23  * @package   StatusNet
  24  * @author    Evan Prodromou <evan@status.net>
  25  * @author    Zach Copley <zach@status.net>
  26  * @copyright 2008-2009 StatusNet, Inc.
  27  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  28  * @link      http://status.net/
  29  */
  30
  31 if (!defined('GNUSOCIAL')) { exit(1); }
  32
  33 /**
  34  * A wrapper on uploaded files
  35  *
  36  * Makes it slightly easier to accept an image file from upload.
  37  *
  38  * @category Image
  39  * @package  StatusNet
  40  * @author   Evan Prodromou <evan@status.net>
  41  * @author   Zach Copley <zach@status.net>
  42  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  43  * @link     http://status.net/
  44  */
  45
  46 class ImageFile
  47 {
  48     var $id;
  49     var $filepath;
  50     var $filename;
  51     var $type;
  52     var $height;
  53     var $width;
  54     var $rotate=0;  // degrees to rotate for properly oriented image (extrapolated from EXIF etc.)
  55     var $animated = null;  // Animated image? (has more than 1 frame). null means untested
  56
  57     function __construct($id, $filepath)
  58     {
  59         $this->id = $id;
  60         $this->filepath = $filepath;
  61         $this->filename = basename($filepath);
  62
  63         $info = @getimagesize($this->filepath);
  64
  65         if (!(
  66             ($info[2] == IMAGETYPE_GIF && function_exists('imagecreatefromgif')) ||
  67             ($info[2] == IMAGETYPE_JPEG && function_exists('imagecreatefromjpeg')) ||
  68             $info[2] == IMAGETYPE_BMP ||
  69             ($info[2] == IMAGETYPE_WBMP && function_exists('imagecreatefromwbmp')) ||
  70             ($info[2] == IMAGETYPE_XBM && function_exists('imagecreatefromxbm')) ||
  71             ($info[2] == IMAGETYPE_PNG && function_exists('imagecreatefrompng')))) {
  72
  73             // TRANS: Exception thrown when trying to upload an unsupported image file format.
  74             throw new UnsupportedMediaException(_('Unsupported image format.'), $this->filepath);
  75         }
  76
  77         $this->width    = $info[0];
  78         $this->height   = $info[1];
  79         $this->type     = $info[2];
  80
  81         if ($this->type == IMAGETYPE_JPEG && function_exists('exif_read_data')) {
  82             // Orientation value to rotate thumbnails properly
  83             $exif = exif_read_data($this->filepath);
  84             if (is_array($exif) && isset($exif['Orientation'])) {
  85                 switch ((int)$exif['Orientation']) {
  86                 case 1: // top is top
  87                     $this->rotate = 0;
  88                     break;
  89                 case 3: // top is bottom
  90                     $this->rotate = 180;
  91                     break;
  92                 case 6: // top is right
  93                     $this->rotate = -90;
  94                     break;
  95                 case 8: // top is left
  96                     $this->rotate = 90;
  97                     break;
  98                 }
  99                 // If we ever write this back, Orientation should be set to '1'
 100             }
 101         } elseif ($this->type === IMAGETYPE_GIF) {
 102             $this->animated = $this->isAnimatedGif();
 103         }
 104
 105         Event::handle('FillImageFileMetadata', array($this));
 106     }
 107
 108     public static function fromFileObject(File $file)
 109     {
 110         $imgPath = null;
 111         $media = common_get_mime_media($file->mimetype);
 112         if (Event::handle('CreateFileImageThumbnailSource', array($file, &$imgPath, $media))) {
 113             if (empty($file->filename)) {
 114                 throw new UnsupportedMediaException(_('File without filename could not get a thumbnail source.'));
 115             }
 116             switch ($media) {
 117             case 'image':
 118                 $imgPath = $file->getPath();
 119                 break;
 120             default:
 121                 throw new UnsupportedMediaException(_('Unsupported media format.'), $file->getPath());
 122             }
 123         }
 124
 125         if (!file_exists($imgPath)) {
 126             throw new ServerException(sprintf('Image not available locally: %s', $imgPath));
 127         }
 128
 129         try {
 130             $image = new ImageFile($file->id, $imgPath);
 131         } catch (UnsupportedMediaException $e) {
 132             // Avoid deleting the original
 133             if ($imgPath != $file->getPath()) {
 134                 unlink($imgPath);
 135             }
 136             throw $e;
 137         }
 138         return $image;
 139     }
 140
 141     public function getPath()
 142     {
 143         if (!file_exists($this->filepath)) {
 144             throw new FileNotFoundException($this->filepath);
 145         }
 146
 147         return $this->filepath;
 148     }
 149
 150     static function fromUpload($param='upload')
 151     {
 152         switch ($_FILES[$param]['error']) {
 153          case UPLOAD_ERR_OK: // success, jump out
 154             break;
 155
 156          case UPLOAD_ERR_INI_SIZE:
 157          case UPLOAD_ERR_FORM_SIZE:
 158             // TRANS: Exception thrown when too large a file is uploaded.
 159             // TRANS: %s is the maximum file size, for example "500b", "10kB" or "2MB".
 160             throw new Exception(sprintf(_('That file is too big. The maximum file size is %s.'), ImageFile::maxFileSize()));
 161
 162          case UPLOAD_ERR_PARTIAL:
 163             @unlink($_FILES[$param]['tmp_name']);
 164             // TRANS: Exception thrown when uploading an image and that action could not be completed.
 165             throw new Exception(_('Partial upload.'));
 166
 167          case UPLOAD_ERR_NO_FILE:
 168             // No file; probably just a non-AJAX submission.
 169          default:
 170             common_log(LOG_ERR, __METHOD__ . ": Unknown upload error " . $_FILES[$param]['error']);
 171             // TRANS: Exception thrown when uploading an image fails for an unknown reason.
 172             throw new Exception(_('System error uploading file.'));
 173         }
 174
 175         $info = @getimagesize($_FILES[$param]['tmp_name']);
 176
 177         if (!$info) {
 178             @unlink($_FILES[$param]['tmp_name']);
 179             // TRANS: Exception thrown when uploading a file as image that is not an image or is a corrupt file.
 180             throw new UnsupportedMediaException(_('Not an image or corrupt file.'), '[deleted]');
 181         }
 182
 183         return new ImageFile(null, $_FILES[$param]['tmp_name']);
 184     }
 185
 186     /**
 187      * Compat interface for old code generating avatar thumbnails...
 188      * Saves the scaled file directly into the avatar area.
 189      *
 190      * @param int $size target width & height -- must be square
 191      * @param int $x (default 0) upper-left corner to crop from
 192      * @param int $y (default 0) upper-left corner to crop from
 193      * @param int $w (default full) width of image area to crop
 194      * @param int $h (default full) height of image area to crop
 195      * @return string filename
 196      */
 197     function resize($size, $x = 0, $y = 0, $w = null, $h = null)
 198     {
 199         $targetType = $this->preferredType();
 200         $outname = Avatar::filename($this->id,
 201                                     image_type_to_extension($targetType),
 202                                     $size,
 203                                     common_timestamp());
 204         $outpath = Avatar::path($outname);
 205         $this->resizeTo($outpath, array('width'=>$size, 'height'=>$size,
 206                                         'x'=>$x,        'y'=>$y,
 207                                         'w'=>$w,        'h'=>$h));
 208         return $outname;
 209     }
 210
 211     /**
 212      * Copy the image file to the given destination.
 213      *
 214      * This function may modify the resulting file. Please use the
 215      * returned ImageFile object to read metadata (width, height etc.)
 216      *
 217      * @param string $outpath
 218      * @return ImageFile the image stored at target path
 219      */
 220     function copyTo($outpath)
 221     {
 222         return new ImageFile(null, $this->resizeTo($outpath));
 223     }
 224
 225     /**
 226      * Create and save a thumbnail image.
 227      *
 228      * @param string $outpath
 229      * @param array $box    width, height, boundary box (x,y,w,h) defaults to full image
 230      * @return string full local filesystem filename
 231      */
 232     function resizeTo($outpath, array $box=array())
 233     {
 234         $box['width'] = isset($box['width']) ? intval($box['width']) : $this->width;
 235         $box['height'] = isset($box['height']) ? intval($box['height']) : $this->height;
 236         $box['x'] = isset($box['x']) ? intval($box['x']) : 0;
 237         $box['y'] = isset($box['y']) ? intval($box['y']) : 0;
 238         $box['w'] = isset($box['w']) ? intval($box['w']) : $this->width;
 239         $box['h'] = isset($box['h']) ? intval($box['h']) : $this->height;
 240
 241         if (!file_exists($this->filepath)) {
 242             // TRANS: Exception thrown during resize when image has been registered as present, but is no longer there.
 243             throw new Exception(_('Lost our file.'));
 244         }
 245
 246         // Don't rotate/crop/scale if it isn't necessary
 247         if ($box['width'] === $this->width
 248                 && $box['height'] === $this->height
 249                 && $box['x'] === 0
 250                 && $box['y'] === 0
 251                 && $box['w'] === $this->width
 252                 && $box['h'] === $this->height
 253                 && $this->type == $this->preferredType()) {
 254             if ($this->rotate == 0) {
 255                 // No rotational difference, just copy it as-is
 256                 @copy($this->filepath, $outpath);
 257                 return $outpath;
 258             } elseif (abs($this->rotate) == 90) {
 259                 // Box is rotated 90 degrees in either direction,
 260                 // so we have to redefine x to y and vice versa.
 261                 $tmp = $box['width'];
 262                 $box['width'] = $box['height'];
 263                 $box['height'] = $tmp;
 264                 $tmp = $box['x'];
 265                 $box['x'] = $box['y'];
 266                 $box['y'] = $tmp;
 267                 $tmp = $box['w'];
 268                 $box['w'] = $box['h'];
 269                 $box['h'] = $tmp;
 270             }
 271         }
 272
 273
 274         if (Event::handle('StartResizeImageFile', array($this, $outpath, $box))) {
 275             $this->resizeToFile($outpath, $box);
 276         }
 277
 278         if (!file_exists($outpath)) {
 279             throw new UseFileAsThumbnailException($this->id);
 280         }
 281
 282         return $outpath;
 283     }
 284
 285     protected function resizeToFile($outpath, array $box)
 286     {
 287         switch ($this->type) {
 288         case IMAGETYPE_GIF:
 289             $image_src = imagecreatefromgif($this->filepath);
 290             break;
 291         case IMAGETYPE_JPEG:
 292             $image_src = imagecreatefromjpeg($this->filepath);
 293             break;
 294         case IMAGETYPE_PNG:
 295             $image_src = imagecreatefrompng($this->filepath);
 296             break;
 297         case IMAGETYPE_BMP:
 298             $image_src = imagecreatefrombmp($this->filepath);
 299             break;
 300         case IMAGETYPE_WBMP:
 301             $image_src = imagecreatefromwbmp($this->filepath);
 302             break;
 303         case IMAGETYPE_XBM:
 304             $image_src = imagecreatefromxbm($this->filepath);
 305             break;
 306         default:
 307             // TRANS: Exception thrown when trying to resize an unknown file type.
 308             throw new Exception(_('Unknown file type'));
 309         }
 310
 311         if ($this->rotate != 0) {
 312             $image_src = imagerotate($image_src, $this->rotate, 0);
 313         }
 314
 315         $image_dest = imagecreatetruecolor($box['width'], $box['height']);
 316
 317         if ($this->type == IMAGETYPE_GIF || $this->type == IMAGETYPE_PNG || $this->type == IMAGETYPE_BMP) {
 318
 319             $transparent_idx = imagecolortransparent($image_src);
 320
 321             if ($transparent_idx >= 0) {
 322
 323                 $transparent_color = imagecolorsforindex($image_src, $transparent_idx);
 324                 $transparent_idx = imagecolorallocate($image_dest, $transparent_color['red'], $transparent_color['green'], $transparent_color['blue']);
 325                 imagefill($image_dest, 0, 0, $transparent_idx);
 326                 imagecolortransparent($image_dest, $transparent_idx);
 327
 328             } elseif ($this->type == IMAGETYPE_PNG) {
 329
 330                 imagealphablending($image_dest, false);
 331                 $transparent = imagecolorallocatealpha($image_dest, 0, 0, 0, 127);
 332                 imagefill($image_dest, 0, 0, $transparent);
 333                 imagesavealpha($image_dest, true);
 334
 335             }
 336         }
 337
 338         imagecopyresampled($image_dest, $image_src, 0, 0, $box['x'], $box['y'], $box['width'], $box['height'], $box['w'], $box['h']);
 339
 340         switch ($this->preferredType()) {
 341          case IMAGETYPE_GIF:
 342             imagegif($image_dest, $outpath);
 343             break;
 344          case IMAGETYPE_JPEG:
 345             imagejpeg($image_dest, $outpath, common_config('image', 'jpegquality'));
 346             break;
 347          case IMAGETYPE_PNG:
 348             imagepng($image_dest, $outpath);
 349             break;
 350          default:
 351             // TRANS: Exception thrown when trying resize an unknown file type.
 352             throw new Exception(_('Unknown file type'));
 353         }
 354
 355         imagedestroy($image_src);
 356         imagedestroy($image_dest);
 357     }
 358
 359
 360     /**
 361      * Several obscure file types should be normalized to PNG on resize.
 362      *
 363      * @fixme consider flattening anything not GIF or JPEG to PNG
 364      * @return int
 365      */
 366     function preferredType()
 367     {
 368         if($this->type == IMAGETYPE_BMP) {
 369             //we don't want to save BMP... it's an inefficient, rare, antiquated format
 370             //save png instead
 371             return IMAGETYPE_PNG;
 372         } else if($this->type == IMAGETYPE_WBMP) {
 373             //we don't want to save WBMP... it's a rare format that we can't guarantee clients will support
 374             //save png instead
 375             return IMAGETYPE_PNG;
 376         } else if($this->type == IMAGETYPE_XBM) {
 377             //we don't want to save XBM... it's a rare format that we can't guarantee clients will support
 378             //save png instead
 379             return IMAGETYPE_PNG;
 380         }
 381         return $this->type;
 382     }
 383
 384     function unlink()
 385     {
 386         @unlink($this->filepath);
 387     }
 388
 389     static function maxFileSize()
 390     {
 391         $value = ImageFile::maxFileSizeInt();
 392
 393         if ($value > 1024 * 1024) {
 394             $value = $value/(1024*1024);
 395             // TRANS: Number of megabytes. %d is the number.
 396             return sprintf(_m('%dMB','%dMB',$value),$value);
 397         } else if ($value > 1024) {
 398             $value = $value/1024;
 399             // TRANS: Number of kilobytes. %d is the number.
 400             return sprintf(_m('%dkB','%dkB',$value),$value);
 401         } else {
 402             // TRANS: Number of bytes. %d is the number.
 403             return sprintf(_m('%dB','%dB',$value),$value);
 404         }
 405     }
 406
 407     static function maxFileSizeInt()
 408     {
 409         return min(ImageFile::strToInt(ini_get('post_max_size')),
 410                    ImageFile::strToInt(ini_get('upload_max_filesize')),
 411                    ImageFile::strToInt(ini_get('memory_limit')));
 412     }
 413
 414     static function strToInt($str)
 415     {
 416         $unit = substr($str, -1);
 417         $num = substr($str, 0, -1);
 418
 419         switch(strtoupper($unit)){
 420          case 'G':
 421             $num *= 1024;
 422          case 'M':
 423             $num *= 1024;
 424          case 'K':
 425             $num *= 1024;
 426         }
 427
 428         return $num;
 429     }
 430
 431     public function scaleToFit($maxWidth=null, $maxHeight=null, $crop=null)
 432     {
 433         return self::getScalingValues($this->width, $this->height,
 434                                         $maxWidth, $maxHeight, $crop, $this->rotate);
 435     }
 436
 437     /*
 438      * Gets scaling values for images of various types. Cropping can be enabled.
 439      *
 440      * Values will scale _up_ to fit max values if cropping is enabled!
 441      * With cropping disabled, the max value of each axis will be respected.
 442      *
 443      * @param $width    int Original width
 444      * @param $height   int Original height
 445      * @param $maxW     int Resulting max width
 446      * @param $maxH     int Resulting max height
 447      * @param $crop     int Crop to the size (not preserving aspect ratio)
 448      */
 449     public static function getScalingValues($width, $height,
 450                                         $maxW=null, $maxH=null,
 451                                         $crop=null, $rotate=0)
 452     {
 453         $maxW = $maxW ?: common_config('thumbnail', 'width');
 454         $maxH = $maxH ?: common_config('thumbnail', 'height');
 455
 456         if ($maxW < 1 || ($maxH !== null && $maxH < 1)) {
 457             throw new ServerException('Bad parameters for ImageFile::getScalingValues');
 458         } elseif ($maxH === null) {
 459             // if maxH is null, we set maxH to equal maxW and enable crop
 460             $maxH = $maxW;
 461             $crop = true;
 462         }
 463
 464         // Because GD doesn't understand EXIF orientation etc.
 465         if (abs($rotate) == 90) {
 466             $tmp = $width;
 467             $width = $height;
 468             $height = $tmp;
 469         }
 470
 471         // Cropping data (for original image size). Default values, 0 and null,
 472         // imply no cropping and with preserved aspect ratio (per axis).
 473         $cx = 0;    // crop x
 474         $cy = 0;    // crop y
 475         $cw = null; // crop area width
 476         $ch = null; // crop area height
 477
 478         if ($crop) {
 479             $s_ar = $width / $height;
 480             $t_ar = $maxW / $maxH;
 481
 482             $rw = $maxW;
 483             $rh = $maxH;
 484
 485             // Source aspect ratio differs from target, recalculate crop points!
 486             if ($s_ar > $t_ar) {
 487                 $cx = floor($width / 2 - $height * $t_ar / 2);
 488                 $cw = ceil($height * $t_ar);
 489             } elseif ($s_ar < $t_ar) {
 490                 $cy = floor($height / 2 - $width / $t_ar / 2);
 491                 $ch = ceil($width / $t_ar);
 492             }
 493         } else {
 494             $rw = $maxW;
 495             $rh = ceil($height * $rw / $width);
 496
 497             // Scaling caused too large height, decrease to max accepted value
 498             if ($rh > $maxH) {
 499                 $rh = $maxH;
 500                 $rw = ceil($width * $rh / $height);
 501             }
 502         }
 503         return array(intval($rw), intval($rh),
 504                     intval($cx), intval($cy),
 505                     is_null($cw) ? $width : intval($cw),
 506                     is_null($ch) ? $height : intval($ch));
 507     }
 508
 509     /**
 510      * Animated GIF test, courtesy of frank at huddler dot com et al:
 511      * http://php.net/manual/en/function.imagecreatefromgif.php#104473
 512      * Modified so avoid landing inside of a header (and thus not matching our regexp).
 513      */
 514     protected function isAnimatedGif()
 515     {
 516         if (!($fh = @fopen($this->filepath, 'rb'))) {
 517             return false;
 518         }
 519
 520         $count = 0;
 521         //an animated gif contains multiple "frames", with each frame having a
 522         //header made up of:
 523         // * a static 4-byte sequence (\x00\x21\xF9\x04)
 524         // * 4 variable bytes
 525         // * a static 2-byte sequence (\x00\x2C)
 526         // In total the header is maximum 10 bytes.
 527
 528         // We read through the file til we reach the end of the file, or we've found
 529         // at least 2 frame headers
 530         while(!feof($fh) && $count < 2) {
 531             $chunk = fread($fh, 1024 * 100); //read 100kb at a time
 532             $count += preg_match_all('#\x00\x21\xF9\x04.{4}\x00\x2C#s', $chunk, $matches);
 533             // rewind in case we ended up in the middle of the header, but avoid
 534             // infinite loop (i.e. don't rewind if we're already in the end).
 535             if (!feof($fh) && ftell($fh) >= 9) {
 536                 fseek($fh, -9, SEEK_CUR);
 537             }
 538         }
 539
 540         fclose($fh);
 541         return $count > 1;
 542     }
 543 }
 544
 545 //PHP doesn't (as of 2/24/2010) have an imagecreatefrombmp so conditionally define one
 546 if(!function_exists('imagecreatefrombmp')){
 547     //taken shamelessly from http://www.php.net/manual/en/function.imagecreatefromwbmp.php#86214
 548     function imagecreatefrombmp($p_sFile)
 549     {
 550         //    Load the image into a string
 551         $file    =    fopen($p_sFile,"rb");
 552         $read    =    fread($file,10);
 553         while(!feof($file)&&($read<>""))
 554             $read    .=    fread($file,1024);
 555
 556         $temp    =    unpack("H*",$read);
 557         $hex    =    $temp[1];
 558         $header    =    substr($hex,0,108);
 559
 560         //    Process the header
 561         //    Structure: http://www.fastgraph.com/help/bmp_header_format.html
 562         if (substr($header,0,4)=="424d")
 563         {
 564             //    Cut it in parts of 2 bytes
 565             $header_parts    =    str_split($header,2);
 566
 567             //    Get the width        4 bytes
 568             $width            =    hexdec($header_parts[19].$header_parts[18]);
 569
 570             //    Get the height        4 bytes
 571             $height            =    hexdec($header_parts[23].$header_parts[22]);
 572
 573             //    Unset the header params
 574             unset($header_parts);
 575         }
 576
 577         //    Define starting X and Y
 578         $x                =    0;
 579         $y                =    1;
 580
 581         //    Create newimage
 582         $image            =    imagecreatetruecolor($width,$height);
 583
 584         //    Grab the body from the image
 585         $body            =    substr($hex,108);
 586
 587         //    Calculate if padding at the end-line is needed
 588         //    Divided by two to keep overview.
 589         //    1 byte = 2 HEX-chars
 590         $body_size        =    (strlen($body)/2);
 591         $header_size    =    ($width*$height);
 592
 593         //    Use end-line padding? Only when needed
 594         $usePadding        =    ($body_size>($header_size*3)+4);
 595
 596         //    Using a for-loop with index-calculation instaid of str_split to avoid large memory consumption
 597         //    Calculate the next DWORD-position in the body
 598         for ($i=0;$i<$body_size;$i+=3)
 599         {
 600             //    Calculate line-ending and padding
 601             if ($x>=$width)
 602             {
 603                 //    If padding needed, ignore image-padding
 604                 //    Shift i to the ending of the current 32-bit-block
 605                 if ($usePadding)
 606                     $i    +=    $width%4;
 607
 608                 //    Reset horizontal position
 609                 $x    =    0;
 610
 611                 //    Raise the height-position (bottom-up)
 612                 $y++;
 613
 614                 //    Reached the image-height? Break the for-loop
 615                 if ($y>$height)
 616                     break;
 617             }
 618
 619             //    Calculation of the RGB-pixel (defined as BGR in image-data)
 620             //    Define $i_pos as absolute position in the body
 621             $i_pos    =    $i*2;
 622             $r        =    hexdec($body[$i_pos+4].$body[$i_pos+5]);
 623             $g        =    hexdec($body[$i_pos+2].$body[$i_pos+3]);
 624             $b        =    hexdec($body[$i_pos].$body[$i_pos+1]);
 625
 626             //    Calculate and draw the pixel
 627             $color    =    imagecolorallocate($image,$r,$g,$b);
 628             imagesetpixel($image,$x,$height-$y,$color);
 629
 630             //    Raise the horizontal position
 631             $x++;
 632         }
 633
 634         //    Unset the body / free the memory
 635         unset($body);
 636
 637         //    Return image-object
 638         return $image;
 639     }
 640 }   // if(!function_exists('imagecreatefrombmp'))