Drawing::isImage() - Code Metrics - Inspection of "Make Explicit Array Return Type When Tests Require..." - PHPOffice/PhpSpreadsheet - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions

Pull Request — master (#4328)

by Owen

created 2025-02-07 06:52 UTC

Drawing::isImage() A

↳ Parent: Drawing

Complexity

Conditions	3
Paths	3

Size

Total Lines	12
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	9
CRAP Score	3

Importance

Changes

Metric	Value
eloc	8
dl	0
loc	12
ccs	9
cts	9
cp	1
rs	10
c	0
b	0
f	0
cc	3
nc	3
nop	1
crap	3

<?php

namespace PhpOffice\PhpSpreadsheet\Worksheet;

use PhpOffice\PhpSpreadsheet\Exception as PhpSpreadsheetException;
use ZipArchive;

class Drawing extends BaseDrawing
{
    const IMAGE_TYPES_CONVERTION_MAP = [
        IMAGETYPE_GIF => IMAGETYPE_PNG,
        IMAGETYPE_JPEG => IMAGETYPE_JPEG,
        IMAGETYPE_PNG => IMAGETYPE_PNG,
        IMAGETYPE_BMP => IMAGETYPE_PNG,
    ];

    /**
     * Path.
     */
    private string $path;

    /**
     * Whether or not we are dealing with a URL.
     */
    private bool $isUrl;

    /**
     * Create a new Drawing.
     */
    public function __construct()
    {
        // Initialise values
        $this->path = '';
        $this->isUrl = false;

        // Initialize parent
        parent::__construct();
    }

    /**
     * Get Filename.
     */
    public function getFilename(): string
    {
        return basename($this->path);
    }

    /**
     * Get indexed filename (using image index).
     */
    public function getIndexedFilename(): string
    {
        return md5($this->path) . '.' . $this->getExtension();
    }

    /**
     * Get Extension.
     */
    public function getExtension(): string
    {
        $exploded = explode('.', basename($this->path));

        return $exploded[count($exploded) - 1];
    }

    /**
     * Get full filepath to store drawing in zip archive.
     */
    public function getMediaFilename(): string
    {
        if (!array_key_exists($this->type, self::IMAGE_TYPES_CONVERTION_MAP)) {
            throw new PhpSpreadsheetException('Unsupported image type in comment background. Supported types: PNG, JPEG, BMP, GIF.');
        }

        return sprintf('image%d%s', $this->getImageIndex(), $this->getImageFileExtensionForSave());
    }

    /**
     * Get Path.
     */
    public function getPath(): string
    {
        return $this->path;
    }

    /**
     * Set Path.
     *
     * @param string $path File path
     * @param bool $verifyFile Verify file
     * @param ?ZipArchive $zip Zip archive instance
     *
     * @return $this
     */
    public function setPath(string $path, bool $verifyFile = true, ?ZipArchive $zip = null): static
    {
        $this->isUrl = false;
        if (preg_match('~^data:image/[a-z]+;base64,~', $path) === 1) {
            $this->path = $path;

            return $this;
        }

        $this->path = '';
        // Check if a URL has been passed. https://stackoverflow.com/a/2058596/1252979
        if (filter_var($path, FILTER_VALIDATE_URL) || (preg_match('/^([\\w\\s\\x00-\\x1f]+):/u', $path) && !preg_match('/^([\\w]+):/u', $path))) {
            if (!preg_match('/^(http|https|file|ftp|s3):/', $path)) {
                throw new PhpSpreadsheetException('Invalid protocol for linked drawing');
            }
            // Implicit that it is a URL, rather store info than running check above on value in other places.
            $this->isUrl = true;
            $ctx = null;
            // https://github.com/php/php-src/issues/16023
            // https://github.com/php/php-src/issues/17121
            if (str_starts_with($path, 'https:') || str_starts_with($path, 'http:')) {
                $ctxArray = [
                    'http' => [
                        'user_agent' => 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/131.0.0.0 Safari/537.36',
                        'header' => [
                            //'Connection: keep-alive', // unacceptable performance
                            'Accept: image/*;q=0.9,*/*;q=0.8',
                        ],
                    ],
                ];
                if (str_starts_with($path, 'https:')) {
                    $ctxArray['ssl'] = ['crypto_method' => STREAM_CRYPTO_METHOD_TLSv1_3_CLIENT];
                }
                $ctx = stream_context_create($ctxArray);
            }
            $imageContents = @file_get_contents($path, false, $ctx);
            if ($imageContents !== false) {
                $filePath = tempnam(sys_get_temp_dir(), 'Drawing');
                if ($filePath) {
                    $put = @file_put_contents($filePath, $imageContents);
                    if ($put !== false) {
                        if ($this->isImage($filePath)) {
                            $this->path = $path;
                            $this->setSizesAndType($filePath);
                        }
                        unlink($filePath);
                    }
                }
            }
        } elseif ($zip instanceof ZipArchive) {
            $zipPath = explode('#', $path)[1];
            $locate = @$zip->locateName($zipPath);
            if ($locate !== false) {
                if ($this->isImage($path)) {
                    $this->path = $path;
                    $this->setSizesAndType($path);
                }
            }
        } else {
            $exists = @file_exists($path);
            if ($exists !== false && $this->isImage($path)) {
                $this->path = $path;
                $this->setSizesAndType($path);
            }
        }
        if ($this->path === '' && $verifyFile) {
            throw new PhpSpreadsheetException("File $path not found!");
        }

        if ($this->worksheet !== null) {
            if ($this->path !== '') {
                $this->worksheet->getCell($this->coordinates);
            }
        }

        return $this;
    }

    private function isImage(string $path): bool
    {
        $mime = (string) @mime_content_type($path);
        $retVal = false;
        if (str_starts_with($mime, 'image/')) {
            $retVal = true;
        } elseif ($mime === 'application/octet-stream') {
            $extension = pathinfo($path, PATHINFO_EXTENSION);
            $retVal = in_array($extension, ['bin', 'emf'], true);
        }

        return $retVal;
    }

    /**
     * Get isURL.
     */
    public function getIsURL(): bool
    {
        return $this->isUrl;
    }

    /**
     * Get hash code.
     *
     * @return string Hash code
     */
    public function getHashCode(): string
    {
        return md5(
            $this->path
            . parent::getHashCode()
            . __CLASS__
        );
    }

    /**
     * Get Image Type for Save.
     */
    public function getImageTypeForSave(): int
    {
        if (!array_key_exists($this->type, self::IMAGE_TYPES_CONVERTION_MAP)) {
            throw new PhpSpreadsheetException('Unsupported image type in comment background. Supported types: PNG, JPEG, BMP, GIF.');
        }

        return self::IMAGE_TYPES_CONVERTION_MAP[$this->type];
    }

    /**
     * Get Image file extention for Save.
     */
    public function getImageFileExtensionForSave(bool $includeDot = true): string
    {
        if (!array_key_exists($this->type, self::IMAGE_TYPES_CONVERTION_MAP)) {
            throw new PhpSpreadsheetException('Unsupported image type in comment background. Supported types: PNG, JPEG, BMP, GIF.');
        }

        $result = image_type_to_extension(self::IMAGE_TYPES_CONVERTION_MAP[$this->type], $includeDot);

        return "$result";
    }

    /**
     * Get Image mime type.
     */
    public function getImageMimeType(): string
    {
        if (!array_key_exists($this->type, self::IMAGE_TYPES_CONVERTION_MAP)) {
            throw new PhpSpreadsheetException('Unsupported image type in comment background. Supported types: PNG, JPEG, BMP, GIF.');
        }

        return image_type_to_mime_type(self::IMAGE_TYPES_CONVERTION_MAP[$this->type]);
    }
}


1		<?php
2
3		namespace PhpOffice\PhpSpreadsheet\Worksheet;
4
5		use PhpOffice\PhpSpreadsheet\Exception as PhpSpreadsheetException;
6		use ZipArchive;
7
8		class Drawing extends BaseDrawing
9		{
10		const IMAGE_TYPES_CONVERTION_MAP = [
11		IMAGETYPE_GIF => IMAGETYPE_PNG,
12		IMAGETYPE_JPEG => IMAGETYPE_JPEG,
13		IMAGETYPE_PNG => IMAGETYPE_PNG,
14		IMAGETYPE_BMP => IMAGETYPE_PNG,
15		];
16
17		/**
18		* Path.
19		*/
20		private string $path;
21
22		/**
23		* Whether or not we are dealing with a URL.
24		*/
25		private bool $isUrl;
26
27		/**
28		* Create a new Drawing.
29		*/
30	204	public function __construct()
31		{
32		// Initialise values
33	204	$this->path = '';
34	204	$this->isUrl = false;
35
36		// Initialize parent
37	204	parent::__construct();
38		}
39
40		/**
41		* Get Filename.
42		*/
43	1	public function getFilename(): string
44		{
45	1	return basename($this->path);
46		}
47
48		/**
49		* Get indexed filename (using image index).
50		*/
51	45	public function getIndexedFilename(): string
52		{
53	45	return md5($this->path) . '.' . $this->getExtension();
54		}
55
56		/**
57		* Get Extension.
58		*/
59	45	public function getExtension(): string
60		{
61	45	$exploded = explode('.', basename($this->path));
62
63	45	return $exploded[count($exploded) - 1];
64		}
65
66		/**
67		* Get full filepath to store drawing in zip archive.
68		*/
69	3	public function getMediaFilename(): string
70		{
71	3	if (!array_key_exists($this->type, self::IMAGE_TYPES_CONVERTION_MAP)) {
72	1	throw new PhpSpreadsheetException('Unsupported image type in comment background. Supported types: PNG, JPEG, BMP, GIF.');
73		}
74
75	3	return sprintf('image%d%s', $this->getImageIndex(), $this->getImageFileExtensionForSave());
76		}
77
78		/**
79		* Get Path.
80		*/
81	121	public function getPath(): string
82		{
83	121	return $this->path;
84		}
85
86		/**
87		* Set Path.
88		*
89		* @param string $path File path
90		* @param bool $verifyFile Verify file
91		* @param ?ZipArchive $zip Zip archive instance
92		*
93		* @return $this
94		*/
95	114	public function setPath(string $path, bool $verifyFile = true, ?ZipArchive $zip = null): static
96		{
97	114	$this->isUrl = false;
98	114	if (preg_match('~^data:image/[a-z]+;base64,~', $path) === 1) {
99	4	$this->path = $path;
100
101	4	return $this;
102		}
103
104	112	$this->path = '';
105		// Check if a URL has been passed. https://stackoverflow.com/a/2058596/1252979
106	112	if (filter_var($path, FILTER_VALIDATE_URL) \|\| (preg_match('/^([\\w\\s\\x00-\\x1f]+):/u', $path) && !preg_match('/^([\\w]+):/u', $path))) {
107	12	if (!preg_match('/^(http\|https\|file\|ftp\|s3):/', $path)) {
108	8	throw new PhpSpreadsheetException('Invalid protocol for linked drawing');
109		}
110		// Implicit that it is a URL, rather store info than running check above on value in other places.
111	4	$this->isUrl = true;
112	4	$ctx = null;
113		// https://github.com/php/php-src/issues/16023
114		// https://github.com/php/php-src/issues/17121
115	4	if (str_starts_with($path, 'https:') \|\| str_starts_with($path, 'http:')) {
116	4	$ctxArray = [
117	4	'http' => [
118	4	'user_agent' => 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/131.0.0.0 Safari/537.36',
119	4	'header' => [
120		//'Connection: keep-alive', // unacceptable performance
121	4	'Accept: image/;q=0.9,/*;q=0.8',
122	4	],
123	4	],
124	4	];
125	4	if (str_starts_with($path, 'https:')) {
126	4	$ctxArray['ssl'] = ['crypto_method' => STREAM_CRYPTO_METHOD_TLSv1_3_CLIENT];
127		}
128	4	$ctx = stream_context_create($ctxArray);
129		}
130	4	$imageContents = @file_get_contents($path, false, $ctx);
131	4	if ($imageContents !== false) {
132	2	$filePath = tempnam(sys_get_temp_dir(), 'Drawing');
133	2	if ($filePath) {
134	2	$put = @file_put_contents($filePath, $imageContents);
135	2	if ($put !== false) {
136	2	if ($this->isImage($filePath)) {
137	2	$this->path = $path;
138	2	$this->setSizesAndType($filePath);
139		}
140	2	unlink($filePath);
141		}
142		}
143		}
144	100	} elseif ($zip instanceof ZipArchive) {
145	62	$zipPath = explode('#', $path)[1];
146	62	$locate = @$zip->locateName($zipPath);
147	62	if ($locate !== false) {
148	62	if ($this->isImage($path)) {
149	62	$this->path = $path;
150	62	$this->setSizesAndType($path);
151		}
152		}
153		} else {
154	52	$exists = @file_exists($path);
155	52	if ($exists !== false && $this->isImage($path)) {
156	50	$this->path = $path;
157	50	$this->setSizesAndType($path);
158		}
159		}
160	104	if ($this->path === '' && $verifyFile) {
161	1	throw new PhpSpreadsheetException("File $path not found!");
162		}
163
164	103	if ($this->worksheet !== null) {
165	2	if ($this->path !== '') {
166	2	$this->worksheet->getCell($this->coordinates);
167		}
168		}
169
170	103	return $this;
171		}
172
173	100	private function isImage(string $path): bool
174		{
175	100	$mime = (string) @mime_content_type($path);
176	100	$retVal = false;
177	100	if (str_starts_with($mime, 'image/')) {
178	99	$retVal = true;
179	3	} elseif ($mime === 'application/octet-stream') {
180	2	$extension = pathinfo($path, PATHINFO_EXTENSION);
181	2	$retVal = in_array($extension, ['bin', 'emf'], true);
182		}
183
184	100	return $retVal;
185		}
186
187		/**
188		* Get isURL.
189		*/
190	44	public function getIsURL(): bool
191		{
192	44	return $this->isUrl;
193		}
194
195		/**
196		* Get hash code.
197		*
198		* @return string Hash code
199		*/
200	43	public function getHashCode(): string
201		{
202	43	return md5(
203	43	$this->path
204	43	. parent::getHashCode()
205	43	. __CLASS__
206	43	);
207		}
208
209		/**
210		* Get Image Type for Save.
211		*/
212	1	public function getImageTypeForSave(): int
213		{
214	1	if (!array_key_exists($this->type, self::IMAGE_TYPES_CONVERTION_MAP)) {
215	1	throw new PhpSpreadsheetException('Unsupported image type in comment background. Supported types: PNG, JPEG, BMP, GIF.');
216		}
217
218	1	return self::IMAGE_TYPES_CONVERTION_MAP[$this->type];
219		}
220
221		/**
222		* Get Image file extention for Save.
223		*/
224	3	public function getImageFileExtensionForSave(bool $includeDot = true): string
225		{
226	3	if (!array_key_exists($this->type, self::IMAGE_TYPES_CONVERTION_MAP)) {
227	1	throw new PhpSpreadsheetException('Unsupported image type in comment background. Supported types: PNG, JPEG, BMP, GIF.');
228		}
229
230	3	$result = image_type_to_extension(self::IMAGE_TYPES_CONVERTION_MAP[$this->type], $includeDot);
231
232	3	return "$result";
233		}
234
235		/**
236		* Get Image mime type.
237		*/
238	3	public function getImageMimeType(): string
239		{
240	3	if (!array_key_exists($this->type, self::IMAGE_TYPES_CONVERTION_MAP)) {
241	1	throw new PhpSpreadsheetException('Unsupported image type in comment background. Supported types: PNG, JPEG, BMP, GIF.');
242		}
243
244	3	return image_type_to_mime_type(self::IMAGE_TYPES_CONVERTION_MAP[$this->type]);
245		}
246		}
247

PHPOffice / PhpSpreadsheet

Pull Request — master (#4328)

Drawing::isImage() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like