Drawing::getMediaFilename() - Code Metrics - Inspection of "Restore 2 Disabled Tests" - PHPOffice/PhpSpreadsheet - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#4170)

by Owen

created 2024-09-25 00:28 UTC

Drawing::getMediaFilename() A

↳ Parent: Drawing

Complexity

Conditions	2
Paths	2

Size

Total Lines	7
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	2

Importance

Changes

Metric	Value
cc	2
eloc	3
nc	2
nop	0
dl	0
loc	7
ccs	4
cts	4
cp	1
crap	2
rs	10
c	0
b	0
f	0

<?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)) {
            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
            if (str_starts_with($path, 'https:')) {
                $ctx = stream_context_create(['ssl' => ['crypto_method' => STREAM_CRYPTO_METHOD_TLSv1_3_CLIENT]]);
            }
            $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!");
        }

        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;
    }

    /**
     * Set isURL.
     *
     * @return $this
     */
    public function setIsURL(bool $isUrl): self
    {
        $this->isUrl = $isUrl;

        return $this;
    }

    /**
     * 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	183	public function __construct()
31		{
32		// Initialise values
33	183	$this->path = '';
34	183	$this->isUrl = false;
35
36		// Initialize parent
37	183	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	39	public function getIndexedFilename(): string
52		{
53	39	return md5($this->path) . '.' . $this->getExtension();
54		}
55
56		/**
57		* Get Extension.
58		*/
59	39	public function getExtension(): string
60		{
61	39	$exploded = explode('.', basename($this->path));
62
63	39	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	108	public function getPath(): string
82		{
83	108	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	95	public function setPath(string $path, bool $verifyFile = true, ?ZipArchive $zip = null): static
96		{
97	95	$this->isUrl = false;
98	95	if (preg_match('~^data:image/[a-z]+;base64,~', $path) === 1) {
99	4	$this->path = $path;
100
101	4	return $this;
102		}
103
104	93	$this->path = '';
105		// Check if a URL has been passed. https://stackoverflow.com/a/2058596/1252979
106	93	if (filter_var($path, FILTER_VALIDATE_URL)) {
107	3	if (!preg_match('/^(http\|https\|file\|ftp\|s3):/', $path)) {
108	1	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	2	$this->isUrl = true;
112	2	$ctx = null;
113		// https://github.com/php/php-src/issues/16023
114	2	if (str_starts_with($path, 'https:')) {
115	2	$ctx = stream_context_create(['ssl' => ['crypto_method' => STREAM_CRYPTO_METHOD_TLSv1_3_CLIENT]]);
116		}
117	2	$imageContents = @file_get_contents($path, false, $ctx);
118	2	if ($imageContents !== false) {
119	1	$filePath = tempnam(sys_get_temp_dir(), 'Drawing');
120	1	if ($filePath) {
121	1	$put = @file_put_contents($filePath, $imageContents);
122	1	if ($put !== false) {
123	1	if ($this->isImage($filePath)) {
124	1	$this->path = $path;
125	1	$this->setSizesAndType($filePath);
126		}
127	1	unlink($filePath);
128		}
129		}
130		}
131	90	} elseif ($zip instanceof ZipArchive) {
132	58	$zipPath = explode('#', $path)[1];
133	58	$locate = @$zip->locateName($zipPath);
134	58	if ($locate !== false) {
135	58	if ($this->isImage($path)) {
136	58	$this->path = $path;
137	58	$this->setSizesAndType($path);
138		}
139		}
140		} else {
141	44	$exists = @file_exists($path);
142	44	if ($exists !== false && $this->isImage($path)) {
143	42	$this->path = $path;
144	42	$this->setSizesAndType($path);
145		}
146		}
147	92	if ($this->path === '' && $verifyFile) {
148	1	throw new PhpSpreadsheetException("File $path not found!");
149		}
150
151	91	return $this;
152		}
153
154	89	private function isImage(string $path): bool
155		{
156	89	$mime = (string) @mime_content_type($path);
157	89	$retVal = false;
158	89	if (str_starts_with($mime, 'image/')) {
159	88	$retVal = true;
160	3	} elseif ($mime === 'application/octet-stream') {
161	2	$extension = pathinfo($path, PATHINFO_EXTENSION);
162	2	$retVal = in_array($extension, ['bin', 'emf'], true);
163		}
164
165	89	return $retVal;
166		}
167
168		/**
169		* Get isURL.
170		*/
171	38	public function getIsURL(): bool
172		{
173	38	return $this->isUrl;
174		}
175
176		/**
177		* Set isURL.
178		*
179		* @return $this
180		*/
181		public function setIsURL(bool $isUrl): self
182		{
183		$this->isUrl = $isUrl;
184
185		return $this;
186		}
187
188		/**
189		* Get hash code.
190		*
191		* @return string Hash code
192		*/
193	37	public function getHashCode(): string
194		{
195	37	return md5(
196	37	$this->path
197	37	. parent::getHashCode()
198	37	. __CLASS__
199	37	);
200		}
201
202		/**
203		* Get Image Type for Save.
204		*/
205	1	public function getImageTypeForSave(): int
206		{
207	1	if (!array_key_exists($this->type, self::IMAGE_TYPES_CONVERTION_MAP)) {
208	1	throw new PhpSpreadsheetException('Unsupported image type in comment background. Supported types: PNG, JPEG, BMP, GIF.');
209		}
210
211	1	return self::IMAGE_TYPES_CONVERTION_MAP[$this->type];
212		}
213
214		/**
215		* Get Image file extention for Save.
216		*/
217	3	public function getImageFileExtensionForSave(bool $includeDot = true): string
218		{
219	3	if (!array_key_exists($this->type, self::IMAGE_TYPES_CONVERTION_MAP)) {
220	1	throw new PhpSpreadsheetException('Unsupported image type in comment background. Supported types: PNG, JPEG, BMP, GIF.');
221		}
222
223	3	$result = image_type_to_extension(self::IMAGE_TYPES_CONVERTION_MAP[$this->type], $includeDot);
224
225	3	return "$result";
226		}
227
228		/**
229		* Get Image mime type.
230		*/
231	3	public function getImageMimeType(): string
232		{
233	3	if (!array_key_exists($this->type, self::IMAGE_TYPES_CONVERTION_MAP)) {
234	1	throw new PhpSpreadsheetException('Unsupported image type in comment background. Supported types: PNG, JPEG, BMP, GIF.');
235		}
236
237	3	return image_type_to_mime_type(self::IMAGE_TYPES_CONVERTION_MAP[$this->type]);
238		}
239		}
240

PHPOffice / PhpSpreadsheet

Pull Request — master (#4170)

Drawing::getMediaFilename() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like