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
57 function __construct($id=null, $filepath=null, $type=null, $width=null, $height=null)
60 $this->filepath = $filepath;
61 $this->filename = basename($filepath);
63 $info = @getimagesize($this->filepath);
66 ($info[2] == IMAGETYPE_GIF && function_exists('imagecreatefromgif')) ||
67 ($info[2] == IMAGETYPE_JPEG && function_exists('imagecreatefromjpeg')) ||
68 $info[2] == IMAGETYPE_BMP ||
69 ($info[2] == IMAGETYPE_WBMP && function_exists('imagecreatefromwbmp')) ||
70 ($info[2] == IMAGETYPE_XBM && function_exists('imagecreatefromxbm')) ||
71 ($info[2] == IMAGETYPE_PNG && function_exists('imagecreatefrompng')))) {
73 // TRANS: Exception thrown when trying to upload an unsupported image file format.
74 throw new UnsupportedMediaException(_('Unsupported image format.'), $this->filepath);
77 $this->type = ($info) ? $info[2]:$type;
78 $this->width = ($info) ? $info[0]:$width;
79 $this->height = ($info) ? $info[1]:$height;
81 if ($this->type == IMAGETYPE_JPEG && function_exists('exif_read_data')) {
82 // Orientation value to rotate thumbnails properly
83 $exif = exif_read_data($this->filepath);
84 if (is_array($exif) && isset($exif['Orientation'])) {
85 switch ((int)$exif['Orientation']) {
89 case 3: // top is bottom
92 case 6: // top is right
95 case 8: // top is left
99 // If we ever write this back, Orientation should be set to '1'
101 } elseif ($this->type === IMAGETYPE_GIF) {
102 $this->animated = $this->isAnimatedGif();
105 Event::handle('FillImageFileMetadata', array($this));
108 public static function fromFileObject(File $file)
111 $media = common_get_mime_media($file->mimetype);
112 if (Event::handle('CreateFileImageThumbnailSource', array($file, &$imgPath, $media))) {
115 $imgPath = $file->getPath();
118 throw new UnsupportedMediaException(_('Unsupported media format.'), $file->getPath());
122 if (!file_exists($imgPath)) {
123 throw new ServerException(sprintf('Image not available locally: %s', $imgPath));
127 $image = new ImageFile($file->id, $imgPath);
128 } catch (UnsupportedMediaException $e) {
129 // Avoid deleting the original
130 if ($imgPath != $file->getPath()) {
138 public function getPath()
140 if (!file_exists($this->filepath)) {
141 throw new ServerException('No file in ImageFile filepath');
144 return $this->filepath;
147 static function fromUpload($param='upload')
149 switch ($_FILES[$param]['error']) {
150 case UPLOAD_ERR_OK: // success, jump out
153 case UPLOAD_ERR_INI_SIZE:
154 case UPLOAD_ERR_FORM_SIZE:
155 // TRANS: Exception thrown when too large a file is uploaded.
156 // TRANS: %s is the maximum file size, for example "500b", "10kB" or "2MB".
157 throw new Exception(sprintf(_('That file is too big. The maximum file size is %s.'), ImageFile::maxFileSize()));
159 case UPLOAD_ERR_PARTIAL:
160 @unlink($_FILES[$param]['tmp_name']);
161 // TRANS: Exception thrown when uploading an image and that action could not be completed.
162 throw new Exception(_('Partial upload.'));
164 case UPLOAD_ERR_NO_FILE:
165 // No file; probably just a non-AJAX submission.
167 common_log(LOG_ERR, __METHOD__ . ": Unknown upload error " . $_FILES[$param]['error']);
168 // TRANS: Exception thrown when uploading an image fails for an unknown reason.
169 throw new Exception(_('System error uploading file.'));
172 $info = @getimagesize($_FILES[$param]['tmp_name']);
175 @unlink($_FILES[$param]['tmp_name']);
176 // TRANS: Exception thrown when uploading a file as image that is not an image or is a corrupt file.
177 throw new UnsupportedMediaException(_('Not an image or corrupt file.'), '[deleted]');
180 return new ImageFile(null, $_FILES[$param]['tmp_name']);
184 * Compat interface for old code generating avatar thumbnails...
185 * Saves the scaled file directly into the avatar area.
187 * @param int $size target width & height -- must be square
188 * @param int $x (default 0) upper-left corner to crop from
189 * @param int $y (default 0) upper-left corner to crop from
190 * @param int $w (default full) width of image area to crop
191 * @param int $h (default full) height of image area to crop
192 * @return string filename
194 function resize($size, $x = 0, $y = 0, $w = null, $h = null)
196 $targetType = $this->preferredType();
197 $outname = Avatar::filename($this->id,
198 image_type_to_extension($targetType),
201 $outpath = Avatar::path($outname);
202 $this->resizeTo($outpath, array('width'=>$size, 'height'=>$size,
209 * Copy the image file to the given destination.
211 * This function may modify the resulting file. Please use the
212 * returned ImageFile object to read metadata (width, height etc.)
214 * @param string $outpath
215 * @return ImageFile the image stored at target path
217 function copyTo($outpath)
219 return new ImageFile(null, $this->resizeTo($outpath));
223 * Create and save a thumbnail image.
225 * @param string $outpath
226 * @param array $box width, height, boundary box (x,y,w,h) defaults to full image
227 * @return string full local filesystem filename
229 function resizeTo($outpath, array $box=array())
231 $box['width'] = isset($box['width']) ? intval($box['width']) : $this->width;
232 $box['height'] = isset($box['height']) ? intval($box['height']) : $this->height;
233 $box['x'] = isset($box['x']) ? intval($box['x']) : 0;
234 $box['y'] = isset($box['y']) ? intval($box['y']) : 0;
235 $box['w'] = isset($box['w']) ? intval($box['w']) : $this->width;
236 $box['h'] = isset($box['h']) ? intval($box['h']) : $this->height;
238 if (!file_exists($this->filepath)) {
239 // TRANS: Exception thrown during resize when image has been registered as present, but is no longer there.
240 throw new Exception(_('Lost our file.'));
243 // Don't rotate/crop/scale if it isn't necessary
244 if ($box['width'] === $this->width
245 && $box['height'] === $this->height
248 && $box['w'] === $this->width
249 && $box['h'] === $this->height
250 && $this->type == $this->preferredType()) {
251 if ($this->rotate == 0) {
252 // No rotational difference, just copy it as-is
253 @copy($this->filepath, $outpath);
255 } elseif (abs($this->rotate) == 90) {
256 // Box is rotated 90 degrees in either direction,
257 // so we have to redefine x to y and vice versa.
258 $tmp = $box['width'];
259 $box['width'] = $box['height'];
260 $box['height'] = $tmp;
262 $box['x'] = $box['y'];
265 $box['w'] = $box['h'];
271 if (Event::handle('StartResizeImageFile', array($this, $outpath, $box))) {
272 $this->resizeToFile($outpath, $box);
275 if (!file_exists($outpath)) {
276 throw new UseFileAsThumbnailException($this->id);
282 protected function resizeToFile($outpath, array $box)
284 switch ($this->type) {
286 $image_src = imagecreatefromgif($this->filepath);
289 $image_src = imagecreatefromjpeg($this->filepath);
292 $image_src = imagecreatefrompng($this->filepath);
295 $image_src = imagecreatefrombmp($this->filepath);
298 $image_src = imagecreatefromwbmp($this->filepath);
301 $image_src = imagecreatefromxbm($this->filepath);
304 // TRANS: Exception thrown when trying to resize an unknown file type.
305 throw new Exception(_('Unknown file type'));
308 if ($this->rotate != 0) {
309 $image_src = imagerotate($image_src, $this->rotate, 0);
312 $image_dest = imagecreatetruecolor($box['width'], $box['height']);
314 if ($this->type == IMAGETYPE_GIF || $this->type == IMAGETYPE_PNG || $this->type == IMAGETYPE_BMP) {
316 $transparent_idx = imagecolortransparent($image_src);
318 if ($transparent_idx >= 0) {
320 $transparent_color = imagecolorsforindex($image_src, $transparent_idx);
321 $transparent_idx = imagecolorallocate($image_dest, $transparent_color['red'], $transparent_color['green'], $transparent_color['blue']);
322 imagefill($image_dest, 0, 0, $transparent_idx);
323 imagecolortransparent($image_dest, $transparent_idx);
325 } elseif ($this->type == IMAGETYPE_PNG) {
327 imagealphablending($image_dest, false);
328 $transparent = imagecolorallocatealpha($image_dest, 0, 0, 0, 127);
329 imagefill($image_dest, 0, 0, $transparent);
330 imagesavealpha($image_dest, true);
335 imagecopyresampled($image_dest, $image_src, 0, 0, $box['x'], $box['y'], $box['width'], $box['height'], $box['w'], $box['h']);
337 switch ($this->preferredType()) {
339 imagegif($image_dest, $outpath);
342 imagejpeg($image_dest, $outpath, common_config('image', 'jpegquality'));
345 imagepng($image_dest, $outpath);
348 // TRANS: Exception thrown when trying resize an unknown file type.
349 throw new Exception(_('Unknown file type'));
352 imagedestroy($image_src);
353 imagedestroy($image_dest);
358 * Several obscure file types should be normalized to PNG on resize.
360 * @fixme consider flattening anything not GIF or JPEG to PNG
363 function preferredType()
365 if($this->type == IMAGETYPE_BMP) {
366 //we don't want to save BMP... it's an inefficient, rare, antiquated format
368 return IMAGETYPE_PNG;
369 } else if($this->type == IMAGETYPE_WBMP) {
370 //we don't want to save WBMP... it's a rare format that we can't guarantee clients will support
372 return IMAGETYPE_PNG;
373 } else if($this->type == IMAGETYPE_XBM) {
374 //we don't want to save XBM... it's a rare format that we can't guarantee clients will support
376 return IMAGETYPE_PNG;
383 @unlink($this->filepath);
386 static function maxFileSize()
388 $value = ImageFile::maxFileSizeInt();
390 if ($value > 1024 * 1024) {
391 $value = $value/(1024*1024);
392 // TRANS: Number of megabytes. %d is the number.
393 return sprintf(_m('%dMB','%dMB',$value),$value);
394 } else if ($value > 1024) {
395 $value = $value/1024;
396 // TRANS: Number of kilobytes. %d is the number.
397 return sprintf(_m('%dkB','%dkB',$value),$value);
399 // TRANS: Number of bytes. %d is the number.
400 return sprintf(_m('%dB','%dB',$value),$value);
404 static function maxFileSizeInt()
406 return min(ImageFile::strToInt(ini_get('post_max_size')),
407 ImageFile::strToInt(ini_get('upload_max_filesize')),
408 ImageFile::strToInt(ini_get('memory_limit')));
411 static function strToInt($str)
413 $unit = substr($str, -1);
414 $num = substr($str, 0, -1);
416 switch(strtoupper($unit)){
428 public function scaleToFit($maxWidth=null, $maxHeight=null, $crop=null)
430 return self::getScalingValues($this->width, $this->height,
431 $maxWidth, $maxHeight, $crop, $this->rotate);
435 * Gets scaling values for images of various types. Cropping can be enabled.
437 * Values will scale _up_ to fit max values if cropping is enabled!
438 * With cropping disabled, the max value of each axis will be respected.
440 * @param $width int Original width
441 * @param $height int Original height
442 * @param $maxW int Resulting max width
443 * @param $maxH int Resulting max height
444 * @param $crop int Crop to the size (not preserving aspect ratio)
446 public static function getScalingValues($width, $height,
447 $maxW=null, $maxH=null,
448 $crop=null, $rotate=0)
450 $maxW = $maxW ?: common_config('thumbnail', 'width');
451 $maxH = $maxH ?: common_config('thumbnail', 'height');
453 if ($maxW < 1 || ($maxH !== null && $maxH < 1)) {
454 throw new ServerException('Bad parameters for ImageFile::getScalingValues');
455 } elseif ($maxH === null) {
456 // if maxH is null, we set maxH to equal maxW and enable crop
461 // Because GD doesn't understand EXIF orientation etc.
462 if (abs($rotate) == 90) {
468 // Cropping data (for original image size). Default values, 0 and null,
469 // imply no cropping and with preserved aspect ratio (per axis).
472 $cw = null; // crop area width
473 $ch = null; // crop area height
476 $s_ar = $width / $height;
477 $t_ar = $maxW / $maxH;
482 // Source aspect ratio differs from target, recalculate crop points!
484 $cx = floor($width / 2 - $height * $t_ar / 2);
485 $cw = ceil($height * $t_ar);
486 } elseif ($s_ar < $t_ar) {
487 $cy = floor($height / 2 - $width / $t_ar / 2);
488 $ch = ceil($width / $t_ar);
492 $rh = ceil($height * $rw / $width);
494 // Scaling caused too large height, decrease to max accepted value
497 $rw = ceil($width * $rh / $height);
500 return array(intval($rw), intval($rh),
501 intval($cx), intval($cy),
502 is_null($cw) ? $width : intval($cw),
503 is_null($ch) ? $height : intval($ch));
507 * Animated GIF test, courtesy of frank at huddler dot com et al:
508 * http://php.net/manual/en/function.imagecreatefromgif.php#104473
509 * Modified so avoid landing inside of a header (and thus not matching our regexp).
511 protected function isAnimatedGif()
513 if (!($fh = @fopen($this->filepath, 'rb'))) {
518 //an animated gif contains multiple "frames", with each frame having a
520 // * a static 4-byte sequence (\x00\x21\xF9\x04)
521 // * 4 variable bytes
522 // * a static 2-byte sequence (\x00\x2C)
523 // In total the header is maximum 10 bytes.
525 // We read through the file til we reach the end of the file, or we've found
526 // at least 2 frame headers
527 while(!feof($fh) && $count < 2) {
528 $chunk = fread($fh, 1024 * 100); //read 100kb at a time
529 $count += preg_match_all('#\x00\x21\xF9\x04.{4}\x00\x2C#s', $chunk, $matches);
530 // rewind in case we ended up in the middle of the header, but avoid
531 // infinite loop (i.e. don't rewind if we're already in the end).
532 if (!feof($fh) && ftell($fh) >= 9) {
533 fseek($fh, -9, SEEK_CUR);
542 //PHP doesn't (as of 2/24/2010) have an imagecreatefrombmp so conditionally define one
543 if(!function_exists('imagecreatefrombmp')){
544 //taken shamelessly from http://www.php.net/manual/en/function.imagecreatefromwbmp.php#86214
545 function imagecreatefrombmp($p_sFile)
547 // Load the image into a string
548 $file = fopen($p_sFile,"rb");
549 $read = fread($file,10);
550 while(!feof($file)&&($read<>""))
551 $read .= fread($file,1024);
553 $temp = unpack("H*",$read);
555 $header = substr($hex,0,108);
557 // Process the header
558 // Structure: http://www.fastgraph.com/help/bmp_header_format.html
559 if (substr($header,0,4)=="424d")
561 // Cut it in parts of 2 bytes
562 $header_parts = str_split($header,2);
564 // Get the width 4 bytes
565 $width = hexdec($header_parts[19].$header_parts[18]);
567 // Get the height 4 bytes
568 $height = hexdec($header_parts[23].$header_parts[22]);
570 // Unset the header params
571 unset($header_parts);
574 // Define starting X and Y
579 $image = imagecreatetruecolor($width,$height);
581 // Grab the body from the image
582 $body = substr($hex,108);
584 // Calculate if padding at the end-line is needed
585 // Divided by two to keep overview.
586 // 1 byte = 2 HEX-chars
587 $body_size = (strlen($body)/2);
588 $header_size = ($width*$height);
590 // Use end-line padding? Only when needed
591 $usePadding = ($body_size>($header_size*3)+4);
593 // Using a for-loop with index-calculation instaid of str_split to avoid large memory consumption
594 // Calculate the next DWORD-position in the body
595 for ($i=0;$i<$body_size;$i+=3)
597 // Calculate line-ending and padding
600 // If padding needed, ignore image-padding
601 // Shift i to the ending of the current 32-bit-block
605 // Reset horizontal position
608 // Raise the height-position (bottom-up)
611 // Reached the image-height? Break the for-loop
616 // Calculation of the RGB-pixel (defined as BGR in image-data)
617 // Define $i_pos as absolute position in the body
619 $r = hexdec($body[$i_pos+4].$body[$i_pos+5]);
620 $g = hexdec($body[$i_pos+2].$body[$i_pos+3]);
621 $b = hexdec($body[$i_pos].$body[$i_pos+1]);
623 // Calculate and draw the pixel
624 $color = imagecolorallocate($image,$r,$g,$b);
625 imagesetpixel($image,$x,$height-$y,$color);
627 // Raise the horizontal position
631 // Unset the body / free the memory
634 // Return image-object
637 } // if(!function_exists('imagecreatefrombmp'))