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