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 = false; // Animated image? (has more than 2 frames)
57 function __construct($id=null, $filepath=null, $type=null, $width=null, $height=null)
60 $this->filepath = $filepath;
62 $info = @getimagesize($this->filepath);
65 ($info[2] == IMAGETYPE_GIF && function_exists('imagecreatefromgif')) ||
66 ($info[2] == IMAGETYPE_JPEG && function_exists('imagecreatefromjpeg')) ||
67 $info[2] == IMAGETYPE_BMP ||
68 ($info[2] == IMAGETYPE_WBMP && function_exists('imagecreatefromwbmp')) ||
69 ($info[2] == IMAGETYPE_XBM && function_exists('imagecreatefromxbm')) ||
70 ($info[2] == IMAGETYPE_PNG && function_exists('imagecreatefrompng')))) {
72 // TRANS: Exception thrown when trying to upload an unsupported image file format.
73 throw new UnsupportedMediaException(_('Unsupported image format.'), $this->filepath);
76 $this->type = ($info) ? $info[2]:$type;
77 $this->width = ($info) ? $info[0]:$width;
78 $this->height = ($info) ? $info[1]:$height;
80 if ($this->type == IMAGETYPE_JPEG && function_exists('exif_read_data')) {
81 // Orientation value to rotate thumbnails properly
82 $exif = exif_read_data($this->filepath);
83 if (is_array($exif) && isset($exif['Orientation'])) {
84 switch ((int)$exif['Orientation']) {
88 case 3: // top is bottom
91 case 6: // top is right
94 case 8: // top is left
98 // If we ever write this back, Orientation should be set to '1'
102 Event::handle('FillImageFileMetadata', array($this));
105 public static function fromFileObject(File $file)
108 $media = common_get_mime_media($file->mimetype);
109 if (Event::handle('CreateFileImageThumbnailSource', array($file, &$imgPath, $media))) {
112 $imgPath = $file->getPath();
115 throw new UnsupportedMediaException(_('Unsupported media format.'), $file->getPath());
119 if (!file_exists($imgPath)) {
120 throw new ServerException(sprintf('Image not available locally: %s', $imgPath));
124 $image = new ImageFile($file->id, $imgPath);
125 } catch (UnsupportedMediaException $e) {
126 // Avoid deleting the original
127 if ($imgPath != $file->getPath()) {
135 public function getPath()
137 if (!file_exists($this->filepath)) {
138 throw new ServerException('No file in ImageFile filepath');
141 return $this->filepath;
144 static function fromUpload($param='upload')
146 switch ($_FILES[$param]['error']) {
147 case UPLOAD_ERR_OK: // success, jump out
150 case UPLOAD_ERR_INI_SIZE:
151 case UPLOAD_ERR_FORM_SIZE:
152 // TRANS: Exception thrown when too large a file is uploaded.
153 // TRANS: %s is the maximum file size, for example "500b", "10kB" or "2MB".
154 throw new Exception(sprintf(_('That file is too big. The maximum file size is %s.'), ImageFile::maxFileSize()));
156 case UPLOAD_ERR_PARTIAL:
157 @unlink($_FILES[$param]['tmp_name']);
158 // TRANS: Exception thrown when uploading an image and that action could not be completed.
159 throw new Exception(_('Partial upload.'));
161 case UPLOAD_ERR_NO_FILE:
162 // No file; probably just a non-AJAX submission.
164 common_log(LOG_ERR, __METHOD__ . ": Unknown upload error " . $_FILES[$param]['error']);
165 // TRANS: Exception thrown when uploading an image fails for an unknown reason.
166 throw new Exception(_('System error uploading file.'));
169 $info = @getimagesize($_FILES[$param]['tmp_name']);
172 @unlink($_FILES[$param]['tmp_name']);
173 // TRANS: Exception thrown when uploading a file as image that is not an image or is a corrupt file.
174 throw new UnsupportedMediaException(_('Not an image or corrupt file.'), '[deleted]');
177 return new ImageFile(null, $_FILES[$param]['tmp_name']);
181 * Compat interface for old code generating avatar thumbnails...
182 * Saves the scaled file directly into the avatar area.
184 * @param int $size target width & height -- must be square
185 * @param int $x (default 0) upper-left corner to crop from
186 * @param int $y (default 0) upper-left corner to crop from
187 * @param int $w (default full) width of image area to crop
188 * @param int $h (default full) height of image area to crop
189 * @return string filename
191 function resize($size, $x = 0, $y = 0, $w = null, $h = null)
193 $targetType = $this->preferredType();
194 $outname = Avatar::filename($this->id,
195 image_type_to_extension($targetType),
198 $outpath = Avatar::path($outname);
199 $this->resizeTo($outpath, array('width'=>$size, 'height'=>$size,
206 * Copy the image file to the given destination.
208 * This function may modify the resulting file. Please use the
209 * returned ImageFile object to read metadata (width, height etc.)
211 * @param string $outpath
212 * @return ImageFile the image stored at target path
214 function copyTo($outpath)
216 return new ImageFile(null, $this->resizeTo($outpath));
220 * Create and save a thumbnail image.
222 * @param string $outpath
223 * @param array $box width, height, boundary box (x,y,w,h) defaults to full image
224 * @return string full local filesystem filename
226 function resizeTo($outpath, array $box=array())
228 $box['width'] = isset($box['width']) ? intval($box['width']) : $this->width;
229 $box['height'] = isset($box['height']) ? intval($box['height']) : $this->height;
230 $box['x'] = isset($box['x']) ? intval($box['x']) : 0;
231 $box['y'] = isset($box['y']) ? intval($box['y']) : 0;
232 $box['w'] = isset($box['w']) ? intval($box['w']) : $this->width;
233 $box['h'] = isset($box['h']) ? intval($box['h']) : $this->height;
235 if (!file_exists($this->filepath)) {
236 // TRANS: Exception thrown during resize when image has been registered as present, but is no longer there.
237 throw new Exception(_('Lost our file.'));
240 // Don't rotate/crop/scale if it isn't necessary
241 if ($box['width'] === $this->width
242 && $box['height'] === $this->height
245 && $box['w'] === $this->width
246 && $box['h'] === $this->height
247 && $this->type == $this->preferredType()) {
248 if ($this->rotate == 0) {
249 // No rotational difference, just copy it as-is
250 @copy($this->filepath, $outpath);
252 } elseif (abs($this->rotate) == 90) {
253 // Box is rotated 90 degrees in either direction,
254 // so we have to redefine x to y and vice versa.
255 $tmp = $box['width'];
256 $box['width'] = $box['height'];
257 $box['height'] = $tmp;
259 $box['x'] = $box['y'];
262 $box['w'] = $box['h'];
268 if (Event::handle('StartResizeImageFile', array($this, $outpath, $box))) {
269 $this->resizeToFile($outpath, $box);
272 if (!file_exists($outpath)) {
273 throw new UseFileAsThumbnailException($this->id);
279 protected function resizeToFile($outpath, array $box)
281 switch ($this->type) {
283 $image_src = imagecreatefromgif($this->filepath);
286 $image_src = imagecreatefromjpeg($this->filepath);
289 $image_src = imagecreatefrompng($this->filepath);
292 $image_src = imagecreatefrombmp($this->filepath);
295 $image_src = imagecreatefromwbmp($this->filepath);
298 $image_src = imagecreatefromxbm($this->filepath);
301 // TRANS: Exception thrown when trying to resize an unknown file type.
302 throw new Exception(_('Unknown file type'));
305 if ($this->rotate != 0) {
306 $image_src = imagerotate($image_src, $this->rotate, 0);
309 $image_dest = imagecreatetruecolor($box['width'], $box['height']);
311 if ($this->type == IMAGETYPE_GIF || $this->type == IMAGETYPE_PNG || $this->type == IMAGETYPE_BMP) {
313 $transparent_idx = imagecolortransparent($image_src);
315 if ($transparent_idx >= 0) {
317 $transparent_color = imagecolorsforindex($image_src, $transparent_idx);
318 $transparent_idx = imagecolorallocate($image_dest, $transparent_color['red'], $transparent_color['green'], $transparent_color['blue']);
319 imagefill($image_dest, 0, 0, $transparent_idx);
320 imagecolortransparent($image_dest, $transparent_idx);
322 } elseif ($this->type == IMAGETYPE_PNG) {
324 imagealphablending($image_dest, false);
325 $transparent = imagecolorallocatealpha($image_dest, 0, 0, 0, 127);
326 imagefill($image_dest, 0, 0, $transparent);
327 imagesavealpha($image_dest, true);
332 imagecopyresampled($image_dest, $image_src, 0, 0, $box['x'], $box['y'], $box['width'], $box['height'], $box['w'], $box['h']);
334 switch ($this->preferredType()) {
336 imagegif($image_dest, $outpath);
339 imagejpeg($image_dest, $outpath, common_config('image', 'jpegquality'));
342 imagepng($image_dest, $outpath);
345 // TRANS: Exception thrown when trying resize an unknown file type.
346 throw new Exception(_('Unknown file type'));
349 imagedestroy($image_src);
350 imagedestroy($image_dest);
355 * Several obscure file types should be normalized to PNG on resize.
357 * @fixme consider flattening anything not GIF or JPEG to PNG
360 function preferredType()
362 if($this->type == IMAGETYPE_BMP) {
363 //we don't want to save BMP... it's an inefficient, rare, antiquated format
365 return IMAGETYPE_PNG;
366 } else if($this->type == IMAGETYPE_WBMP) {
367 //we don't want to save WBMP... it's a rare format that we can't guarantee clients will support
369 return IMAGETYPE_PNG;
370 } else if($this->type == IMAGETYPE_XBM) {
371 //we don't want to save XBM... it's a rare format that we can't guarantee clients will support
373 return IMAGETYPE_PNG;
380 @unlink($this->filepath);
383 static function maxFileSize()
385 $value = ImageFile::maxFileSizeInt();
387 if ($value > 1024 * 1024) {
388 $value = $value/(1024*1024);
389 // TRANS: Number of megabytes. %d is the number.
390 return sprintf(_m('%dMB','%dMB',$value),$value);
391 } else if ($value > 1024) {
392 $value = $value/1024;
393 // TRANS: Number of kilobytes. %d is the number.
394 return sprintf(_m('%dkB','%dkB',$value),$value);
396 // TRANS: Number of bytes. %d is the number.
397 return sprintf(_m('%dB','%dB',$value),$value);
401 static function maxFileSizeInt()
403 return min(ImageFile::strToInt(ini_get('post_max_size')),
404 ImageFile::strToInt(ini_get('upload_max_filesize')),
405 ImageFile::strToInt(ini_get('memory_limit')));
408 static function strToInt($str)
410 $unit = substr($str, -1);
411 $num = substr($str, 0, -1);
413 switch(strtoupper($unit)){
425 public function scaleToFit($maxWidth=null, $maxHeight=null, $crop=null)
427 return self::getScalingValues($this->width, $this->height,
428 $maxWidth, $maxHeight, $crop, $this->rotate);
432 * Gets scaling values for images of various types. Cropping can be enabled.
434 * Values will scale _up_ to fit max values if cropping is enabled!
435 * With cropping disabled, the max value of each axis will be respected.
437 * @param $width int Original width
438 * @param $height int Original height
439 * @param $maxW int Resulting max width
440 * @param $maxH int Resulting max height
441 * @param $crop int Crop to the size (not preserving aspect ratio)
443 public static function getScalingValues($width, $height,
444 $maxW=null, $maxH=null,
445 $crop=null, $rotate=0)
447 $maxW = $maxW ?: common_config('thumbnail', 'width');
448 $maxH = $maxH ?: common_config('thumbnail', 'height');
450 if ($maxW < 1 || ($maxH !== null && $maxH < 1)) {
451 throw new ServerException('Bad parameters for ImageFile::getScalingValues');
452 } elseif ($maxH === null) {
453 // if maxH is null, we set maxH to equal maxW and enable crop
458 // Because GD doesn't understand EXIF orientation etc.
459 if (abs($rotate) == 90) {
465 // Cropping data (for original image size). Default values, 0 and null,
466 // imply no cropping and with preserved aspect ratio (per axis).
469 $cw = null; // crop area width
470 $ch = null; // crop area height
473 $s_ar = $width / $height;
474 $t_ar = $maxW / $maxH;
479 // Source aspect ratio differs from target, recalculate crop points!
481 $cx = floor($width / 2 - $height * $t_ar / 2);
482 $cw = ceil($height * $t_ar);
483 } elseif ($s_ar < $t_ar) {
484 $cy = floor($height / 2 - $width / $t_ar / 2);
485 $ch = ceil($width / $t_ar);
489 $rh = ceil($height * $rw / $width);
491 // Scaling caused too large height, decrease to max accepted value
494 $rw = ceil($width * $rh / $height);
497 return array(intval($rw), intval($rh),
498 intval($cx), intval($cy),
499 is_null($cw) ? $width : intval($cw),
500 is_null($ch) ? $height : intval($ch));
504 //PHP doesn't (as of 2/24/2010) have an imagecreatefrombmp so conditionally define one
505 if(!function_exists('imagecreatefrombmp')){
506 //taken shamelessly from http://www.php.net/manual/en/function.imagecreatefromwbmp.php#86214
507 function imagecreatefrombmp($p_sFile)
509 // Load the image into a string
510 $file = fopen($p_sFile,"rb");
511 $read = fread($file,10);
512 while(!feof($file)&&($read<>""))
513 $read .= fread($file,1024);
515 $temp = unpack("H*",$read);
517 $header = substr($hex,0,108);
519 // Process the header
520 // Structure: http://www.fastgraph.com/help/bmp_header_format.html
521 if (substr($header,0,4)=="424d")
523 // Cut it in parts of 2 bytes
524 $header_parts = str_split($header,2);
526 // Get the width 4 bytes
527 $width = hexdec($header_parts[19].$header_parts[18]);
529 // Get the height 4 bytes
530 $height = hexdec($header_parts[23].$header_parts[22]);
532 // Unset the header params
533 unset($header_parts);
536 // Define starting X and Y
541 $image = imagecreatetruecolor($width,$height);
543 // Grab the body from the image
544 $body = substr($hex,108);
546 // Calculate if padding at the end-line is needed
547 // Divided by two to keep overview.
548 // 1 byte = 2 HEX-chars
549 $body_size = (strlen($body)/2);
550 $header_size = ($width*$height);
552 // Use end-line padding? Only when needed
553 $usePadding = ($body_size>($header_size*3)+4);
555 // Using a for-loop with index-calculation instaid of str_split to avoid large memory consumption
556 // Calculate the next DWORD-position in the body
557 for ($i=0;$i<$body_size;$i+=3)
559 // Calculate line-ending and padding
562 // If padding needed, ignore image-padding
563 // Shift i to the ending of the current 32-bit-block
567 // Reset horizontal position
570 // Raise the height-position (bottom-up)
573 // Reached the image-height? Break the for-loop
578 // Calculation of the RGB-pixel (defined as BGR in image-data)
579 // Define $i_pos as absolute position in the body
581 $r = hexdec($body[$i_pos+4].$body[$i_pos+5]);
582 $g = hexdec($body[$i_pos+2].$body[$i_pos+3]);
583 $b = hexdec($body[$i_pos].$body[$i_pos+1]);
585 // Calculate and draw the pixel
586 $color = imagecolorallocate($image,$r,$g,$b);
587 imagesetpixel($image,$x,$height-$y,$color);
589 // Raise the horizontal position
593 // Unset the body / free the memory
596 // Return image-object
599 } // if(!function_exists('imagecreatefrombmp'))