Fix resource usages in OC_Image

This makes sure using resource or GdImage (PHP>=8) behaves the same. Signed-off-by: Côme Chilliet <come.chilliet@nextcloud.com>
violethaze74-jazzededtech · Oct 28, 2021 · 3631789 · 3631789
1 parent df4e6ba
commit 3631789
Show file tree

Hide file tree

Showing 7 changed files with 30 additions and 23 deletions.
diff --git a/lib/private/Avatar/UserAvatar.php b/lib/private/Avatar/UserAvatar.php
@@ -122,7 +122,7 @@ public function set($data) {
 	/**
 	 * Returns an image from several sources.
 	 *
-	 * @param IImage|resource|string $data An image object, imagedata or path to the avatar
+	 * @param IImage|resource|string|\GdImage $data An image object, imagedata or path to the avatar
 	 * @return IImage
 	 */
 	private function getAvatarImage($data) {
@@ -131,7 +131,10 @@ private function getAvatarImage($data) {
 		}
 
 		$img = new OC_Image();
-		if (is_resource($data) && get_resource_type($data) === 'gd') {
+		if (
+			(is_resource($data) && get_resource_type($data) === 'gd') ||
+			(is_object($data) && get_class($data) === \GdImage::class)
+			) {
 			$img->setResource($data);
 		} elseif (is_resource($data)) {
 			$img->loadFromFileHandle($data);

diff --git a/lib/private/Preview/Bitmap.php b/lib/private/Preview/Bitmap.php
@@ -60,7 +60,7 @@ public function getThumbnail(File $file, int $maxX, int $maxY): ?IImage {
 
 		//new bitmap image object
 		$image = new \OC_Image();
-		$image->loadFromData($bp);
+		$image->loadFromData((string) $bp);
 		//check if image object is valid
 		return $image->valid() ? $image : null;
 	}

diff --git a/lib/private/Preview/HEIC.php b/lib/private/Preview/HEIC.php
@@ -81,7 +81,7 @@ public function getThumbnail(File $file, int $maxX, int $maxY): ?IImage {
 
 		//new bitmap image object
 		$image = new \OC_Image();
-		$image->loadFromData($bp);
+		$image->loadFromData((string) $bp);
 		//check if image object is valid
 		return $image->valid() ? $image : null;
 	}

diff --git a/lib/private/Preview/SVG.php b/lib/private/Preview/SVG.php
@@ -69,7 +69,7 @@ public function getThumbnail(File $file, int $maxX, int $maxY): ?IImage {
 
 		//new image object
 		$image = new \OC_Image();
-		$image->loadFromData($svg);
+		$image->loadFromData((string) $svg);
 		//check if image object is valid
 		if ($image->valid()) {
 			$image->scaleDownToFit($maxX, $maxY);

diff --git a/lib/private/legacy/OC_Image.php b/lib/private/legacy/OC_Image.php
@@ -101,7 +101,7 @@ public function valid() { // apparently you can't name a method 'empty'...
 		if (is_resource($this->resource)) {
 			return true;
 		}
-		if (is_object($this->resource) && get_class($this->resource) === 'GdImage') {
+		if (is_object($this->resource) && get_class($this->resource) === \GdImage::class) {
 			return true;
 		}
 
@@ -308,7 +308,7 @@ public function __invoke() {
 	}
 
 	/**
-	 * @param resource Returns the image resource in any.
+	 * @param resource|\GdImage $resource
 	 * @throws \InvalidArgumentException in case the supplied resource does not have the type "gd"
 	 */
 	public function setResource($resource) {
@@ -318,15 +318,15 @@ public function setResource($resource) {
 			return;
 		}
 		// PHP 8 has real objects for GD stuff
-		if (is_object($resource) && get_class($resource) === 'GdImage') {
+		if (is_object($resource) && get_class($resource) === \GdImage::class) {
 			$this->resource = $resource;
 			return;
 		}
 		throw new \InvalidArgumentException('Supplied resource is not of type "gd".');
 	}
 
 	/**
-	 * @return resource Returns the image resource in any.
+	 * @return resource|\GdImage Returns the image resource in any.
 	 */
 	public function resource() {
 		return $this->resource;
@@ -536,7 +536,7 @@ public function fixOrientation() {
 	 * It is the responsibility of the caller to position the pointer at the correct place and to close the handle again.
 	 *
 	 * @param resource $handle
-	 * @return resource|false An image resource or false on error
+	 * @return resource|\GdImage|false An image resource or false on error
 	 */
 	public function loadFromFileHandle($handle) {
 		$contents = stream_get_contents($handle);
@@ -550,7 +550,7 @@ public function loadFromFileHandle($handle) {
 	 * Loads an image from a local file.
 	 *
 	 * @param bool|string $imagePath The path to a local file.
-	 * @return bool|resource An image resource or false on error
+	 * @return bool|resource|\GdImage An image resource or false on error
 	 */
 	public function loadFromFile($imagePath = false) {
 		// exif_imagetype throws "read error!" if file is less than 12 byte
@@ -666,17 +666,17 @@ public function loadFromFile($imagePath = false) {
 	 * Loads an image from a string of data.
 	 *
 	 * @param string $str A string of image data as read from a file.
-	 * @return bool|resource An image resource or false on error
+	 * @return bool|resource|\GdImage An image resource or false on error
 	 */
 	public function loadFromData($str) {
-		if (is_resource($str)) {
+		if (!is_string($str)) {
 			return false;
 		}
 		$this->resource = @imagecreatefromstring($str);
 		if ($this->fileInfo) {
 			$this->mimeType = $this->fileInfo->buffer($str);
 		}
-		if (is_resource($this->resource)) {
+		if ($this->valid()) {
 			imagealphablending($this->resource, false);
 			imagesavealpha($this->resource, true);
 		}
@@ -692,7 +692,7 @@ public function loadFromData($str) {
 	 * Loads an image from a base64 encoded string.
 	 *
 	 * @param string $str A string base64 encoded string of image data.
-	 * @return bool|resource An image resource or false on error
+	 * @return bool|resource|\GdImage An image resource or false on error
 	 */
 	public function loadFromBase64($str) {
 		if (!is_string($str)) {
@@ -722,7 +722,7 @@ public function loadFromBase64($str) {
 	 * @param string $fileName <p>
 	 * Path to the BMP image.
 	 * </p>
-	 * @return bool|resource an image resource identifier on success, <b>FALSE</b> on errors.
+	 * @return bool|resource|\GdImage an image resource identifier on success, <b>FALSE</b> on errors.
 	 */
 	private function imagecreatefrombmp($fileName) {
 		if (!($fh = fopen($fileName, 'rb'))) {
@@ -878,12 +878,12 @@ public function resize($maxSize) {
 		$result = $this->resizeNew($maxSize);
 		imagedestroy($this->resource);
 		$this->resource = $result;
-		return is_resource($result);
+		return $this->valid();
 	}
 
 	/**
 	 * @param $maxSize
-	 * @return resource | bool
+	 * @return resource|bool|\GdImage
 	 */
 	private function resizeNew($maxSize) {
 		if (!$this->valid()) {
@@ -914,14 +914,14 @@ public function preciseResize(int $width, int $height): bool {
 		$result = $this->preciseResizeNew($width, $height);
 		imagedestroy($this->resource);
 		$this->resource = $result;
-		return is_resource($result);
+		return $this->valid();
 	}
 
 
 	/**
 	 * @param int $width
 	 * @param int $height
-	 * @return resource | bool
+	 * @return resource|bool|\GdImage
 	 */
 	public function preciseResizeNew(int $width, int $height) {
 		if (!$this->valid()) {
@@ -1023,7 +1023,7 @@ public function crop(int $x, int $y, int $w, int $h): bool {
 		$result = $this->cropNew($x, $y, $w, $h);
 		imagedestroy($this->resource);
 		$this->resource = $result;
-		return is_resource($result);
+		return $this->valid();
 	}
 
 	/**
@@ -1181,7 +1181,7 @@ public function __destruct() {
 	 * @link http://www.programmierer-forum.de/imagebmp-gute-funktion-gefunden-t143716.htm
 	 * @author mgutt <marc@gutt.it>
 	 * @version 1.00
-	 * @param resource $im
+	 * @param resource|\GdImage $im
 	 * @param string $fileName [optional] <p>The path to save the file to.</p>
 	 * @param int $bit [optional] <p>Bit depth, (default is 24).</p>
 	 * @param int $compression [optional]

diff --git a/lib/public/IImage.php b/lib/public/IImage.php
@@ -98,7 +98,7 @@ public function show($mimeType = null);
 	public function save($filePath = null, $mimeType = null);
 
 	/**
-	 * @return resource Returns the image resource in any.
+	 * @return resource|\GdImage Returns the image resource in any.
 	 * @since 8.1.0
 	 */
 	public function resource();

diff --git a/psalm.xml b/psalm.xml
@@ -81,6 +81,8 @@
 			<errorLevel type="suppress">
 				<referencedClass name="OCA\GroupFolders\Mount\GroupFolderStorage"/>
 				<referencedClass name="OCA\TwoFactorNextcloudNotification\Controller\APIController"/>
+				<!-- Classes from PHP>=8 (needed to be able to use \GdImage::class) -->
+				<referencedClass name="GdImage" />
 			</errorLevel>
 		</UndefinedClass>
 		<UndefinedFunction>
@@ -124,6 +126,8 @@
 				<!-- Helper classes for sharing API integration from other apps -->
 				<referencedClass name="OCA\Deck\Sharing\ShareAPIHelper" />
 				<referencedClass name="OCA\Talk\Share\Helper\DeletedShareAPIController" />
+				<!-- Classes from PHP>=8 -->
+				<referencedClass name="GdImage" />
 			</errorLevel>
 		</UndefinedDocblockClass>
 	</issueHandlers>