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->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->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             throw new UseFileAsThumbnailException($this->id);
 286         }
 287
 288         return $outpath;
 289     }
 290
 291     protected function resizeToFile($outpath, array $box)
 292     {
 293         switch ($this->type) {
 294         case IMAGETYPE_GIF:
 295             $image_src = imagecreatefromgif($this->filepath);
 296             break;
 297         case IMAGETYPE_JPEG:
 298             $image_src = imagecreatefromjpeg($this->filepath);
 299             break;
 300         case IMAGETYPE_PNG:
 301             $image_src = imagecreatefrompng($this->filepath);
 302             break;
 303         case IMAGETYPE_BMP:
 304             $image_src = imagecreatefrombmp($this->filepath);
 305             break;
 306         case IMAGETYPE_WBMP:
 307             $image_src = imagecreatefromwbmp($this->filepath);
 308             break;
 309         case IMAGETYPE_XBM:
 310             $image_src = imagecreatefromxbm($this->filepath);
 311             break;
 312         default:
 313             // TRANS: Exception thrown when trying to resize an unknown file type.
 314             throw new Exception(_('Unknown file type'));
 315         }
 316
 317         if ($this->rotate != 0) {
 318             $image_src = imagerotate($image_src, $this->rotate, 0);
 319         }
 320
 321         $image_dest = imagecreatetruecolor($box['width'], $box['height']);
 322
 323         if ($this->type == IMAGETYPE_GIF || $this->type == IMAGETYPE_PNG || $this->type == IMAGETYPE_BMP) {
 324
 325             $transparent_idx = imagecolortransparent($image_src);
 326
 327             if ($transparent_idx >= 0) {
 328
 329                 $transparent_color = imagecolorsforindex($image_src, $transparent_idx);
 330                 $transparent_idx = imagecolorallocate($image_dest, $transparent_color['red'], $transparent_color['green'], $transparent_color['blue']);
 331                 imagefill($image_dest, 0, 0, $transparent_idx);
 332                 imagecolortransparent($image_dest, $transparent_idx);
 333
 334             } elseif ($this->type == IMAGETYPE_PNG) {
 335
 336                 imagealphablending($image_dest, false);
 337                 $transparent = imagecolorallocatealpha($image_dest, 0, 0, 0, 127);
 338                 imagefill($image_dest, 0, 0, $transparent);
 339                 imagesavealpha($image_dest, true);
 340
 341             }
 342         }
 343
 344         imagecopyresampled($image_dest, $image_src, 0, 0, $box['x'], $box['y'], $box['width'], $box['height'], $box['w'], $box['h']);
 345
 346         switch ($this->preferredType()) {
 347          case IMAGETYPE_GIF:
 348             imagegif($image_dest, $outpath);
 349             break;
 350          case IMAGETYPE_JPEG:
 351             imagejpeg($image_dest, $outpath, common_config('image', 'jpegquality'));
 352             break;
 353          case IMAGETYPE_PNG:
 354             imagepng($image_dest, $outpath);
 355             break;
 356          default:
 357             // TRANS: Exception thrown when trying resize an unknown file type.
 358             throw new Exception(_('Unknown file type'));
 359         }
 360
 361         imagedestroy($image_src);
 362         imagedestroy($image_dest);
 363     }
 364
 365
 366     /**
 367      * Several obscure file types should be normalized to PNG on resize.
 368      *
 369      * @fixme consider flattening anything not GIF or JPEG to PNG
 370      * @return int
 371      */
 372     function preferredType()
 373     {
 374         if($this->type == IMAGETYPE_BMP) {
 375             //we don't want to save BMP... it's an inefficient, rare, antiquated format
 376             //save png instead
 377             return IMAGETYPE_PNG;
 378         } else if($this->type == IMAGETYPE_WBMP) {
 379             //we don't want to save WBMP... it's a rare format that we can't guarantee clients will support
 380             //save png instead
 381             return IMAGETYPE_PNG;
 382         } else if($this->type == IMAGETYPE_XBM) {
 383             //we don't want to save XBM... it's a rare format that we can't guarantee clients will support
 384             //save png instead
 385             return IMAGETYPE_PNG;
 386         }
 387         return $this->type;
 388     }
 389
 390     function unlink()
 391     {
 392         @unlink($this->filepath);
 393     }
 394
 395     static function maxFileSize()
 396     {
 397         $value = ImageFile::maxFileSizeInt();
 398
 399         if ($value > 1024 * 1024) {
 400             $value = $value/(1024*1024);
 401             // TRANS: Number of megabytes. %d is the number.
 402             return sprintf(_m('%dMB','%dMB',$value),$value);
 403         } else if ($value > 1024) {
 404             $value = $value/1024;
 405             // TRANS: Number of kilobytes. %d is the number.
 406             return sprintf(_m('%dkB','%dkB',$value),$value);
 407         } else {
 408             // TRANS: Number of bytes. %d is the number.
 409             return sprintf(_m('%dB','%dB',$value),$value);
 410         }
 411     }
 412
 413     static function maxFileSizeInt()
 414     {
 415         return min(ImageFile::strToInt(ini_get('post_max_size')),
 416                    ImageFile::strToInt(ini_get('upload_max_filesize')),
 417                    ImageFile::strToInt(ini_get('memory_limit')));
 418     }
 419
 420     static function strToInt($str)
 421     {
 422         $unit = substr($str, -1);
 423         $num = substr($str, 0, -1);
 424
 425         switch(strtoupper($unit)){
 426          case 'G':
 427             $num *= 1024;
 428          case 'M':
 429             $num *= 1024;
 430          case 'K':
 431             $num *= 1024;
 432         }
 433
 434         return $num;
 435     }
 436
 437     public function scaleToFit($maxWidth=null, $maxHeight=null, $crop=null)
 438     {
 439         return self::getScalingValues($this->width, $this->height,
 440                                         $maxWidth, $maxHeight, $crop, $this->rotate);
 441     }
 442
 443     /*
 444      * Gets scaling values for images of various types. Cropping can be enabled.
 445      *
 446      * Values will scale _up_ to fit max values if cropping is enabled!
 447      * With cropping disabled, the max value of each axis will be respected.
 448      *
 449      * @param $width    int Original width
 450      * @param $height   int Original height
 451      * @param $maxW     int Resulting max width
 452      * @param $maxH     int Resulting max height
 453      * @param $crop     int Crop to the size (not preserving aspect ratio)
 454      */
 455     public static function getScalingValues($width, $height,
 456                                         $maxW=null, $maxH=null,
 457                                         $crop=null, $rotate=0)
 458     {
 459         $maxW = $maxW ?: common_config('thumbnail', 'width');
 460         $maxH = $maxH ?: common_config('thumbnail', 'height');
 461
 462         if ($maxW < 1 || ($maxH !== null && $maxH < 1)) {
 463             throw new ServerException('Bad parameters for ImageFile::getScalingValues');
 464         } elseif ($maxH === null) {
 465             // if maxH is null, we set maxH to equal maxW and enable crop
 466             $maxH = $maxW;
 467             $crop = true;
 468         }
 469
 470         // Because GD doesn't understand EXIF orientation etc.
 471         if (abs($rotate) == 90) {
 472             $tmp = $width;
 473             $width = $height;
 474             $height = $tmp;
 475         }
 476
 477         // Cropping data (for original image size). Default values, 0 and null,
 478         // imply no cropping and with preserved aspect ratio (per axis).
 479         $cx = 0;    // crop x
 480         $cy = 0;    // crop y
 481         $cw = null; // crop area width
 482         $ch = null; // crop area height
 483
 484         if ($crop) {
 485             $s_ar = $width / $height;
 486             $t_ar = $maxW / $maxH;
 487
 488             $rw = $maxW;
 489             $rh = $maxH;
 490
 491             // Source aspect ratio differs from target, recalculate crop points!
 492             if ($s_ar > $t_ar) {
 493                 $cx = floor($width / 2 - $height * $t_ar / 2);
 494                 $cw = ceil($height * $t_ar);
 495             } elseif ($s_ar < $t_ar) {
 496                 $cy = floor($height / 2 - $width / $t_ar / 2);
 497                 $ch = ceil($width / $t_ar);
 498             }
 499         } else {
 500             $rw = $maxW;
 501             $rh = ceil($height * $rw / $width);
 502
 503             // Scaling caused too large height, decrease to max accepted value
 504             if ($rh > $maxH) {
 505                 $rh = $maxH;
 506                 $rw = ceil($width * $rh / $height);
 507             }
 508         }
 509         return array(intval($rw), intval($rh),
 510                     intval($cx), intval($cy),
 511                     is_null($cw) ? $width : intval($cw),
 512                     is_null($ch) ? $height : intval($ch));
 513     }
 514
 515     /**
 516      * Animated GIF test, courtesy of frank at huddler dot com et al:
 517      * http://php.net/manual/en/function.imagecreatefromgif.php#104473
 518      * Modified so avoid landing inside of a header (and thus not matching our regexp).
 519      */
 520     protected function isAnimatedGif()
 521     {
 522         if (!($fh = @fopen($this->filepath, 'rb'))) {
 523             return false;
 524         }
 525
 526         $count = 0;
 527         //an animated gif contains multiple "frames", with each frame having a
 528         //header made up of:
 529         // * a static 4-byte sequence (\x00\x21\xF9\x04)
 530         // * 4 variable bytes
 531         // * a static 2-byte sequence (\x00\x2C)
 532         // In total the header is maximum 10 bytes.
 533
 534         // We read through the file til we reach the end of the file, or we've found
 535         // at least 2 frame headers
 536         while(!feof($fh) && $count < 2) {
 537             $chunk = fread($fh, 1024 * 100); //read 100kb at a time
 538             $count += preg_match_all('#\x00\x21\xF9\x04.{4}\x00\x2C#s', $chunk, $matches);
 539             // rewind in case we ended up in the middle of the header, but avoid
 540             // infinite loop (i.e. don't rewind if we're already in the end).
 541             if (!feof($fh) && ftell($fh) >= 9) {
 542                 fseek($fh, -9, SEEK_CUR);
 543             }
 544         }
 545
 546         fclose($fh);
 547         return $count > 1;
 548     }
 549
 550     public function getFileThumbnail($width, $height, $crop, $upscale=false)
 551     {
 552         if (!$this->fileRecord instanceof File) {
 553             throw new ServerException('No File object attached to this ImageFile object.');
 554         }
 555
 556         if ($width === null) {
 557             $width = common_config('thumbnail', 'width');
 558             $height = common_config('thumbnail', 'height');
 559             $crop = common_config('thumbnail', 'crop');
 560         }
 561
 562         if (!$upscale) {
 563             if ($width > $this->width) {
 564                 $width = $this->width;
 565             }
 566             if (!is_null($height) && $height > $this->height) {
 567                 $height = $this->height;
 568             }
 569         }
 570
 571         if ($height === null) {
 572             $height = $width;
 573             $crop = true;
 574         }
 575
 576         // Get proper aspect ratio width and height before lookup
 577         // We have to do it through an ImageFile object because of orientation etc.
 578         // Only other solution would've been to rotate + rewrite uploaded files
 579         // which we don't want to do because we like original, untouched data!
 580         list($width, $height, $x, $y, $w, $h) = $this->scaleToFit($width, $height, $crop);
 581
 582         $thumb = File_thumbnail::pkeyGet(array(
 583                                             'file_id'=> $this->fileRecord->id,
 584                                             'width'  => $width,
 585                                             'height' => $height,
 586                                         ));
 587         if ($thumb instanceof File_thumbnail) {
 588             return $thumb;
 589         }
 590
 591         $filename = $this->fileRecord->filehash ?: $this->filename;    // Remote files don't have $this->filehash
 592         $extension = File::guessMimeExtension($this->mimetype);
 593         $outname = "thumb-{$this->fileRecord->id}-{$width}x{$height}-{$filename}." . $extension;
 594         $outpath = File_thumbnail::path($outname);
 595
 596         // The boundary box for our resizing
 597         $box = array('width'=>$width, 'height'=>$height,
 598                      'x'=>$x,         'y'=>$y,
 599                      'w'=>$w,         'h'=>$h);
 600
 601         // Doublecheck that parameters are sane and integers.
 602         if ($box['width'] < 1 || $box['width'] > common_config('thumbnail', 'maxsize')
 603                 || $box['height'] < 1 || $box['height'] > common_config('thumbnail', 'maxsize')
 604                 || $box['w'] < 1 || $box['x'] >= $this->width
 605                 || $box['h'] < 1 || $box['y'] >= $this->height) {
 606             // Fail on bad width parameter. If this occurs, it's due to algorithm in ImageFile->scaleToFit
 607             common_debug("Boundary box parameters for resize of {$this->filepath} : ".var_export($box,true));
 608             throw new ServerException('Bad thumbnail size parameters.');
 609         }
 610
 611         common_debug(sprintf('Generating a thumbnail of File id==%u of size %ux%u', $this->fileRecord->id, $width, $height));
 612
 613         // Perform resize and store into file
 614         $this->resizeTo($outpath, $box);
 615
 616         try {
 617             // Avoid deleting the original
 618             if (!in_array($this->getPath(), [File::path($this->filename), File_thumbnail::path($this->filename)])) {
 619                 $this->unlink();
 620             }
 621         } catch (FileNotFoundException $e) {
 622             // $this->getPath() says the file doesn't exist anyway, so no point in trying to delete it!
 623         }
 624
 625         return File_thumbnail::saveThumbnail($this->fileRecord->getID(),
 626                                       null, // no url since we generated it ourselves and can dynamically generate the url
 627                                       $width, $height,
 628                                       $outname);
 629     }
 630 }
 631
 632 //PHP doesn't (as of 2/24/2010) have an imagecreatefrombmp so conditionally define one
 633 if(!function_exists('imagecreatefrombmp')){
 634     //taken shamelessly from http://www.php.net/manual/en/function.imagecreatefromwbmp.php#86214
 635     function imagecreatefrombmp($p_sFile)
 636     {
 637         //    Load the image into a string
 638         $file    =    fopen($p_sFile,"rb");
 639         $read    =    fread($file,10);
 640         while(!feof($file)&&($read<>""))
 641             $read    .=    fread($file,1024);
 642
 643         $temp    =    unpack("H*",$read);
 644         $hex    =    $temp[1];
 645         $header    =    substr($hex,0,108);
 646
 647         //    Process the header
 648         //    Structure: http://www.fastgraph.com/help/bmp_header_format.html
 649         if (substr($header,0,4)=="424d")
 650         {
 651             //    Cut it in parts of 2 bytes
 652             $header_parts    =    str_split($header,2);
 653
 654             //    Get the width        4 bytes
 655             $width            =    hexdec($header_parts[19].$header_parts[18]);
 656
 657             //    Get the height        4 bytes
 658             $height            =    hexdec($header_parts[23].$header_parts[22]);
 659
 660             //    Unset the header params
 661             unset($header_parts);
 662         }
 663
 664         //    Define starting X and Y
 665         $x                =    0;
 666         $y                =    1;
 667
 668         //    Create newimage
 669         $image            =    imagecreatetruecolor($width,$height);
 670
 671         //    Grab the body from the image
 672         $body            =    substr($hex,108);
 673
 674         //    Calculate if padding at the end-line is needed
 675         //    Divided by two to keep overview.
 676         //    1 byte = 2 HEX-chars
 677         $body_size        =    (strlen($body)/2);
 678         $header_size    =    ($width*$height);
 679
 680         //    Use end-line padding? Only when needed
 681         $usePadding        =    ($body_size>($header_size*3)+4);
 682
 683         //    Using a for-loop with index-calculation instaid of str_split to avoid large memory consumption
 684         //    Calculate the next DWORD-position in the body
 685         for ($i=0;$i<$body_size;$i+=3)
 686         {
 687             //    Calculate line-ending and padding
 688             if ($x>=$width)
 689             {
 690                 //    If padding needed, ignore image-padding
 691                 //    Shift i to the ending of the current 32-bit-block
 692                 if ($usePadding)
 693                     $i    +=    $width%4;
 694
 695                 //    Reset horizontal position
 696                 $x    =    0;
 697
 698                 //    Raise the height-position (bottom-up)
 699                 $y++;
 700
 701                 //    Reached the image-height? Break the for-loop
 702                 if ($y>$height)
 703                     break;
 704             }
 705
 706             //    Calculation of the RGB-pixel (defined as BGR in image-data)
 707             //    Define $i_pos as absolute position in the body
 708             $i_pos    =    $i*2;
 709             $r        =    hexdec($body[$i_pos+4].$body[$i_pos+5]);
 710             $g        =    hexdec($body[$i_pos+2].$body[$i_pos+3]);
 711             $b        =    hexdec($body[$i_pos].$body[$i_pos+1]);
 712
 713             //    Calculate and draw the pixel
 714             $color    =    imagecolorallocate($image,$r,$g,$b);
 715             imagesetpixel($image,$x,$height-$y,$color);
 716
 717             //    Raise the horizontal position
 718             $x++;
 719         }
 720
 721         //    Unset the body / free the memory
 722         unset($body);
 723
 724         //    Return image-object
 725         return $image;
 726     }
 727 }   // if(!function_exists('imagecreatefrombmp'))