3 * StatusNet, the distributed open-source microblogging tool
5 * Abstraction for an image file
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.
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.
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/>.
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/
31 if (!defined('GNUSOCIAL')) { exit(1); }
34 * A wrapper on uploaded files
36 * Makes it slightly easier to accept an image file from upload.
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/
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
58 protected $fileRecord = null;
60 function __construct($id, $filepath)
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);
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);
77 $info = @getimagesize($this->filepath);
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')))) {
87 // TRANS: Exception thrown when trying to upload an unsupported image file format.
88 throw new UnsupportedMediaException(_('Unsupported image format.'), $this->filepath);
91 $this->width = $info[0];
92 $this->height = $info[1];
93 $this->type = $info[2];
94 $this->mimetype = $info['mime'];
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
104 case 3: // top is bottom
107 case 6: // top is right
110 case 8: // top is left
114 // If we ever write this back, Orientation should be set to '1'
116 } elseif ($this->type === IMAGETYPE_GIF) {
117 $this->animated = $this->isAnimatedGif();
120 Event::handle('FillImageFileMetadata', array($this));
123 public static function fromFileObject(File $file)
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.'));
132 // First some mimetype specific exceptions
133 switch ($file->mimetype) {
134 case 'image/svg+xml':
135 throw new UseFileAsThumbnailException($file);
138 // And we'll only consider it an image if it has such a media type
141 $imgPath = $file->getPath();
144 throw new UnsupportedMediaException(_('Unsupported media format.'), $file->getPath());
148 if (!file_exists($imgPath)) {
149 throw new FileNotFoundException($imgPath);
153 $image = new ImageFile($file->getID(), $imgPath);
154 } catch (Exception $e) {
155 // Avoid deleting the original
157 if (strlen($imgPath) > 0 && $imgPath !== $file->getPath()) {
158 common_debug(__METHOD__.': Deleting temporary file that was created as image file thumbnail source: '._ve($imgPath));
161 } catch (FileNotFoundException $e) {
162 // File reported (via getPath) that the original file
163 // doesn't exist anyway, so it's safe to delete $imgPath
166 common_debug(sprintf('Exception caught when creating ImageFile for File id==%s and imgPath==', _ve($file->id), _ve($imgPath)));
172 public function getPath()
174 if (!file_exists($this->filepath)) {
175 throw new FileNotFoundException($this->filepath);
178 return $this->filepath;
181 static function fromUpload($param='upload')
183 switch ($_FILES[$param]['error']) {
184 case UPLOAD_ERR_OK: // success, jump out
187 case UPLOAD_ERR_INI_SIZE:
188 case UPLOAD_ERR_FORM_SIZE:
189 // TRANS: Exception thrown when too large a file is uploaded.
190 // TRANS: %s is the maximum file size, for example "500b", "10kB" or "2MB".
191 throw new Exception(sprintf(_('That file is too big. The maximum file size is %s.'), ImageFile::maxFileSize()));
193 case UPLOAD_ERR_PARTIAL:
194 @unlink($_FILES[$param]['tmp_name']);
195 // TRANS: Exception thrown when uploading an image and that action could not be completed.
196 throw new Exception(_('Partial upload.'));
198 case UPLOAD_ERR_NO_FILE:
199 // No file; probably just a non-AJAX submission.
200 throw new ClientException(_('No file uploaded.'));
203 common_log(LOG_ERR, __METHOD__ . ": Unknown upload error " . $_FILES[$param]['error']);
204 // TRANS: Exception thrown when uploading an image fails for an unknown reason.
205 throw new Exception(_('System error uploading file.'));
208 $info = @getimagesize($_FILES[$param]['tmp_name']);
211 @unlink($_FILES[$param]['tmp_name']);
212 // TRANS: Exception thrown when uploading a file as image that is not an image or is a corrupt file.
213 throw new UnsupportedMediaException(_('Not an image or corrupt file.'), '[deleted]');
216 return new ImageFile(null, $_FILES[$param]['tmp_name']);
220 * Copy the image file to the given destination.
222 * This function may modify the resulting file. Please use the
223 * returned ImageFile object to read metadata (width, height etc.)
225 * @param string $outpath
226 * @return ImageFile the image stored at target path
228 function copyTo($outpath)
230 return new ImageFile(null, $this->resizeTo($outpath));
234 * Create and save a thumbnail image.
236 * @param string $outpath
237 * @param array $box width, height, boundary box (x,y,w,h) defaults to full image
238 * @return string full local filesystem filename
240 function resizeTo($outpath, array $box=array())
242 $box['width'] = isset($box['width']) ? intval($box['width']) : $this->width;
243 $box['height'] = isset($box['height']) ? intval($box['height']) : $this->height;
244 $box['x'] = isset($box['x']) ? intval($box['x']) : 0;
245 $box['y'] = isset($box['y']) ? intval($box['y']) : 0;
246 $box['w'] = isset($box['w']) ? intval($box['w']) : $this->width;
247 $box['h'] = isset($box['h']) ? intval($box['h']) : $this->height;
249 if (!file_exists($this->filepath)) {
250 // TRANS: Exception thrown during resize when image has been registered as present, but is no longer there.
251 throw new Exception(_('Lost our file.'));
254 // Don't rotate/crop/scale if it isn't necessary
255 if ($box['width'] === $this->width
256 && $box['height'] === $this->height
259 && $box['w'] === $this->width
260 && $box['h'] === $this->height
261 && $this->type == $this->preferredType()) {
262 if ($this->rotate == 0) {
263 // No rotational difference, just copy it as-is
264 @copy($this->filepath, $outpath);
266 } elseif (abs($this->rotate) == 90) {
267 // Box is rotated 90 degrees in either direction,
268 // so we have to redefine x to y and vice versa.
269 $tmp = $box['width'];
270 $box['width'] = $box['height'];
271 $box['height'] = $tmp;
273 $box['x'] = $box['y'];
276 $box['w'] = $box['h'];
282 if (Event::handle('StartResizeImageFile', array($this, $outpath, $box))) {
283 $this->resizeToFile($outpath, $box);
286 if (!file_exists($outpath)) {
287 if ($this->fileRecord instanceof File) {
288 throw new UseFileAsThumbnailException($this->fileRecord);
290 throw new UnsupportedMediaException('No local File object exists for ImageFile.');
297 protected function resizeToFile($outpath, array $box)
299 switch ($this->type) {
301 $image_src = imagecreatefromgif($this->filepath);
304 $image_src = imagecreatefromjpeg($this->filepath);
307 $image_src = imagecreatefrompng($this->filepath);
310 $image_src = imagecreatefrombmp($this->filepath);
313 $image_src = imagecreatefromwbmp($this->filepath);
316 $image_src = imagecreatefromxbm($this->filepath);
319 // TRANS: Exception thrown when trying to resize an unknown file type.
320 throw new Exception(_('Unknown file type'));
323 if ($this->rotate != 0) {
324 $image_src = imagerotate($image_src, $this->rotate, 0);
327 $image_dest = imagecreatetruecolor($box['width'], $box['height']);
329 if ($this->type == IMAGETYPE_GIF || $this->type == IMAGETYPE_PNG || $this->type == IMAGETYPE_BMP) {
331 $transparent_idx = imagecolortransparent($image_src);
333 if ($transparent_idx >= 0) {
335 $transparent_color = imagecolorsforindex($image_src, $transparent_idx);
336 $transparent_idx = imagecolorallocate($image_dest, $transparent_color['red'], $transparent_color['green'], $transparent_color['blue']);
337 imagefill($image_dest, 0, 0, $transparent_idx);
338 imagecolortransparent($image_dest, $transparent_idx);
340 } elseif ($this->type == IMAGETYPE_PNG) {
342 imagealphablending($image_dest, false);
343 $transparent = imagecolorallocatealpha($image_dest, 0, 0, 0, 127);
344 imagefill($image_dest, 0, 0, $transparent);
345 imagesavealpha($image_dest, true);
350 imagecopyresampled($image_dest, $image_src, 0, 0, $box['x'], $box['y'], $box['width'], $box['height'], $box['w'], $box['h']);
352 switch ($this->preferredType()) {
354 imagegif($image_dest, $outpath);
357 imagejpeg($image_dest, $outpath, common_config('image', 'jpegquality'));
360 imagepng($image_dest, $outpath);
363 // TRANS: Exception thrown when trying resize an unknown file type.
364 throw new Exception(_('Unknown file type'));
367 imagedestroy($image_src);
368 imagedestroy($image_dest);
373 * Several obscure file types should be normalized to PNG on resize.
375 * @fixme consider flattening anything not GIF or JPEG to PNG
378 function preferredType()
380 if($this->type == IMAGETYPE_BMP) {
381 //we don't want to save BMP... it's an inefficient, rare, antiquated format
383 return IMAGETYPE_PNG;
384 } else if($this->type == IMAGETYPE_WBMP) {
385 //we don't want to save WBMP... it's a rare format that we can't guarantee clients will support
387 return IMAGETYPE_PNG;
388 } else if($this->type == IMAGETYPE_XBM) {
389 //we don't want to save XBM... it's a rare format that we can't guarantee clients will support
391 return IMAGETYPE_PNG;
398 @unlink($this->filepath);
401 static function maxFileSize()
403 $value = ImageFile::maxFileSizeInt();
405 if ($value > 1024 * 1024) {
406 $value = $value/(1024*1024);
407 // TRANS: Number of megabytes. %d is the number.
408 return sprintf(_m('%dMB','%dMB',$value),$value);
409 } else if ($value > 1024) {
410 $value = $value/1024;
411 // TRANS: Number of kilobytes. %d is the number.
412 return sprintf(_m('%dkB','%dkB',$value),$value);
414 // TRANS: Number of bytes. %d is the number.
415 return sprintf(_m('%dB','%dB',$value),$value);
419 static function maxFileSizeInt()
421 return min(ImageFile::strToInt(ini_get('post_max_size')),
422 ImageFile::strToInt(ini_get('upload_max_filesize')),
423 ImageFile::strToInt(ini_get('memory_limit')));
426 static function strToInt($str)
428 $unit = substr($str, -1);
429 $num = substr($str, 0, -1);
431 switch(strtoupper($unit)){
443 public function scaleToFit($maxWidth=null, $maxHeight=null, $crop=null)
445 return self::getScalingValues($this->width, $this->height,
446 $maxWidth, $maxHeight, $crop, $this->rotate);
450 * Gets scaling values for images of various types. Cropping can be enabled.
452 * Values will scale _up_ to fit max values if cropping is enabled!
453 * With cropping disabled, the max value of each axis will be respected.
455 * @param $width int Original width
456 * @param $height int Original height
457 * @param $maxW int Resulting max width
458 * @param $maxH int Resulting max height
459 * @param $crop int Crop to the size (not preserving aspect ratio)
461 public static function getScalingValues($width, $height,
462 $maxW=null, $maxH=null,
463 $crop=null, $rotate=0)
465 $maxW = $maxW ?: common_config('thumbnail', 'width');
466 $maxH = $maxH ?: common_config('thumbnail', 'height');
468 if ($maxW < 1 || ($maxH !== null && $maxH < 1)) {
469 throw new ServerException('Bad parameters for ImageFile::getScalingValues');
470 } elseif ($maxH === null) {
471 // if maxH is null, we set maxH to equal maxW and enable crop
476 // Because GD doesn't understand EXIF orientation etc.
477 if (abs($rotate) == 90) {
483 // Cropping data (for original image size). Default values, 0 and null,
484 // imply no cropping and with preserved aspect ratio (per axis).
487 $cw = null; // crop area width
488 $ch = null; // crop area height
491 $s_ar = $width / $height;
492 $t_ar = $maxW / $maxH;
497 // Source aspect ratio differs from target, recalculate crop points!
499 $cx = floor($width / 2 - $height * $t_ar / 2);
500 $cw = ceil($height * $t_ar);
501 } elseif ($s_ar < $t_ar) {
502 $cy = floor($height / 2 - $width / $t_ar / 2);
503 $ch = ceil($width / $t_ar);
507 $rh = ceil($height * $rw / $width);
509 // Scaling caused too large height, decrease to max accepted value
512 $rw = ceil($width * $rh / $height);
515 return array(intval($rw), intval($rh),
516 intval($cx), intval($cy),
517 is_null($cw) ? $width : intval($cw),
518 is_null($ch) ? $height : intval($ch));
522 * Animated GIF test, courtesy of frank at huddler dot com et al:
523 * http://php.net/manual/en/function.imagecreatefromgif.php#104473
524 * Modified so avoid landing inside of a header (and thus not matching our regexp).
526 protected function isAnimatedGif()
528 if (!($fh = @fopen($this->filepath, 'rb'))) {
533 //an animated gif contains multiple "frames", with each frame having a
535 // * a static 4-byte sequence (\x00\x21\xF9\x04)
536 // * 4 variable bytes
537 // * a static 2-byte sequence (\x00\x2C)
538 // In total the header is maximum 10 bytes.
540 // We read through the file til we reach the end of the file, or we've found
541 // at least 2 frame headers
542 while(!feof($fh) && $count < 2) {
543 $chunk = fread($fh, 1024 * 100); //read 100kb at a time
544 $count += preg_match_all('#\x00\x21\xF9\x04.{4}\x00\x2C#s', $chunk, $matches);
545 // rewind in case we ended up in the middle of the header, but avoid
546 // infinite loop (i.e. don't rewind if we're already in the end).
547 if (!feof($fh) && ftell($fh) >= 9) {
548 fseek($fh, -9, SEEK_CUR);
553 return $count >= 1; // number of animated frames apart from the original image
556 public function getFileThumbnail($width, $height, $crop, $upscale=false)
558 if (!$this->fileRecord instanceof File) {
559 throw new ServerException('No File object attached to this ImageFile object.');
562 if ($width === null) {
563 $width = common_config('thumbnail', 'width');
564 $height = common_config('thumbnail', 'height');
565 $crop = common_config('thumbnail', 'crop');
569 if ($width > $this->width) {
570 $width = $this->width;
572 if (!is_null($height) && $height > $this->height) {
573 $height = $this->height;
577 if ($height === null) {
582 // Get proper aspect ratio width and height before lookup
583 // We have to do it through an ImageFile object because of orientation etc.
584 // Only other solution would've been to rotate + rewrite uploaded files
585 // which we don't want to do because we like original, untouched data!
586 list($width, $height, $x, $y, $w, $h) = $this->scaleToFit($width, $height, $crop);
588 $thumb = File_thumbnail::pkeyGet(array(
589 'file_id'=> $this->fileRecord->getID(),
593 if ($thumb instanceof File_thumbnail) {
597 $filename = $this->fileRecord->filehash ?: $this->filename; // Remote files don't have $this->filehash
598 $extension = File::guessMimeExtension($this->mimetype);
599 $outname = "thumb-{$this->fileRecord->getID()}-{$width}x{$height}-{$filename}." . $extension;
600 $outpath = File_thumbnail::path($outname);
602 // The boundary box for our resizing
603 $box = array('width'=>$width, 'height'=>$height,
607 // Doublecheck that parameters are sane and integers.
608 if ($box['width'] < 1 || $box['width'] > common_config('thumbnail', 'maxsize')
609 || $box['height'] < 1 || $box['height'] > common_config('thumbnail', 'maxsize')
610 || $box['w'] < 1 || $box['x'] >= $this->width
611 || $box['h'] < 1 || $box['y'] >= $this->height) {
612 // Fail on bad width parameter. If this occurs, it's due to algorithm in ImageFile->scaleToFit
613 common_debug("Boundary box parameters for resize of {$this->filepath} : ".var_export($box,true));
614 throw new ServerException('Bad thumbnail size parameters.');
617 common_debug(sprintf('Generating a thumbnail of File id==%u of size %ux%u', $this->fileRecord->getID(), $width, $height));
619 // Perform resize and store into file
620 $this->resizeTo($outpath, $box);
623 // Avoid deleting the original
624 if (!in_array($this->getPath(), [File::path($this->filename), File_thumbnail::path($this->filename)])) {
627 } catch (FileNotFoundException $e) {
628 // $this->getPath() says the file doesn't exist anyway, so no point in trying to delete it!
631 return File_thumbnail::saveThumbnail($this->fileRecord->getID(),
632 null, // no url since we generated it ourselves and can dynamically generate the url
638 //PHP doesn't (as of 2/24/2010) have an imagecreatefrombmp so conditionally define one
639 if(!function_exists('imagecreatefrombmp')){
640 //taken shamelessly from http://www.php.net/manual/en/function.imagecreatefromwbmp.php#86214
641 function imagecreatefrombmp($p_sFile)
643 // Load the image into a string
644 $file = fopen($p_sFile,"rb");
645 $read = fread($file,10);
646 while(!feof($file)&&($read<>""))
647 $read .= fread($file,1024);
649 $temp = unpack("H*",$read);
651 $header = substr($hex,0,108);
653 // Process the header
654 // Structure: http://www.fastgraph.com/help/bmp_header_format.html
655 if (substr($header,0,4)=="424d")
657 // Cut it in parts of 2 bytes
658 $header_parts = str_split($header,2);
660 // Get the width 4 bytes
661 $width = hexdec($header_parts[19].$header_parts[18]);
663 // Get the height 4 bytes
664 $height = hexdec($header_parts[23].$header_parts[22]);
666 // Unset the header params
667 unset($header_parts);
670 // Define starting X and Y
675 $image = imagecreatetruecolor($width,$height);
677 // Grab the body from the image
678 $body = substr($hex,108);
680 // Calculate if padding at the end-line is needed
681 // Divided by two to keep overview.
682 // 1 byte = 2 HEX-chars
683 $body_size = (strlen($body)/2);
684 $header_size = ($width*$height);
686 // Use end-line padding? Only when needed
687 $usePadding = ($body_size>($header_size*3)+4);
689 // Using a for-loop with index-calculation instaid of str_split to avoid large memory consumption
690 // Calculate the next DWORD-position in the body
691 for ($i=0;$i<$body_size;$i+=3)
693 // Calculate line-ending and padding
696 // If padding needed, ignore image-padding
697 // Shift i to the ending of the current 32-bit-block
701 // Reset horizontal position
704 // Raise the height-position (bottom-up)
707 // Reached the image-height? Break the for-loop
712 // Calculation of the RGB-pixel (defined as BGR in image-data)
713 // Define $i_pos as absolute position in the body
715 $r = hexdec($body[$i_pos+4].$body[$i_pos+5]);
716 $g = hexdec($body[$i_pos+2].$body[$i_pos+3]);
717 $b = hexdec($body[$i_pos].$body[$i_pos+1]);
719 // Calculate and draw the pixel
720 $color = imagecolorallocate($image,$r,$g,$b);
721 imagesetpixel($image,$x,$height-$y,$color);
723 // Raise the horizontal position
727 // Unset the body / free the memory
730 // Return image-object
733 } // if(!function_exists('imagecreatefrombmp'))