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