nextcloud/lib/image.php

688 lines
19 KiB
PHP
Raw Normal View History

2012-01-01 20:57:26 +04:00
<?php
/**
* ownCloud
*
* @author Thomas Tanghus
* @copyright 2011 Thomas Tanghus <thomas@tanghus.net>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE
* License as published by the Free Software Foundation; either
* version 3 of the License, or any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU AFFERO GENERAL PUBLIC LICENSE for more details.
*
* You should have received a copy of the GNU Affero General Public
* License along with this library. If not, see <http://www.gnu.org/licenses/>.
*
*/
//From user comments at http://dk2.php.net/manual/en/function.exif-imagetype.php
if ( ! function_exists( 'exif_imagetype' ) ) {
2012-07-24 02:39:59 +04:00
function exif_imagetype ( $filename ) {
if ( ( $info = getimagesize( $filename ) ) !== false ) {
return $info[2];
}
return false;
}
}
function ellipsis($str, $maxlen) {
if (strlen($str) > $maxlen) {
$characters = floor($maxlen / 2);
return substr($str, 0, $characters) . '...' . substr($str, -1 * $characters);
}
return $str;
}
2012-01-01 20:57:26 +04:00
/**
* Class for basic image manipulation
2012-01-01 20:57:26 +04:00
*
*/
class OC_Image {
protected $resource = false; // tmp resource.
protected $imagetype = IMAGETYPE_PNG; // Default to png if file type isn't evident.
protected $filepath = null;
/**
* @brief Get mime type for an image file.
* @param $filepath The path to a local image file.
* @returns string The mime type if the it could be determined, otherwise an empty string.
*/
static public function getMimeTypeForFile($filepath) {
$imagetype = exif_imagetype($filepath);
return $imagetype ? image_type_to_mime_type($imagetype) : '';
}
2012-01-01 20:57:26 +04:00
/**
* @brief Constructor.
* @param $imageref The path to a local file, a base64 encoded string or a resource created by an imagecreate* function.
* @returns bool False on error
*/
public function __construct($imageref = null) {
//OC_Log::write('core',__METHOD__.'(): start', OC_Log::DEBUG);
if(!extension_loaded('gd') || !function_exists('gd_info')) {
OC_Log::write('core',__METHOD__.'(): GD module not installed', OC_Log::ERROR);
2012-01-01 20:57:26 +04:00
return false;
}
if(!is_null($imageref)) {
$this->load($imageref);
2012-01-01 20:57:26 +04:00
}
}
2012-01-01 23:06:35 +04:00
/**
* @brief Determine whether the object contains an image resource.
* @returns bool
2012-01-01 23:06:35 +04:00
*/
public function valid() { // apparently you can't name a method 'empty'...
return is_resource($this->resource);
}
/**
* @brief Returns the MIME type of the image or an empty string if no image is loaded.
* @returns int
*/
public function mimeType() {
return $this->valid() ? image_type_to_mime_type($this->imagetype) : '';
}
/**
* @brief Returns the width of the image or -1 if no image is loaded.
* @returns int
*/
public function width() {
return $this->valid() ? imagesx($this->resource) : -1;
}
/**
* @brief Returns the height of the image or -1 if no image is loaded.
* @returns int
*/
public function height() {
return $this->valid() ? imagesy($this->resource) : -1;
2012-01-01 23:06:35 +04:00
}
2012-07-05 23:09:48 +04:00
/**
* @brief Returns the width when the image orientation is top-left.
* @returns int
*/
public function widthTopLeft() {
$o = $this->getOrientation();
OC_Log::write('core','OC_Image->widthTopLeft() Orientation: '.$o, OC_Log::DEBUG);
switch($o) {
case -1:
case 1:
case 2: // Not tested
case 3:
case 4: // Not tested
return $this->width();
break;
case 5: // Not tested
case 6:
case 7: // Not tested
case 8:
return $this->height();
break;
}
return $this->width();
}
/**
* @brief Returns the height when the image orientation is top-left.
* @returns int
*/
public function heightTopLeft() {
$o = $this->getOrientation();
OC_Log::write('core','OC_Image->heightTopLeft() Orientation: '.$o, OC_Log::DEBUG);
switch($o) {
case -1:
case 1:
case 2: // Not tested
case 3:
case 4: // Not tested
return $this->height();
break;
case 5: // Not tested
case 6:
case 7: // Not tested
case 8:
return $this->width();
break;
}
return $this->height();
}
2012-01-01 20:57:26 +04:00
/**
2012-01-02 15:09:45 +04:00
* @brief Outputs the image.
* @returns bool
2012-01-01 20:57:26 +04:00
*/
public function show() {
header('Content-Type: '.$this->mimeType());
2012-01-02 15:09:45 +04:00
return $this->_output();
}
/**
* @brief Saves the image.
* @returns bool
*/
2012-01-02 15:09:45 +04:00
public function save($filepath=null) {
if($filepath === null && $this->filepath === null) {
OC_Log::write('core',__METHOD__.'(): called with no path.', OC_Log::ERROR);
2012-01-02 15:09:45 +04:00
return false;
} elseif($filepath === null && $this->filepath !== null) {
$filepath = $this->filepath;
}
return $this->_output($filepath);
2012-01-02 15:09:45 +04:00
}
/**
* @brief Outputs/saves the image.
*/
private function _output($filepath=null) {
if($filepath) {
2012-06-02 17:25:50 +04:00
if (!file_exists(dirname($filepath)))
mkdir(dirname($filepath), 0777, true);
if(!is_writable(dirname($filepath))) {
OC_Log::write('core',__METHOD__.'(): Directory \''.dirname($filepath).'\' is not writable.', OC_Log::ERROR);
return false;
} elseif(is_writable(dirname($filepath)) && file_exists($filepath) && !is_writable($filepath)) {
OC_Log::write('core',__METHOD__.'(): File \''.$filepath.'\' is not writable.', OC_Log::ERROR);
2012-01-02 15:09:45 +04:00
return false;
}
}
if (!$this->valid()) {
return false;
}
2012-01-02 15:09:45 +04:00
$retval = false;
switch($this->imagetype) {
case IMAGETYPE_GIF:
$retval = imagegif($this->resource, $filepath);
break;
case IMAGETYPE_JPEG:
$retval = imagejpeg($this->resource, $filepath);
break;
case IMAGETYPE_PNG:
$retval = imagepng($this->resource, $filepath);
break;
case IMAGETYPE_XBM:
$retval = imagexbm($this->resource, $filepath);
break;
case IMAGETYPE_WBMP:
case IMAGETYPE_BMP:
$retval = imagewbmp($this->resource, $filepath);
break;
default:
$retval = imagepng($this->resource, $filepath);
}
2012-01-02 15:09:45 +04:00
return $retval;
2012-01-01 20:57:26 +04:00
}
/**
* @brief Prints the image when called as $image().
*/
public function __invoke() {
return $this->show();
2012-01-01 20:57:26 +04:00
}
/**
* @returns Returns the image resource in any.
*/
public function resource() {
return $this->resource;
2012-01-01 20:57:26 +04:00
}
/**
* @returns Returns the raw image data.
2012-01-01 20:57:26 +04:00
*/
function data() {
2012-01-01 20:57:26 +04:00
ob_start();
$res = imagepng($this->resource);
2012-01-01 20:57:26 +04:00
if (!$res) {
OC_Log::write('core','OC_Image->data. Error getting image data.',OC_Log::ERROR);
2012-01-01 20:57:26 +04:00
}
return ob_get_clean();
}
/**
* @returns Returns a base64 encoded string suitable for embedding in a VCard.
*/
function __toString() {
return base64_encode($this->data());
2012-01-01 20:57:26 +04:00
}
/**
2012-01-08 18:35:29 +04:00
* (I'm open for suggestions on better method name ;)
2012-07-05 23:09:48 +04:00
* @brief Get the orientation based on EXIF data.
* @returns The orientation or -1 if no EXIF data is available.
*/
2012-07-05 23:09:48 +04:00
public function getOrientation() {
2012-09-07 17:22:01 +04:00
if(!is_callable('exif_read_data')) {
OC_Log::write('core','OC_Image->fixOrientation() Exif module not enabled.', OC_Log::DEBUG);
2012-07-05 23:09:48 +04:00
return -1;
}
if(!$this->valid()) {
OC_Log::write('core','OC_Image->fixOrientation() No image loaded.', OC_Log::DEBUG);
2012-07-05 23:09:48 +04:00
return -1;
}
if(is_null($this->filepath) || !is_readable($this->filepath)) {
OC_Log::write('core','OC_Image->fixOrientation() No readable file path set.', OC_Log::DEBUG);
2012-07-05 23:09:48 +04:00
return -1;
}
$exif = @exif_read_data($this->filepath, 'IFD0');
if(!$exif) {
2012-07-05 23:09:48 +04:00
return -1;
}
if(!isset($exif['Orientation'])) {
2012-07-05 23:09:48 +04:00
return -1;
}
2012-07-05 23:09:48 +04:00
return $exif['Orientation'];
}
/**
* (I'm open for suggestions on better method name ;)
* @brief Fixes orientation based on EXIF data.
* @returns bool.
*/
public function fixOrientation() {
2012-07-05 23:35:36 +04:00
$o = $this->getOrientation();
OC_Log::write('core','OC_Image->fixOrientation() Orientation: '.$o, OC_Log::DEBUG);
$rotate = 0;
$flip = false;
switch($o) {
2012-07-05 23:09:48 +04:00
case -1:
return false; //Nothing to fix
break;
case 1:
$rotate = 0;
$flip = false;
break;
case 2: // Not tested
$rotate = 0;
$flip = true;
break;
case 3:
$rotate = 180;
$flip = false;
break;
case 4: // Not tested
$rotate = 180;
$flip = true;
break;
case 5: // Not tested
$rotate = 90;
$flip = true;
break;
case 6:
//$rotate = 90;
$rotate = 270;
$flip = false;
break;
case 7: // Not tested
$rotate = 270;
$flip = true;
break;
case 8:
$rotate = 90;
$flip = false;
break;
}
if($rotate) {
$res = imagerotate($this->resource, $rotate, -1);
if($res) {
if(imagealphablending($res, true)) {
if(imagesavealpha($res, true)) {
imagedestroy($this->resource);
$this->resource = $res;
return true;
} else {
OC_Log::write('core','OC_Image->fixOrientation() Error during alphasaving.', OC_Log::DEBUG);
return false;
}
} else {
OC_Log::write('core','OC_Image->fixOrientation() Error during alphablending.', OC_Log::DEBUG);
return false;
}
} else {
OC_Log::write('core','OC_Image->fixOrientation() Error during oriention fixing.', OC_Log::DEBUG);
return false;
}
}
}
2012-01-01 20:57:26 +04:00
/**
* @brief Loads an image from a local file, a base64 encoded string or a resource created by an imagecreate* function.
* @param $imageref The path to a local file, a base64 encoded string or a resource created by an imagecreate* function or a file resource (file handle ).
2012-01-01 20:57:26 +04:00
* @returns An image resource or false on error
*/
public function load($imageref) {
if(is_resource($imageref)) {
if(get_resource_type($imageref) == 'gd') {
2012-07-20 19:51:50 +04:00
$this->resource = $imageref;
return $this->resource;
} elseif(in_array(get_resource_type($imageref), array('file','stream'))) {
return $this->loadFromFileHandle($imageref);
}
} elseif($this->loadFromFile($imageref) !== false) {
return $this->resource;
} elseif($this->loadFromBase64($imageref) !== false) {
return $this->resource;
} elseif($this->loadFromData($imageref) !== false) {
return $this->resource;
2012-01-01 20:57:26 +04:00
} else {
OC_Log::write('core',__METHOD__.'(): couldn\'t load anything. Giving up!', OC_Log::DEBUG);
2012-01-01 20:57:26 +04:00
return false;
}
}
/**
* @brief Loads an image from an open file handle.
* It is the responsibility of the caller to position the pointer at the correct place and to close the handle again.
2012-08-29 10:38:33 +04:00
* @param $handle
* @returns An image resource or false on error
*/
public function loadFromFileHandle($handle) {
OC_Log::write('core',__METHOD__.'(): Trying', OC_Log::DEBUG);
2012-03-27 00:33:37 +04:00
$contents = stream_get_contents($handle);
if($this->loadFromData($contents)) {
return $this->resource;
}
}
2012-01-01 20:57:26 +04:00
/**
* @brief Loads an image from a local file.
* @param $imageref The path to a local file.
* @returns An image resource or false on error
*/
public function loadFromFile($imagepath=false) {
2012-01-01 20:57:26 +04:00
if(!is_file($imagepath) || !file_exists($imagepath) || !is_readable($imagepath)) {
// Debug output disabled because this method is tried before loadFromBase64?
OC_Log::write('core','OC_Image->loadFromFile, couldn\'t load: '.ellipsis($imagepath, 50), OC_Log::DEBUG);
2012-01-01 20:57:26 +04:00
return false;
}
$itype = exif_imagetype($imagepath);
switch($itype) {
case IMAGETYPE_GIF:
if (imagetypes() & IMG_GIF) {
$this->resource = imagecreatefromgif($imagepath);
} else {
OC_Log::write('core','OC_Image->loadFromFile, GIF images not supported: '.$imagepath, OC_Log::DEBUG);
}
break;
case IMAGETYPE_JPEG:
if (imagetypes() & IMG_JPG) {
$this->resource = imagecreatefromjpeg($imagepath);
} else {
OC_Log::write('core','OC_Image->loadFromFile, JPG images not supported: '.$imagepath, OC_Log::DEBUG);
}
break;
case IMAGETYPE_PNG:
if (imagetypes() & IMG_PNG) {
$this->resource = imagecreatefrompng($imagepath);
} else {
OC_Log::write('core','OC_Image->loadFromFile, PNG images not supported: '.$imagepath, OC_Log::DEBUG);
}
break;
case IMAGETYPE_XBM:
if (imagetypes() & IMG_XPM) {
$this->resource = imagecreatefromxbm($imagepath);
} else {
OC_Log::write('core','OC_Image->loadFromFile, XBM/XPM images not supported: '.$imagepath, OC_Log::DEBUG);
}
break;
case IMAGETYPE_WBMP:
case IMAGETYPE_BMP:
if (imagetypes() & IMG_WBMP) {
$this->resource = imagecreatefromwbmp($imagepath);
} else {
OC_Log::write('core','OC_Image->loadFromFile, (W)BMP images not supported: '.$imagepath, OC_Log::DEBUG);
}
break;
/*
case IMAGETYPE_TIFF_II: // (intel byte order)
break;
case IMAGETYPE_TIFF_MM: // (motorola byte order)
break;
case IMAGETYPE_JPC:
break;
case IMAGETYPE_JP2:
break;
case IMAGETYPE_JPX:
break;
case IMAGETYPE_JB2:
break;
case IMAGETYPE_SWC:
break;
case IMAGETYPE_IFF:
break;
case IMAGETYPE_ICO:
break;
case IMAGETYPE_SWF:
break;
case IMAGETYPE_PSD:
break;
*/
default:
2012-08-29 10:38:33 +04:00
// this is mostly file created from encrypted file
2012-10-10 15:18:36 +04:00
$this->resource = imagecreatefromstring(\OC\Files\Filesystem::file_get_contents(\OC\Files\Filesystem::getLocalPath($imagepath)));
$itype = IMAGETYPE_PNG;
OC_Log::write('core','OC_Image->loadFromFile, Default', OC_Log::DEBUG);
break;
}
if($this->valid()) {
$this->imagetype = $itype;
$this->filepath = $imagepath;
}
return $this->resource;
2012-01-01 20:57:26 +04:00
}
/**
* @brief Loads an image from a string of data.
* @param $str A string of image data as read from a file.
* @returns An image resource or false on error
*/
public function loadFromData($str) {
2012-01-01 20:57:26 +04:00
if(is_resource($str)) {
return false;
}
2012-06-02 17:25:50 +04:00
$this->resource = @imagecreatefromstring($str);
if(!$this->resource) {
OC_Log::write('core','OC_Image->loadFromData, couldn\'t load', OC_Log::DEBUG);
2012-01-01 20:57:26 +04:00
return false;
}
return $this->resource;
2012-01-01 20:57:26 +04:00
}
/**
* @brief Loads an image from a base64 encoded string.
* @param $str A string base64 encoded string of image data.
* @returns An image resource or false on error
*/
public function loadFromBase64($str) {
2012-01-01 20:57:26 +04:00
if(!is_string($str)) {
return false;
}
$data = base64_decode($str);
if($data) { // try to load from string data
2012-06-02 17:25:50 +04:00
$this->resource = @imagecreatefromstring($data);
if(!$this->resource) {
OC_Log::write('core','OC_Image->loadFromBase64, couldn\'t load', OC_Log::DEBUG);
2012-01-01 20:57:26 +04:00
return false;
}
return $this->resource;
2012-01-01 20:57:26 +04:00
} else {
return false;
}
}
/**
* @brief Resizes the image preserving ratio.
* @param $maxsize The maximum size of either the width or height.
* @returns bool
*/
public function resize($maxsize) {
if(!$this->valid()) {
OC_Log::write('core',__METHOD__.'(): No image loaded', OC_Log::ERROR);
return false;
2012-01-01 20:57:26 +04:00
}
$width_orig=imageSX($this->resource);
$height_orig=imageSY($this->resource);
2012-01-01 20:57:26 +04:00
$ratio_orig = $width_orig/$height_orig;
2012-08-29 10:38:33 +04:00
2012-01-01 20:57:26 +04:00
if ($ratio_orig > 1) {
$new_height = round($maxsize/$ratio_orig);
$new_width = $maxsize;
} else {
$new_width = round($maxsize*$ratio_orig);
$new_height = $maxsize;
}
2012-09-09 01:26:19 +04:00
$this->preciseResize(round($new_width), round($new_height));
2012-01-01 20:57:26 +04:00
return true;
}
2012-06-02 17:25:50 +04:00
public function preciseResize($width, $height) {
if (!$this->valid()) {
OC_Log::write('core',__METHOD__.'(): No image loaded', OC_Log::ERROR);
2012-08-29 10:38:33 +04:00
return false;
2012-06-02 17:25:50 +04:00
}
$width_orig=imageSX($this->resource);
$height_orig=imageSY($this->resource);
$process = imagecreatetruecolor($width, $height);
if ($process == false) {
OC_Log::write('core',__METHOD__.'(): Error creating true color image',OC_Log::ERROR);
imagedestroy($process);
return false;
}
imagecopyresampled($process, $this->resource, 0, 0, 0, 0, $width, $height, $width_orig, $height_orig);
if ($process == false) {
OC_Log::write('core',__METHOD__.'(): Error resampling process image '.$width.'x'.$height,OC_Log::ERROR);
imagedestroy($process);
return false;
}
imagedestroy($this->resource);
$this->resource = $process;
return true;
}
2012-01-01 20:57:26 +04:00
/**
* @brief Crops the image to the middle square. If the image is already square it just returns.
* @param int maximum size for the result (optional)
2012-01-01 20:57:26 +04:00
* @returns bool for success or failure
*/
public function centerCrop($size=0) {
if(!$this->valid()) {
OC_Log::write('core','OC_Image->centerCrop, No image loaded', OC_Log::ERROR);
2012-01-01 20:57:26 +04:00
return false;
}
$width_orig=imageSX($this->resource);
$height_orig=imageSY($this->resource);
if($width_orig === $height_orig and $size==0) {
2012-01-01 20:57:26 +04:00
return true;
}
$ratio_orig = $width_orig/$height_orig;
$width = $height = min($width_orig, $height_orig);
if ($ratio_orig > 1) {
$x = ($width_orig/2) - ($width/2);
$y = 0;
} else {
$y = ($height_orig/2) - ($height/2);
$x = 0;
}
2012-09-07 17:22:01 +04:00
if($size>0) {
$targetWidth=$size;
$targetHeight=$size;
}else{
$targetWidth=$width;
$targetHeight=$height;
}
$process = imagecreatetruecolor($targetWidth, $targetHeight);
2012-01-01 20:57:26 +04:00
if ($process == false) {
OC_Log::write('core','OC_Image->centerCrop. Error creating true color image',OC_Log::ERROR);
2012-01-01 20:57:26 +04:00
imagedestroy($process);
return false;
}
imagecopyresampled($process, $this->resource, 0, 0, $x, $y, $targetWidth, $targetHeight, $width, $height);
2012-01-01 20:57:26 +04:00
if ($process == false) {
OC_Log::write('core','OC_Image->centerCrop. Error resampling process image '.$width.'x'.$height,OC_Log::ERROR);
2012-01-01 20:57:26 +04:00
imagedestroy($process);
return false;
}
2012-03-27 00:28:40 +04:00
imagedestroy($this->resource);
$this->resource = $process;
2012-01-01 20:57:26 +04:00
return true;
}
/**
* @brief Crops the image from point $x$y with dimension $wx$h.
* @param $x Horizontal position
* @param $y Vertical position
* @param $w Width
* @param $h Hight
* @returns bool for success or failure
*/
public function crop($x, $y, $w, $h) {
if(!$this->valid()) {
OC_Log::write('core',__METHOD__.'(): No image loaded', OC_Log::ERROR);
2012-01-01 20:57:26 +04:00
return false;
}
$process = imagecreatetruecolor($w, $h);
if ($process == false) {
OC_Log::write('core',__METHOD__.'(): Error creating true color image',OC_Log::ERROR);
2012-01-01 20:57:26 +04:00
imagedestroy($process);
return false;
}
imagecopyresampled($process, $this->resource, 0, 0, $x, $y, $w, $h, $w, $h);
2012-01-01 20:57:26 +04:00
if ($process == false) {
OC_Log::write('core',__METHOD__.'(): Error resampling process image '.$w.'x'.$h,OC_Log::ERROR);
2012-01-01 20:57:26 +04:00
imagedestroy($process);
return false;
}
2012-03-27 00:28:40 +04:00
imagedestroy($this->resource);
$this->resource = $process;
2012-01-01 20:57:26 +04:00
return true;
}
2012-03-27 00:28:40 +04:00
2012-09-09 01:26:19 +04:00
/**
* @brief Resizes the image to fit within a boundry while preserving ratio.
* @param $maxWidth
* @param $maxHeight
* @returns bool
*/
public function fitIn($maxWidth, $maxHeight) {
if(!$this->valid()) {
OC_Log::write('core',__METHOD__.'(): No image loaded', OC_Log::ERROR);
return false;
}
$width_orig=imageSX($this->resource);
$height_orig=imageSY($this->resource);
$ratio = $width_orig/$height_orig;
$newWidth = min($maxWidth, $ratio*$maxHeight);
$newHeight = min($maxHeight, $maxWidth/$ratio);
2012-10-14 23:04:08 +04:00
2012-09-09 01:26:19 +04:00
$this->preciseResize(round($newWidth), round($newHeight));
return true;
}
2012-09-07 17:22:01 +04:00
public function destroy() {
if($this->valid()) {
2012-03-27 00:28:40 +04:00
imagedestroy($this->resource);
}
$this->resource=null;
}
2012-09-07 17:22:01 +04:00
public function __destruct() {
$this->destroy();
2012-03-27 00:28:40 +04:00
}
2012-01-01 20:57:26 +04:00
}