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