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