FilesystemStorage::exists() - Code Metrics - yaroslawww/laravel-geonames - Measure and Improve Code Quality continuously with Scrutinizer

FilesystemStorage::exists() A
last analyzed 2022-01-01 09:03 UTC

↳ Parent: FilesystemStorage

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

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

<?php

namespace LaraGeoData\Storage;

use Exception;
use Illuminate\Filesystem\Filesystem;
use Illuminate\Support\Str;
use Symfony\Component\Process\Process;
use ZipArchive;

/**
 * Stores collected data into files
 */
class FilesystemStorage
{

    /**
     * Provider.
     *
     * @var Filesystem
     */
    protected Filesystem $files;

    /**
     * Directory name.
     *
     * @var string
     */
    protected string $dirname;

    /**
     * @param Filesystem $files
     * @param string $dirname
     */
    public function __construct(Filesystem $files, string $dirname)
    {
        $this->files   = $files;
        $this->dirname = rtrim($dirname, DIRECTORY_SEPARATOR) . DIRECTORY_SEPARATOR;
    }

    /**
     * Create directory if not exists.
     *
     * @throws Exception
     */
    public function prepareDirectory(): void
    {
        if (!$this->files->isDirectory($this->dirname)) {
            if ($this->files->makeDirectory($this->dirname, 0777, true)) {
                $this->files->put($this->dirname . '.gitignore', "*\n!.gitignore\n");
            } else {
                throw new Exception("Cannot create directory '$this->dirname'.");
            }
        }
    }

    /**
     * Clear all stored files.
     *
     * @return bool
     * @throws Exception
     */
    public function truncate(): bool
    {
        $result = $this->files->deleteDirectory($this->dirname);
        $this->prepareDirectory();

        return $result;
    }

    /**
     * CheckIf File exists.
     *
     * @param string $filePath
     *
     * @return bool
     */
    public function exists(string $filePath): bool
    {
        return $this->files->exists($this->path($filePath));
    }

    /**
     * Get absolute file path.
     *
     * @param string $filePath
     *
     * @return string
     */
    public function path(string $filePath = ''): string
    {
        return $this->dirname . ltrim($filePath, DIRECTORY_SEPARATOR);
    }

    /**
     * Delete file.
     *
     * @param string $filePath
     *
     * @return bool
     */
    public function delete(string $filePath): bool
    {
        return $this->files->delete($this->path($filePath));
    }

    /**
     * Get valid file path.
     *
     * @param string|null $filePath
     * @param string $url
     *
     * @return string
     */
    protected function validFilePathFromUrl(?string $filePath,  string $url): string
    {
        if (!$filePath) {
            $filePath = Str::afterLast($url, DIRECTORY_SEPARATOR);
        }

        return (string) $filePath;
    }

    /**
     * @param string $url
     * @param string|null $filePath
     * @param \Closure|null $progressCallback
     * @param bool $force
     *
     * @return bool
     * @throws Exception
     */
    public function createFromUrl(string $url, ?string $filePath = null, ?\Closure $progressCallback = null, bool $force = false): bool
    {
        $this->prepareDirectory();

        $filePath = $this->validFilePathFromUrl($filePath, $url);

        if (($exists = $this->exists($filePath)) && !$force) {
            return false;
        }

        if ($exists) {
            $this->delete($filePath);
        }

        $path = $this->path($filePath);

        $this->files->ensureDirectoryExists(Str::beforeLast($path, DIRECTORY_SEPARATOR), 0777, true);

        return match (config('geonames.storage.download_provider')) {
            'curl_php' => $this->downloadViaCurlPhp($url, $path, $progressCallback),
            'wget'     => $this->downloadViaWget($url, $path),
            default    => throw new Exception('Current download provider not supported'),
        };
    }

    /**
     * Extract zip file.
     *
     * @param string $file
     *
     * @return bool
     * @throws Exception
     */
    public function extractZipFile(string $file): bool
    {
        $zipArchive = new ZipArchive();
        $filePath   = $this->path($file);
        if (true === ($openResult = $zipArchive->open($filePath, ZipArchive::RDONLY))) {
            $extractTo     = Str::beforeLast($filePath, DIRECTORY_SEPARATOR) . DIRECTORY_SEPARATOR;
            $extractResult = $zipArchive->extractTo($extractTo);
            $zipArchive->close();
            if ($extractResult === true) {
                return true;
            }
        }

        if (is_numeric($openResult)) {
            throw new Exception("Zip open [{$filePath}] error: {$openResult}. See: https://php.net/manual/en/zip.constants.php");
        }

        return false;
    }

    /**
     * Download File using wget util.
     *
     * @param string $url
     * @param string $path
     *
     * @return bool
     */
    protected function downloadViaWget(string $url, string $path): bool
    {
        $process = new Process([
            'wget',
            //'-c',
            '-N',
            '-O',
            $path,
            $url,
        ]);
        $process->run();

        return $process->isSuccessful();
    }

    /**
     * Download File using wget util.
     *
     * @param string $url
     * @param string $path
     *
     * @return bool
     * @throws Exception
     */
    protected function downloadViaCurlPhp(string $url, string $path, ?\Closure $progressCallback = null): bool
    {
        $fp = fopen($path, 'w');
        $ch = curl_init($url);
        if ($progressCallback) {
            curl_setopt($ch, CURLOPT_PROGRESSFUNCTION, $progressCallback);
            curl_setopt($ch, CURLOPT_NOPROGRESS, false);
        }
        curl_setopt($ch, CURLOPT_FILE, $fp);

        $result = curl_exec($ch);

        if ($errorNumber = curl_errno($ch)) {
            throw new Exception("Error [{$errorNumber}]. See https://php.net/manual/en/function.curl-errno.php");
        }

        curl_close($ch);
        fclose($fp);

        return (bool) $result;
    }
}


1		<?php
2
3		namespace LaraGeoData\Storage;
4
5		use Exception;
6		use Illuminate\Filesystem\Filesystem;
7		use Illuminate\Support\Str;
8		use Symfony\Component\Process\Process;
9		use ZipArchive;
10
11		/**
12		* Stores collected data into files
13		*/
14		class FilesystemStorage
15		{
16
17		/**
18		* Provider.
19		*
20		* @var Filesystem
21		*/
22		protected Filesystem $files;
23
24		/**
25		* Directory name.
26		*
27		* @var string
28		*/
29		protected string $dirname;
30
31		/**
32		* @param Filesystem $files
33		* @param string $dirname
34		*/
35	20	public function __construct(Filesystem $files, string $dirname)
36		{
37	20	$this->files = $files;
38	20	$this->dirname = rtrim($dirname, DIRECTORY_SEPARATOR) . DIRECTORY_SEPARATOR;
39	20	}
40
41		/**
42		* Create directory if not exists.
43		*
44		* @throws Exception
45		*/
46	13	public function prepareDirectory(): void
47		{
48	13	if (!$this->files->isDirectory($this->dirname)) {
49	9	if ($this->files->makeDirectory($this->dirname, 0777, true)) {
50	8	$this->files->put($this->dirname . '.gitignore', "*\n!.gitignore\n");
51		} else {
52		throw new Exception("Cannot create directory '$this->dirname'.");
53		}
54		}
55	12	}
56
57		/**
58		* Clear all stored files.
59		*
60		* @return bool
61		* @throws Exception
62		*/
63	6	public function truncate(): bool
64		{
65	6	$result = $this->files->deleteDirectory($this->dirname);
66	6	$this->prepareDirectory();
67
68	6	return $result;
69		}
70
71		/**
72		* CheckIf File exists.
73		*
74		* @param string $filePath
75		*
76		* @return bool
77		*/
78	10	public function exists(string $filePath): bool
79		{
80	10	return $this->files->exists($this->path($filePath));
81		}
82
83		/**
84		* Get absolute file path.
85		*
86		* @param string $filePath
87		*
88		* @return string
89		*/
90	16	public function path(string $filePath = ''): string
91		{
92	16	return $this->dirname . ltrim($filePath, DIRECTORY_SEPARATOR);
93		}
94
95		/**
96		* Delete file.
97		*
98		* @param string $filePath
99		*
100		* @return bool
101		*/
102	1	public function delete(string $filePath): bool
103		{
104	1	return $this->files->delete($this->path($filePath));
105		}
106
107		/**
108		* Get valid file path.
109		*
110		* @param string\|null $filePath
111		* @param string $url
112		*
113		* @return string
114		*/
115	10	protected function validFilePathFromUrl(?string $filePath, string $url): string
116		{
117	10	if (!$filePath) {
118	2	$filePath = Str::afterLast($url, DIRECTORY_SEPARATOR);
119		}
120
121	10	return (string) $filePath;
122		}
123
124		/**
125		* @param string $url
126		* @param string\|null $filePath
127		* @param \Closure\|null $progressCallback
128		* @param bool $force
129		*
130		* @return bool
131		* @throws Exception
132		*/
133	10	public function createFromUrl(string $url, ?string $filePath = null, ?\Closure $progressCallback = null, bool $force = false): bool
134		{
135	10	$this->prepareDirectory();
136
137	10	$filePath = $this->validFilePathFromUrl($filePath, $url);
138
139	10	if (($exists = $this->exists($filePath)) && !$force) {
140	2	return false;
141		}
142
143	9	if ($exists) {
144	1	$this->delete($filePath);
145		}
146
147	9	$path = $this->path($filePath);
148
149	9	$this->files->ensureDirectoryExists(Str::beforeLast($path, DIRECTORY_SEPARATOR), 0777, true);
150
151	9	return match (config('geonames.storage.download_provider')) {
152	1	'curl_php' => $this->downloadViaCurlPhp($url, $path, $progressCallback),
153	7	'wget' => $this->downloadViaWget($url, $path),
154	9	default => throw new Exception('Current download provider not supported'),
155		};
156		}
157
158		/**
159		* Extract zip file.
160		*
161		* @param string $file
162		*
163		* @return bool
164		* @throws Exception
165		*/
166	6	public function extractZipFile(string $file): bool
167		{
168	6	$zipArchive = new ZipArchive();
169	6	$filePath = $this->path($file);
170	6	if (true === ($openResult = $zipArchive->open($filePath, ZipArchive::RDONLY))) {
171	5	$extractTo = Str::beforeLast($filePath, DIRECTORY_SEPARATOR) . DIRECTORY_SEPARATOR;
172	5	$extractResult = $zipArchive->extractTo($extractTo);
173	5	$zipArchive->close();
174	5	if ($extractResult === true) {
175	5	return true;
176		}
177		}
178
179	1	if (is_numeric($openResult)) {
180	1	throw new Exception("Zip open [{$filePath}] error: {$openResult}. See: https://php.net/manual/en/zip.constants.php");
181		}
182
183		return false;
184		}
185
186		/**
187		* Download File using wget util.
188		*
189		* @param string $url
190		* @param string $path
191		*
192		* @return bool
193		*/
194	7	protected function downloadViaWget(string $url, string $path): bool
195		{
196	7	$process = new Process([
197	7	'wget',
198		//'-c',
199	7	'-N',
200	7	'-O',
201	7	$path,
202	7	$url,
203		]);
204	7	$process->run();
205
206	7	return $process->isSuccessful();
207		}
208
209		/**
210		* Download File using wget util.
211		*
212		* @param string $url
213		* @param string $path
214		*
215		* @return bool
216		* @throws Exception
217		*/
218	1	protected function downloadViaCurlPhp(string $url, string $path, ?\Closure $progressCallback = null): bool
219		{
220	1	$fp = fopen($path, 'w');
221	1	$ch = curl_init($url);
222	1	if ($progressCallback) {
223	1	curl_setopt($ch, CURLOPT_PROGRESSFUNCTION, $progressCallback);
224	1	curl_setopt($ch, CURLOPT_NOPROGRESS, false);
225		}
226	1	curl_setopt($ch, CURLOPT_FILE, $fp);
227
228	1	$result = curl_exec($ch);
229
230	1	if ($errorNumber = curl_errno($ch)) {
231	1	throw new Exception("Error [{$errorNumber}]. See https://php.net/manual/en/function.curl-errno.php");
232		}
233
234	1	curl_close($ch);
235	1	fclose($fp);
236
237	1	return (bool) $result;
238		}
239		}
240

yaroslawww / laravel-geonames

FilesystemStorage::exists() A last analyzed 2022-01-01 09:03 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

FilesystemStorage::exists() A
last analyzed 2022-01-01 09:03 UTC