<?php
/**
* @brief Image Class
* @author <a href='https://www.invisioncommunity.com'>Invision Power Services, Inc.</a>
* @copyright (c) Invision Power Services, Inc.
* @license https://www.invisioncommunity.com/legal/standards/
* @package Invision Community
* @since 19 Feb 2013
*/
namespace IPS;
/* To prevent PHP errors (extending class does not exist) revealing path */
if ( !\defined( '\IPS\SUITE_UNIQUE_KEY' ) )
{
header( ( isset( $_SERVER['SERVER_PROTOCOL'] ) ? $_SERVER['SERVER_PROTOCOL'] : 'HTTP/1.0' ) . ' 403 Forbidden' );
exit;
}
/**
* Image Class
*/
abstract class _Image
{
/**
* @brief Image Extensions
*/
public static $imageExtensions = array( 'gif', 'jpeg', 'jpe', 'jpg', 'png' );
/**
* @brief Image Mime Types
*/
public static $imageMimes = array( 'image/gif', 'image/jpeg', 'image/pjpeg', 'image/png', 'image/webp' );
/**
* @brief Allow EXIF processing
*/
public static $exifEnabled = TRUE;
/**
* Determine if EXIF extraction is supported
*
* @return bool
*/
public static function exifSupported()
{
return \function_exists( 'exif_read_data' ) and static::$exifEnabled;
}
/**
* @brief Has the image been automatically rotated?
*/
public $hasBeenRotated = FALSE;
/**
* Create Object
*
* @param string $contents Contents
* @param bool $checkRotation Check image to correct rotation
* @return \IPS\Image
* @throws \InvalidArgumentException
* @link https://en.wikipedia.org/wiki/List_of_file_signatures
*/
public static function create( string $contents, bool $checkRotation=TRUE )
{
/* Work out the type */
$imageType = NULL;
$isAnimated = FALSE;
$signatures = array(
'gif' => array(
'47' . '49' . '46' . '38' . '37' . '61',
'47' . '49' . '46' . '38' . '39' . '61'
),
'jpeg' => array(
'ff' . 'd8' . 'ff'
),
'png' => array(
'89' . '50' . '4e' . '47' . '0d' . '0a' . '1a' . '0a'
),
);
$bytesNeeded = max( array_merge( array_map( 'strlen', array_map( 'hex2bin', array_merge( $signatures['gif'], $signatures['jpeg'], $signatures['png'] ) ) ), array( 12 ) ) );
$fileHeader = \substr( $contents, 0, $bytesNeeded );
/* Try webp first since it's special: RIFF, 4 bytes for size, WEBP: */
if ( bin2hex( \substr( $fileHeader, 0, 4 ) ) === '52' . '49' . '46' . '46' AND bin2hex( \substr( $fileHeader, 8, 4 ) ) === '57' . '45' . '42' . '50' )
{
$imageType = 'webp';
}
/* If it's not webp, try the rest of the image types */
if( !$imageType )
{
foreach ( $signatures as $type => $_signatures )
{
foreach ( $_signatures as $signature )
{
if ( bin2hex( \substr( $fileHeader, 0, \strlen( hex2bin( $signature ) ) ) ) === $signature )
{
$imageType = $type;
break 2;
}
}
}
}
if ( $imageType === NULL )
{
throw new \InvalidArgumentException;
}
/* Create object */
if( \IPS\Settings::i()->image_suite == 'imagemagick' and class_exists( 'Imagick', FALSE ) )
{
$obj = new Image\Imagemagick( $contents );
}
else
{
$obj = new Image\Gd( $contents );
}
$obj->type = $imageType;
/* Animated? @see https://www.php.net/manual/en/function.imagecreatefromgif.php#102915 */
if ( $obj->type === 'gif' and (boolean) preg_match( '#\x00\x21\xF9\x04.{4}\x00(\x2C|\x21)#s', $contents ) )
{
$obj->isAnimatedGif = TRUE;
$obj->contents = $contents;
}
/* Set EXIF data immediately */
if( static::exifSupported() AND $checkRotation )
{
$obj->setExifData( $contents );
/* If the image is misoriented, attempt to automatically reorient */
$orientation = $obj->getImageOrientation();
/* Differences in orientation between GD and ImageMagick can cause auto-reorient to not work properly */
if ( !( $obj instanceof Image\Imagemagick ) )
{
switch ( $orientation )
{
case 3:
$obj->rotate( 180 );
$obj->hasBeenRotated = TRUE;
break;
case 6:
$obj->rotate( -90 );
$obj->hasBeenRotated = TRUE;
break;
case 8:
$obj->rotate( 90 );
$obj->hasBeenRotated = TRUE;
break;
}
}
else
{
switch( $orientation )
{
case 3:
$obj->rotate( 180 );
$obj->hasBeenRotated = TRUE;
break;
case 6:
$obj->rotate( 90 );
$obj->hasBeenRotated = TRUE;
break;
case 8:
$obj->rotate( -90 );
$obj->hasBeenRotated = TRUE;
break;
}
}
/* ImageMagick requires orientation be reset when rotated */
$obj->setImageOrientation( 1 );
}
/* Return */
return $obj;
}
/**
* @brief Type ('png', 'jpeg' or 'gif')
*/
public $type;
/**
* @brief Width
*/
public $width;
/**
* @brief Height
*/
public $height;
/**
* @brief Is this an animated gif?
*/
public $isAnimatedGif = FALSE;
/**
* @brief Contents of the image file when animated gif
*/
public $contents = NULL;
/**
* @brief EXIF data - has to be pulled and stored before GD manipulates image
*/
protected $exif = array();
/**
* Resize to maximum
*
* @param int|NULL $maxWidth Max Width (in pixels) or NULL
* @param int|NULL $maxHeight Max Height (in pixels) or NULL
* @param bool $retainRatio If TRUE, the image will keep it's current width/height ratio rather than being squashed
* @return bool Returns TRUE if it actually resized, or FALSE if it wasn't necessary
*/
public function resizeToMax( $maxWidth=NULL, $maxHeight=NULL, $retainRatio=TRUE )
{
/* If the image is smaller than max we can skip */
if( ( $maxWidth == NULL or $this->width < $maxWidth ) and ( $maxHeight == NULL or $this->height < $maxHeight ) )
{
return FALSE;
}
/* Work out the maximum width/height */
$width = ( $maxWidth !== NULL and $this->width > $maxWidth ) ? $maxWidth : $this->width;
$height = ( $maxHeight !== NULL and $this->height > $maxHeight ) ? $maxHeight : $this->height;
if ( $width != $this->width or $height != $this->height )
{
/* Adjust the width/height as necessary if we want to keep the ratio */
if ( $retainRatio === TRUE )
{
if ( ( $this->height - $height ) <= ( $this->width - $width ) )
{
$ratio = $this->height / $this->width;
$height = $width * $ratio;
}
else
{
$ratio = $this->width / $this->height;
$width = $height * $ratio;
}
}
/* And resize */
$this->resize( $width, $height );
return TRUE;
}
return FALSE;
}
/**
* Add Watermark
*
* @param \IPS\Image $watermark The watermark
* @return void
*/
public function watermark( \IPS\Image $watermark )
{
/* If it's too big, resize the watermark */
$watermark->resizeToMax( $this->width, $this->height );
/* Impose */
$this->impose( $watermark, $this->width - $watermark->width, $this->height - $watermark->height );
}
/**
* Parse file object to extract EXIF data
*
* @return array
* @throws \LogicException
*/
public function parseExif()
{
if( !static::exifSupported() )
{
throw new \LogicException( 'NO_EXIF' );
}
if( !\in_array( $this->type, array( 'jpeg', 'jpg', 'jpe' ) ) )
{
return array();
}
$result = array();
/* Read the data and store in an array */
if( $values = $this->getExifData() )
{
foreach( $values as $section => $data )
{
foreach( $data as $name => $value )
{
$result[ $section . '.' . $name ] = $value;
}
}
}
/* Return the EXIF data */
return $result;
}
/**
* Get EXIF data, if possible
*
* @return array
*/
public function getExifData()
{
return $this->exif;
}
/**
* Get EXIF data, if possible
*
* @param string $contents Image contents
* @return void
*/
public function setExifData( $contents )
{
if( !\in_array( $this->type, array( 'jpeg', 'jpg', 'jpe' ) ) )
{
return;
}
/* Exif requires a file on disk, so write it temporarily */
$temporary = tempnam( \IPS\TEMP_DIRECTORY, 'exif' );
\file_put_contents( $temporary, $contents );
$result = @exif_read_data( $temporary, NULL, TRUE );
/* Remove the temporary file */
if( @is_file( $temporary ) )
{
@unlink( $temporary );
}
$this->exif = $result;
}
/**
* Create a new blank canvas image
*
* @param int $width Width
* @param int $height Height
* @param array $rgb Color to use for bg
* @return \IPS\Image
*/
public static function newImageCanvas( $width, $height, $rgb )
{
if( \IPS\Settings::i()->image_suite == 'imagemagick' and class_exists( 'Imagick', FALSE ) )
{
return Image\Imagemagick::newImageCanvas( $width, $height, $rgb );
}
else
{
return Image\Gd::newImageCanvas( $width, $height, $rgb );
}
}
/**
* Write text on our image
*
* @param string $text Text
* @param string $font Path to font to use
* @param int $size Size of text
* @return void
*/
abstract public function write( $text, $font, $size );
/**
* Get Contents
*
* @return string
*/
abstract public function __toString();
/**
* Resize
*
* @param int $width Width (in pixels)
* @param int $height Height (in pixels)
* @return void
*/
abstract public function resize( $width, $height );
/**
* Crop to a given width and height (will attempt to downsize first)
*
* @param int $width Width (in pixels)
* @param int $height Height (in pixels)
* @return void
*/
abstract public function crop( $width, $height );
/**
* Crop at specific points
*
* @param int $point1X x-point for top-left corner
* @param int $point1Y y-point for top-left corner
* @param int $point2X x-point for bottom-right corner
* @param int $point2Y y-point for bottom-right corner
* @return void
*/
abstract public function cropToPoints( $point1X, $point1Y, $point2X, $point2Y );
/**
* Impose image
*
* @param \IPS\Image $image Image to impose
* @param int $x Location to impose to, x axis
* @param int $y Location to impose to, y axis
* @return void
*/
abstract public function impose( $image, $x=0, $y=0 );
/**
* Rotate image
*
* @param int $angle Angle of rotation
* @return void
*/
abstract public function rotate( $angle );
/**
* Get Image Orientation
*
* @return int|NULL
*/
abstract public function getImageOrientation();
/**
* Set Image Orientation
*
* @param int $orientation The orientation
* @return void
*/
abstract public function setImageOrientation( $orientation );
/**
* Can we write text reliably on an image?
*
* @return bool
*/
public static function canWriteText()
{
/* Create object */
if( \IPS\Settings::i()->image_suite == 'imagemagick' and class_exists( 'Imagick', FALSE ) )
{
return Image\Imagemagick::canWriteText();
}
else
{
return Image\Gd::canWriteText();
}
}
/**
* Return an array of supported extensions
*
* @return array
*/
public static function supportedExtensions()
{
if( \IPS\Settings::i()->image_suite == 'imagemagick' and class_exists( 'Imagick', FALSE ) )
{
return Image\Imagemagick::supportedExtensions();
}
else
{
return Image\Gd::supportedExtensions();
}
}
/**
* Is this a square image ( width == height )
*
* @return bool
*/
public function isSquare() : bool
{
return $this->width === $this->height;
}
}