* @link http://status.net/
*/
-if (!defined('STATUSNET') && !defined('LACONICA')) {
- exit(1);
-}
+if (!defined('GNUSOCIAL')) { exit(1); }
/**
* A wrapper on uploaded files
{
var $id;
var $filepath;
- var $barename;
+ var $filename;
var $type;
var $height;
var $width;
+ var $rotate=0; // degrees to rotate for properly oriented image (extrapolated from EXIF etc.)
+ var $animated = null; // Animated image? (has more than 1 frame). null means untested
function __construct($id=null, $filepath=null, $type=null, $width=null, $height=null)
{
$this->id = $id;
$this->filepath = $filepath;
+ $this->filename = basename($filepath);
$info = @getimagesize($this->filepath);
- if (!(
- ($info[2] == IMAGETYPE_GIF && function_exists('imagecreatefromgif')) ||
- ($info[2] == IMAGETYPE_JPEG && function_exists('imagecreatefromjpeg')) ||
- $info[2] == IMAGETYPE_BMP ||
- ($info[2] == IMAGETYPE_WBMP && function_exists('imagecreatefromwbmp')) ||
- ($info[2] == IMAGETYPE_XBM && function_exists('imagecreatefromxbm')) ||
- ($info[2] == IMAGETYPE_PNG && function_exists('imagecreatefrompng')))) {
+ if (
+ ($info[2] == IMAGETYPE_GIF && !function_exists('imagecreatefromgif')) ||
+ ($info[2] == IMAGETYPE_JPEG && !function_exists('imagecreatefromjpeg')) ||
+ ($info[2] == IMAGETYPE_WBMP && !function_exists('imagecreatefromwbmp')) ||
+ ($info[2] == IMAGETYPE_XBM && !function_exists('imagecreatefromxbm')) ||
+ ($info[2] == IMAGETYPE_PNG && !function_exists('imagecreatefrompng'))) {
- throw new Exception(_('Unsupported image file format.'));
- return;
+ // TRANS: Exception thrown when trying to upload an unsupported image file format.
+ throw new UnsupportedMediaException(_('Unsupported image format.'), $this->filepath);
}
$this->type = ($info) ? $info[2]:$type;
$this->width = ($info) ? $info[0]:$width;
$this->height = ($info) ? $info[1]:$height;
+
+ if ($this->type == IMAGETYPE_JPEG && function_exists('exif_read_data')) {
+ // Orientation value to rotate thumbnails properly
+ $exif = exif_read_data($this->filepath);
+ if (is_array($exif) && isset($exif['Orientation'])) {
+ switch ((int)$exif['Orientation']) {
+ case 1: // top is top
+ $this->rotate = 0;
+ break;
+ case 3: // top is bottom
+ $this->rotate = 180;
+ break;
+ case 6: // top is right
+ $this->rotate = -90;
+ break;
+ case 8: // top is left
+ $this->rotate = 90;
+ break;
+ }
+ // If we ever write this back, Orientation should be set to '1'
+ }
+ } elseif ($this->type === IMAGETYPE_GIF) {
+ $this->animated = $this->isAnimatedGif();
+ }
+
+ Event::handle('FillImageFileMetadata', array($this));
+ }
+
+ public static function fromFileObject(File $file)
+ {
+ $imgPath = null;
+ $media = common_get_mime_media($file->mimetype);
+ if (Event::handle('CreateFileImageThumbnailSource', array($file, &$imgPath, $media))) {
+ if (empty($file->filename)) {
+ throw new UnsupportedMediaException(_('File without filename could not get a thumbnail source.'));
+ }
+ switch ($media) {
+ case 'image':
+ $imgPath = $file->getPath();
+ break;
+ default:
+ throw new UnsupportedMediaException(_('Unsupported media format.'), $file->getPath());
+ }
+ }
+
+ if (!file_exists($imgPath)) {
+ throw new ServerException(sprintf('Image not available locally: %s', $imgPath));
+ }
+
+ try {
+ $image = new ImageFile($file->id, $imgPath);
+ } catch (UnsupportedMediaException $e) {
+ // Avoid deleting the original
+ if ($imgPath != $file->getPath()) {
+ unlink($imgPath);
+ }
+ throw $e;
+ }
+ return $image;
+ }
+
+ public function getPath()
+ {
+ if (!file_exists($this->filepath)) {
+ throw new ServerException('No file in ImageFile filepath');
+ }
+
+ return $this->filepath;
}
static function fromUpload($param='upload')
switch ($_FILES[$param]['error']) {
case UPLOAD_ERR_OK: // success, jump out
break;
+
case UPLOAD_ERR_INI_SIZE:
case UPLOAD_ERR_FORM_SIZE:
- throw new Exception(sprintf(_('That file is too big. The maximum file size is %s.'),
- ImageFile::maxFileSize()));
- return;
+ // TRANS: Exception thrown when too large a file is uploaded.
+ // TRANS: %s is the maximum file size, for example "500b", "10kB" or "2MB".
+ throw new Exception(sprintf(_('That file is too big. The maximum file size is %s.'), ImageFile::maxFileSize()));
+
case UPLOAD_ERR_PARTIAL:
@unlink($_FILES[$param]['tmp_name']);
+ // TRANS: Exception thrown when uploading an image and that action could not be completed.
throw new Exception(_('Partial upload.'));
- return;
+
case UPLOAD_ERR_NO_FILE:
// No file; probably just a non-AJAX submission.
- return;
default:
- common_log(LOG_ERR, __METHOD__ . ": Unknown upload error " .
- $_FILES[$param]['error']);
+ common_log(LOG_ERR, __METHOD__ . ": Unknown upload error " . $_FILES[$param]['error']);
+ // TRANS: Exception thrown when uploading an image fails for an unknown reason.
throw new Exception(_('System error uploading file.'));
- return;
}
$info = @getimagesize($_FILES[$param]['tmp_name']);
if (!$info) {
@unlink($_FILES[$param]['tmp_name']);
- throw new Exception(_('Not an image or corrupt file.'));
- return;
+ // TRANS: Exception thrown when uploading a file as image that is not an image or is a corrupt file.
+ throw new UnsupportedMediaException(_('Not an image or corrupt file.'), '[deleted]');
}
return new ImageFile(null, $_FILES[$param]['tmp_name']);
}
+ /**
+ * Compat interface for old code generating avatar thumbnails...
+ * Saves the scaled file directly into the avatar area.
+ *
+ * @param int $size target width & height -- must be square
+ * @param int $x (default 0) upper-left corner to crop from
+ * @param int $y (default 0) upper-left corner to crop from
+ * @param int $w (default full) width of image area to crop
+ * @param int $h (default full) height of image area to crop
+ * @return string filename
+ */
function resize($size, $x = 0, $y = 0, $w = null, $h = null)
{
- $w = ($w === null) ? $this->width:$w;
- $h = ($h === null) ? $this->height:$h;
+ $targetType = $this->preferredType();
+ $outname = Avatar::filename($this->id,
+ image_type_to_extension($targetType),
+ $size,
+ common_timestamp());
+ $outpath = Avatar::path($outname);
+ $this->resizeTo($outpath, array('width'=>$size, 'height'=>$size,
+ 'x'=>$x, 'y'=>$y,
+ 'w'=>$w, 'h'=>$h));
+ return $outname;
+ }
+
+ /**
+ * Copy the image file to the given destination.
+ *
+ * This function may modify the resulting file. Please use the
+ * returned ImageFile object to read metadata (width, height etc.)
+ *
+ * @param string $outpath
+ * @return ImageFile the image stored at target path
+ */
+ function copyTo($outpath)
+ {
+ return new ImageFile(null, $this->resizeTo($outpath));
+ }
+
+ /**
+ * Create and save a thumbnail image.
+ *
+ * @param string $outpath
+ * @param array $box width, height, boundary box (x,y,w,h) defaults to full image
+ * @return string full local filesystem filename
+ */
+ function resizeTo($outpath, array $box=array())
+ {
+ $box['width'] = isset($box['width']) ? intval($box['width']) : $this->width;
+ $box['height'] = isset($box['height']) ? intval($box['height']) : $this->height;
+ $box['x'] = isset($box['x']) ? intval($box['x']) : 0;
+ $box['y'] = isset($box['y']) ? intval($box['y']) : 0;
+ $box['w'] = isset($box['w']) ? intval($box['w']) : $this->width;
+ $box['h'] = isset($box['h']) ? intval($box['h']) : $this->height;
if (!file_exists($this->filepath)) {
+ // TRANS: Exception thrown during resize when image has been registered as present, but is no longer there.
throw new Exception(_('Lost our file.'));
- return;
}
- // Don't crop/scale if it isn't necessary
- if ($size === $this->width
- && $size === $this->height
- && $x === 0
- && $y === 0
- && $w === $this->width
- && $h === $this->height) {
-
- $outname = Avatar::filename($this->id,
- image_type_to_extension($this->type),
- $size,
- common_timestamp());
- $outpath = Avatar::path($outname);
- @copy($this->filepath, $outpath);
- return $outname;
+ // Don't rotate/crop/scale if it isn't necessary
+ if ($box['width'] === $this->width
+ && $box['height'] === $this->height
+ && $box['x'] === 0
+ && $box['y'] === 0
+ && $box['w'] === $this->width
+ && $box['h'] === $this->height
+ && $this->type == $this->preferredType()) {
+ if ($this->rotate == 0) {
+ // No rotational difference, just copy it as-is
+ @copy($this->filepath, $outpath);
+
+ // And set chmod
+ @chmod($outpath, common_config('attachments', 'chmod');
+ return $outpath;
+ } elseif (abs($this->rotate) == 90) {
+ // Box is rotated 90 degrees in either direction,
+ // so we have to redefine x to y and vice versa.
+ $tmp = $box['width'];
+ $box['width'] = $box['height'];
+ $box['height'] = $tmp;
+ $tmp = $box['x'];
+ $box['x'] = $box['y'];
+ $box['y'] = $tmp;
+ $tmp = $box['w'];
+ $box['w'] = $box['h'];
+ $box['h'] = $tmp;
+ }
+ }
+
+
+ if (Event::handle('StartResizeImageFile', array($this, $outpath, $box))) {
+ $this->resizeToFile($outpath, $box);
}
+ if (!file_exists($outpath)) {
+ throw new UseFileAsThumbnailException($this->id);
+ }
+
+ return $outpath;
+ }
+
+ protected function resizeToFile($outpath, array $box)
+ {
switch ($this->type) {
- case IMAGETYPE_GIF:
+ case IMAGETYPE_GIF:
$image_src = imagecreatefromgif($this->filepath);
break;
- case IMAGETYPE_JPEG:
+ case IMAGETYPE_JPEG:
$image_src = imagecreatefromjpeg($this->filepath);
break;
- case IMAGETYPE_PNG:
+ case IMAGETYPE_PNG:
$image_src = imagecreatefrompng($this->filepath);
break;
- case IMAGETYPE_BMP:
+ case IMAGETYPE_BMP:
$image_src = imagecreatefrombmp($this->filepath);
break;
- case IMAGETYPE_WBMP:
+ case IMAGETYPE_WBMP:
$image_src = imagecreatefromwbmp($this->filepath);
break;
- case IMAGETYPE_XBM:
+ case IMAGETYPE_XBM:
$image_src = imagecreatefromxbm($this->filepath);
break;
- default:
+ default:
+ // TRANS: Exception thrown when trying to resize an unknown file type.
throw new Exception(_('Unknown file type'));
- return;
}
- $image_dest = imagecreatetruecolor($size, $size);
+ if ($this->rotate != 0) {
+ $image_src = imagerotate($image_src, $this->rotate, 0);
+ }
+
+ $image_dest = imagecreatetruecolor($box['width'], $box['height']);
if ($this->type == IMAGETYPE_GIF || $this->type == IMAGETYPE_PNG || $this->type == IMAGETYPE_BMP) {
}
}
- imagecopyresampled($image_dest, $image_src, 0, 0, $x, $y, $size, $size, $w, $h);
+ imagecopyresampled($image_dest, $image_src, 0, 0, $box['x'], $box['y'], $box['width'], $box['height'], $box['w'], $box['h']);
- if($this->type == IMAGETYPE_BMP) {
- //we don't want to save BMP... it's an inefficient, rare, antiquated format
- //save png instead
- $this->type = IMAGETYPE_PNG;
- } else if($this->type == IMAGETYPE_WBMP) {
- //we don't want to save WBMP... it's a rare format that we can't guarantee clients will support
- //save png instead
- $this->type = IMAGETYPE_PNG;
- } else if($this->type == IMAGETYPE_XBM) {
- //we don't want to save XBM... it's a rare format that we can't guarantee clients will support
- //save png instead
- $this->type = IMAGETYPE_PNG;
- }
-
- $outname = Avatar::filename($this->id,
- image_type_to_extension($this->type),
- $size,
- common_timestamp());
-
- $outpath = Avatar::path($outname);
-
- switch ($this->type) {
+ switch ($this->preferredType()) {
case IMAGETYPE_GIF:
imagegif($image_dest, $outpath);
break;
case IMAGETYPE_JPEG:
- imagejpeg($image_dest, $outpath, 100);
+ imagejpeg($image_dest, $outpath, common_config('image', 'jpegquality'));
break;
case IMAGETYPE_PNG:
imagepng($image_dest, $outpath);
break;
default:
+ // TRANS: Exception thrown when trying resize an unknown file type.
throw new Exception(_('Unknown file type'));
- return;
}
+ // Always chmod 0644 (default) to have other processes (e.g. queue daemon read it)
+ @chmod($outpath, common_config('attachments', 'chmod');
+
imagedestroy($image_src);
imagedestroy($image_dest);
+ }
- return $outname;
+
+ /**
+ * Several obscure file types should be normalized to PNG on resize.
+ *
+ * @fixme consider flattening anything not GIF or JPEG to PNG
+ * @return int
+ */
+ function preferredType()
+ {
+ if($this->type == IMAGETYPE_BMP) {
+ //we don't want to save BMP... it's an inefficient, rare, antiquated format
+ //save png instead
+ return IMAGETYPE_PNG;
+ } else if($this->type == IMAGETYPE_WBMP) {
+ //we don't want to save WBMP... it's a rare format that we can't guarantee clients will support
+ //save png instead
+ return IMAGETYPE_PNG;
+ } else if($this->type == IMAGETYPE_XBM) {
+ //we don't want to save XBM... it's a rare format that we can't guarantee clients will support
+ //save png instead
+ return IMAGETYPE_PNG;
+ }
+ return $this->type;
}
function unlink()
{
- @unlink($this->filename);
+ @unlink($this->filepath);
}
static function maxFileSize()
$value = ImageFile::maxFileSizeInt();
if ($value > 1024 * 1024) {
- return ($value/(1024*1024)) . _('MB');
+ $value = $value/(1024*1024);
+ // TRANS: Number of megabytes. %d is the number.
+ return sprintf(_m('%dMB','%dMB',$value),$value);
} else if ($value > 1024) {
- return ($value/(1024)) . _('kB');
+ $value = $value/1024;
+ // TRANS: Number of kilobytes. %d is the number.
+ return sprintf(_m('%dkB','%dkB',$value),$value);
} else {
- return $value;
+ // TRANS: Number of bytes. %d is the number.
+ return sprintf(_m('%dB','%dB',$value),$value);
}
}
return $num;
}
+
+ public function scaleToFit($maxWidth=null, $maxHeight=null, $crop=null)
+ {
+ return self::getScalingValues($this->width, $this->height,
+ $maxWidth, $maxHeight, $crop, $this->rotate);
+ }
+
+ /*
+ * Gets scaling values for images of various types. Cropping can be enabled.
+ *
+ * Values will scale _up_ to fit max values if cropping is enabled!
+ * With cropping disabled, the max value of each axis will be respected.
+ *
+ * @param $width int Original width
+ * @param $height int Original height
+ * @param $maxW int Resulting max width
+ * @param $maxH int Resulting max height
+ * @param $crop int Crop to the size (not preserving aspect ratio)
+ */
+ public static function getScalingValues($width, $height,
+ $maxW=null, $maxH=null,
+ $crop=null, $rotate=0)
+ {
+ $maxW = $maxW ?: common_config('thumbnail', 'width');
+ $maxH = $maxH ?: common_config('thumbnail', 'height');
+
+ if ($maxW < 1 || ($maxH !== null && $maxH < 1)) {
+ throw new ServerException('Bad parameters for ImageFile::getScalingValues');
+ } elseif ($maxH === null) {
+ // if maxH is null, we set maxH to equal maxW and enable crop
+ $maxH = $maxW;
+ $crop = true;
+ }
+
+ // Because GD doesn't understand EXIF orientation etc.
+ if (abs($rotate) == 90) {
+ $tmp = $width;
+ $width = $height;
+ $height = $tmp;
+ }
+
+ // Cropping data (for original image size). Default values, 0 and null,
+ // imply no cropping and with preserved aspect ratio (per axis).
+ $cx = 0; // crop x
+ $cy = 0; // crop y
+ $cw = null; // crop area width
+ $ch = null; // crop area height
+
+ if ($crop) {
+ $s_ar = $width / $height;
+ $t_ar = $maxW / $maxH;
+
+ $rw = $maxW;
+ $rh = $maxH;
+
+ // Source aspect ratio differs from target, recalculate crop points!
+ if ($s_ar > $t_ar) {
+ $cx = floor($width / 2 - $height * $t_ar / 2);
+ $cw = ceil($height * $t_ar);
+ } elseif ($s_ar < $t_ar) {
+ $cy = floor($height / 2 - $width / $t_ar / 2);
+ $ch = ceil($width / $t_ar);
+ }
+ } else {
+ $rw = $maxW;
+ $rh = ceil($height * $rw / $width);
+
+ // Scaling caused too large height, decrease to max accepted value
+ if ($rh > $maxH) {
+ $rh = $maxH;
+ $rw = ceil($width * $rh / $height);
+ }
+ }
+ return array(intval($rw), intval($rh),
+ intval($cx), intval($cy),
+ is_null($cw) ? $width : intval($cw),
+ is_null($ch) ? $height : intval($ch));
+ }
+
+ /**
+ * Animated GIF test, courtesy of frank at huddler dot com et al:
+ * http://php.net/manual/en/function.imagecreatefromgif.php#104473
+ * Modified so avoid landing inside of a header (and thus not matching our regexp).
+ */
+ protected function isAnimatedGif()
+ {
+ if (!($fh = @fopen($this->filepath, 'rb'))) {
+ return false;
+ }
+
+ $count = 0;
+ //an animated gif contains multiple "frames", with each frame having a
+ //header made up of:
+ // * a static 4-byte sequence (\x00\x21\xF9\x04)
+ // * 4 variable bytes
+ // * a static 2-byte sequence (\x00\x2C)
+ // In total the header is maximum 10 bytes.
+
+ // We read through the file til we reach the end of the file, or we've found
+ // at least 2 frame headers
+ while(!feof($fh) && $count < 2) {
+ $chunk = fread($fh, 1024 * 100); //read 100kb at a time
+ $count += preg_match_all('#\x00\x21\xF9\x04.{4}\x00\x2C#s', $chunk, $matches);
+ // rewind in case we ended up in the middle of the header, but avoid
+ // infinite loop (i.e. don't rewind if we're already in the end).
+ if (!feof($fh) && ftell($fh) >= 9) {
+ fseek($fh, -9, SEEK_CUR);
+ }
+ }
+
+ fclose($fh);
+ return $count > 1;
+ }
}
//PHP doesn't (as of 2/24/2010) have an imagecreatefrombmp so conditionally define one
// Return image-object
return $image;
}
-}
+} // if(!function_exists('imagecreatefrombmp'))
projects / quix0rs-gnu-social.git / blobdiff