CKEditorInstaller::extractFile() - Code Metrics - Inspection of "[POC] move json-builder to our repo" - FriendsOfSymfony/FOSCKEditorBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#47)

by Maximilian

created 2018-04-28 21:56 UTC

CKEditorInstaller::extractFile() C

↳ Parent: CKEditorInstaller

Complexity

Conditions	7
Paths	9

Size

Total Lines	25
Code Lines	13

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	25
rs	6.7272
c	0
b	0
f	0
cc	7
eloc	13
nc	9
nop	4

<?php

/*
 * This file is part of the Ivory CKEditor package.
 *
 * (c) Eric GELOEN <[email protected]>
 *
 * For the full copyright and license information, please read the LICENSE
 * file that was distributed with this source code.
 */

namespace FOS\CKEditorBundle\Installer;

use Symfony\Component\OptionsResolver\Options;
use Symfony\Component\OptionsResolver\OptionsResolver;

/**
 * @author GeLo <[email protected]>
 */
class CKEditorInstaller
{
    const RELEASE_BASIC = 'basic';
    const RELEASE_FULL = 'full';
    const RELEASE_STANDARD = 'standard';

    const VERSION_LATEST = 'latest';

    const CLEAR_DROP = 'drop';
    const CLEAR_KEEP = 'keep';
    const CLEAR_SKIP = 'skip';

    const NOTIFY_CLEAR = 'clear';
    const NOTIFY_CLEAR_ARCHIVE = 'clear-archive';
    const NOTIFY_CLEAR_COMPLETE = 'clear-complete';
    const NOTIFY_CLEAR_PROGRESS = 'clear-progress';
    const NOTIFY_CLEAR_QUESTION = 'clear-question';
    const NOTIFY_CLEAR_SIZE = 'clear-size';

    const NOTIFY_DOWNLOAD = 'download';
    const NOTIFY_DOWNLOAD_COMPLETE = 'download-complete';
    const NOTIFY_DOWNLOAD_PROGRESS = 'download-progress';
    const NOTIFY_DOWNLOAD_SIZE = 'download-size';

    const NOTIFY_EXTRACT = 'extract';
    const NOTIFY_EXTRACT_COMPLETE = 'extract-complete';
    const NOTIFY_EXTRACT_PROGRESS = 'extract-progress';
    const NOTIFY_EXTRACT_SIZE = 'extract-size';

    /**
     * @var string
     */
    private static $archive = 'https://github.com/ckeditor/ckeditor-releases/archive/%s/%s.zip';

    /**
     * @var OptionsResolver
     */
    private $resolver;

    /**
     * @param mixed[] $options
     */
    public function __construct(array $options = [])
    {
        $this->resolver = (new OptionsResolver())
            ->setDefaults(array_merge([
                'clear' => null,
                'excludes' => ['samples'],
                'notifier' => null,
                'path' => dirname(__DIR__).'/Resources/public',
                'release' => self::RELEASE_FULL,
                'version' => self::VERSION_LATEST,
            ], $options))
            ->setAllowedTypes('excludes', 'array')
            ->setAllowedTypes('notifier', ['null', 'callable'])
            ->setAllowedTypes('path', 'string')
            ->setAllowedTypes('version', 'string')
            ->setAllowedValues('clear', [self::CLEAR_DROP, self::CLEAR_KEEP, self::CLEAR_SKIP, null])
            ->setAllowedValues('release', [self::RELEASE_BASIC, self::RELEASE_FULL, self::RELEASE_STANDARD])
            ->setNormalizer('path', function (Options $options, $path) {
                return rtrim($path, '/');
            });
    }

    /**
     * @param mixed[] $options
     *
     * @return bool
     */
    public function install(array $options = [])
    {
        $options = $this->resolver->resolve($options);

        if ($this->clear($options) === self::CLEAR_SKIP) {

            return false;
        }

        $this->extract($this->download($options), $options);

        return true;
    }

    /**
     * @param mixed[] $options
     *
     * @return int
     */
    private function clear(array $options)
    {
        if (!file_exists($options['path'].'/ckeditor.js')) {
            return self::CLEAR_DROP;
        }

        if ($options['clear'] === null && $options['notifier'] !== null) {
            $options['clear'] = $this->notify($options['notifier'], self::NOTIFY_CLEAR, $options['path']);
        }

        if ($options['clear'] === null) {
            $options['clear'] = self::CLEAR_SKIP;
        }

        if ($options['clear'] === self::CLEAR_DROP) {
            $files = new \RecursiveIteratorIterator(
                new \RecursiveDirectoryIterator($options['path'], \RecursiveDirectoryIterator::SKIP_DOTS),
                \RecursiveIteratorIterator::CHILD_FIRST
            );

            $this->notify($options['notifier'], self::NOTIFY_CLEAR_SIZE, iterator_count($files));

            foreach ($files as $file) {
                $filePath = $file->getRealPath();
                $this->notify($options['notifier'], self::NOTIFY_CLEAR_PROGRESS, $filePath);

                if ($dir = $file->isDir()) {
                    $success = @rmdir($filePath);
                } else {
                    $success = @unlink($filePath);
                }

                if (!$success) {
                    throw $this->createException(sprintf(
                        'Unable to remove the %s "%s".',
                        $dir ? 'directory' : 'file',
                        $filePath
                    ));
                }
            }

            $this->notify($options['notifier'], self::NOTIFY_CLEAR_COMPLETE);
        }

        return $options['clear'];
    }

    /**
     * @param mixed[] $options
     *
     * @return string
     */
    private function download(array $options)
    {
        $url = sprintf(self::$archive, $options['release'], $options['version']);
        $this->notify($options['notifier'], self::NOTIFY_DOWNLOAD, $url);

        $zip = @file_get_contents($url, false, $this->createStreamContext($options['notifier']));

        if ($zip === false) {
            throw $this->createException(sprintf('Unable to download CKEditor ZIP archive from "%s".', $url));
        }

        $path = tempnam(sys_get_temp_dir(), 'ckeditor-'.$options['release'].'-'.$options['version'].'.zip');

        if (!@file_put_contents($path, $zip)) {
            throw $this->createException(sprintf('Unable to write CKEditor ZIP archive to "%s".', $path));
        }

        $this->notify($options['notifier'], self::NOTIFY_DOWNLOAD_COMPLETE, $path);

        return $path;
    }

    /**
     * @param callable|null $notifier
     *
     * @return resource
     */
    private function createStreamContext(callable $notifier = null)
    {
        $context = [];
        $proxy = getenv('https_proxy') ?: getenv('http_proxy');

        if ($proxy) {
            $context['proxy'] = $proxy;
            $context['request_fulluri'] = (bool) getenv('https_proxy_request_fulluri') ?: getenv('http_proxy_request_fulluri');
        }

        return stream_context_create($context, [
            'notification' => function (
                $code,
                $severity,
                $message,
                $messageCode,
                $transferred,
                $size
            ) use ($notifier) {
                if ($notifier === null) {
                    return;
                }

                switch ($code) {
                    case STREAM_NOTIFY_FILE_SIZE_IS:
                        $this->notify($notifier, self::NOTIFY_DOWNLOAD_SIZE, $size);
                        break;

                    case STREAM_NOTIFY_PROGRESS:
                        $this->notify($notifier, self::NOTIFY_DOWNLOAD_PROGRESS, $transferred);
                        break;
                }
            },
        ]);
    }

    /**
     * @param string  $path
     * @param mixed[] $options
     */
    private function extract($path, array $options)
    {
        $this->notify($options['notifier'], self::NOTIFY_EXTRACT, $options['path']);

        $zip = new \ZipArchive();
        $zip->open($path);

        $this->notify($options['notifier'], self::NOTIFY_EXTRACT_SIZE, $zip->numFiles);

        $offset = 20 + strlen($options['release']) + strlen($options['version']);

        for ($i = 0; $i < $zip->numFiles; ++$i) {
            $this->extractFile(
                $file = $zip->getNameIndex($i),
                substr($file, $offset),
                $path,
                $options
            );
        }

        $zip->close();

        $this->notify($options['notifier'], self::NOTIFY_EXTRACT_COMPLETE);
        $this->notify($options['notifier'], self::NOTIFY_CLEAR_ARCHIVE, $path);

        if (!@unlink($path)) {
            throw $this->createException(sprintf('Unable to remove the CKEditor ZIP archive "%s".', $path));
        }
    }

    /**
     * @param string  $file
     * @param string  $rewrite
     * @param string  $origin
     * @param mixed[] $options
     */
    private function extractFile($file, $rewrite, $origin, array $options)
    {
        $this->notify($options['notifier'], self::NOTIFY_EXTRACT_PROGRESS, $rewrite);

        $from = 'zip://'.$origin.'#'.$file;
        $to = $options['path'].'/'.$rewrite;

        foreach ($options['excludes'] as $exclude) {
            if (strpos($rewrite, $exclude) === 0) {
                return;
            }
        }

        if (substr($from, -1) === '/') {
            if (!is_dir($to) && !@mkdir($to)) {
                throw $this->createException(sprintf('Unable to create the directory "%s".', $to));
            }

            return;
        }

        if (!@copy($from, $to)) {
            throw $this->createException(sprintf('Unable to extract the file "%s" to "%s".', $file, $to));
        }
    }

    /**
     * @param callable|null $notifier
     * @param string        $type
     * @param mixed         $data
     *
     * @return mixed
     */
    private function notify(callable $notifier = null, $type, $data = null)
    {
        if ($notifier !== null) {
            return $notifier($type, $data);
        }
    }

    /**
     * @param string $message
     *
     * @return \RuntimeException
     */
    private function createException($message)
    {
        $error = error_get_last();

        if (isset($error['message'])) {
            $message .= sprintf(' (%s)', $error['message']);
        }

        return new \RuntimeException($message);
    }
}


1			<?php
2
3			/*
4			* This file is part of the Ivory CKEditor package.
5			*
6			* (c) Eric GELOEN <[email protected]>
7			*
8			* For the full copyright and license information, please read the LICENSE
9			* file that was distributed with this source code.
10			*/
11
12			namespace FOS\CKEditorBundle\Installer;
13
14			use Symfony\Component\OptionsResolver\Options;
15			use Symfony\Component\OptionsResolver\OptionsResolver;
16
17			/**
18			* @author GeLo <[email protected]>
19			*/
20			class CKEditorInstaller
21			{
22			const RELEASE_BASIC = 'basic';
23			const RELEASE_FULL = 'full';
24			const RELEASE_STANDARD = 'standard';
25
26			const VERSION_LATEST = 'latest';
27
28			const CLEAR_DROP = 'drop';
29			const CLEAR_KEEP = 'keep';
30			const CLEAR_SKIP = 'skip';
31
32			const NOTIFY_CLEAR = 'clear';
33			const NOTIFY_CLEAR_ARCHIVE = 'clear-archive';
34			const NOTIFY_CLEAR_COMPLETE = 'clear-complete';
35			const NOTIFY_CLEAR_PROGRESS = 'clear-progress';
36			const NOTIFY_CLEAR_QUESTION = 'clear-question';
37			const NOTIFY_CLEAR_SIZE = 'clear-size';
38
39			const NOTIFY_DOWNLOAD = 'download';
40			const NOTIFY_DOWNLOAD_COMPLETE = 'download-complete';
41			const NOTIFY_DOWNLOAD_PROGRESS = 'download-progress';
42			const NOTIFY_DOWNLOAD_SIZE = 'download-size';
43
44			const NOTIFY_EXTRACT = 'extract';
45			const NOTIFY_EXTRACT_COMPLETE = 'extract-complete';
46			const NOTIFY_EXTRACT_PROGRESS = 'extract-progress';
47			const NOTIFY_EXTRACT_SIZE = 'extract-size';
48
49			/**
50			* @var string
51			*/
52			private static $archive = 'https://github.com/ckeditor/ckeditor-releases/archive/%s/%s.zip';
53
54			/**
55			* @var OptionsResolver
56			*/
57			private $resolver;
58
59			/**
60			* @param mixed[] $options
61			*/
62			public function __construct(array $options = [])
63			{
64			$this->resolver = (new OptionsResolver())
65			->setDefaults(array_merge([
66			'clear' => null,
67			'excludes' => ['samples'],
68			'notifier' => null,
69			'path' => dirname(__DIR__).'/Resources/public',
70			'release' => self::RELEASE_FULL,
71			'version' => self::VERSION_LATEST,
72			], $options))
73			->setAllowedTypes('excludes', 'array')
74			->setAllowedTypes('notifier', ['null', 'callable'])
75			->setAllowedTypes('path', 'string')
76			->setAllowedTypes('version', 'string')
77			->setAllowedValues('clear', [self::CLEAR_DROP, self::CLEAR_KEEP, self::CLEAR_SKIP, null])
78			->setAllowedValues('release', [self::RELEASE_BASIC, self::RELEASE_FULL, self::RELEASE_STANDARD])
79			->setNormalizer('path', function (Options $options, $path) {
80			return rtrim($path, '/');
81			});
82			}
83
84			/**
85			* @param mixed[] $options
86			*
87			* @return bool
88			*/
89			public function install(array $options = [])
90			{
91			$options = $this->resolver->resolve($options);
92
93			if ($this->clear($options) === self::CLEAR_SKIP) {
			0 ignored issues – show Unused Code Bug introduced 2018-04-27 14:26 UTC by Report Bug Copy Issue Report The strict comparison `===` seems to always evaluate to `false` as the types of `$this->clear($options)` (`integer`) and `self::CLEAR_SKIP` (`string`) can never be identical. Maybe you want to use a loose comparison `==` instead? Loading history...
94			return false;
95			}
96
97			$this->extract($this->download($options), $options);
98
99			return true;
100			}
101
102			/**
103			* @param mixed[] $options
104			*
105			* @return int
106			*/
107			private function clear(array $options)
108			{
109			if (!file_exists($options['path'].'/ckeditor.js')) {
110			return self::CLEAR_DROP;
111			}
112
113			if ($options['clear'] === null && $options['notifier'] !== null) {
114			$options['clear'] = $this->notify($options['notifier'], self::NOTIFY_CLEAR, $options['path']);
115			}
116
117			if ($options['clear'] === null) {
118			$options['clear'] = self::CLEAR_SKIP;
119			}
120
121			if ($options['clear'] === self::CLEAR_DROP) {
122			$files = new \RecursiveIteratorIterator(
123			new \RecursiveDirectoryIterator($options['path'], \RecursiveDirectoryIterator::SKIP_DOTS),
124			\RecursiveIteratorIterator::CHILD_FIRST
125			);
126
127			$this->notify($options['notifier'], self::NOTIFY_CLEAR_SIZE, iterator_count($files));
128
129			foreach ($files as $file) {
130			$filePath = $file->getRealPath();
131			$this->notify($options['notifier'], self::NOTIFY_CLEAR_PROGRESS, $filePath);
132
133			if ($dir = $file->isDir()) {
134			$success = @rmdir($filePath);
135			} else {
136			$success = @unlink($filePath);
137			}
138
139			if (!$success) {
140			throw $this->createException(sprintf(
141			'Unable to remove the %s "%s".',
142			$dir ? 'directory' : 'file',
143			$filePath
144			));
145			}
146			}
147
148			$this->notify($options['notifier'], self::NOTIFY_CLEAR_COMPLETE);
149			}
150
151			return $options['clear'];
152			}
153
154			/**
155			* @param mixed[] $options
156			*
157			* @return string
158			*/
159			private function download(array $options)
160			{
161			$url = sprintf(self::$archive, $options['release'], $options['version']);
162			$this->notify($options['notifier'], self::NOTIFY_DOWNLOAD, $url);
163
164			$zip = @file_get_contents($url, false, $this->createStreamContext($options['notifier']));
165
166			if ($zip === false) {
167			throw $this->createException(sprintf('Unable to download CKEditor ZIP archive from "%s".', $url));
168			}
169
170			$path = tempnam(sys_get_temp_dir(), 'ckeditor-'.$options['release'].'-'.$options['version'].'.zip');
171
172			if (!@file_put_contents($path, $zip)) {
173			throw $this->createException(sprintf('Unable to write CKEditor ZIP archive to "%s".', $path));
174			}
175
176			$this->notify($options['notifier'], self::NOTIFY_DOWNLOAD_COMPLETE, $path);
177
178			return $path;
179			}
180
181			/**
182			* @param callable\|null $notifier
183			*
184			* @return resource
185			*/
186			private function createStreamContext(callable $notifier = null)
187			{
188			$context = [];
189			$proxy = getenv('https_proxy') ?: getenv('http_proxy');
190
191			if ($proxy) {
192			$context['proxy'] = $proxy;
193			$context['request_fulluri'] = (bool) getenv('https_proxy_request_fulluri') ?: getenv('http_proxy_request_fulluri');
194			}
195
196			return stream_context_create($context, [
197			'notification' => function (
198			$code,
199			$severity,
200			$message,
201			$messageCode,
202			$transferred,
203			$size
204			) use ($notifier) {
205			if ($notifier === null) {
206			return;
207			}
208
209			switch ($code) {
210			case STREAM_NOTIFY_FILE_SIZE_IS:
211			$this->notify($notifier, self::NOTIFY_DOWNLOAD_SIZE, $size);
212			break;
213
214			case STREAM_NOTIFY_PROGRESS:
215			$this->notify($notifier, self::NOTIFY_DOWNLOAD_PROGRESS, $transferred);
216			break;
217			}
218			},
219			]);
220			}
221
222			/**
223			* @param string $path
224			* @param mixed[] $options
225			*/
226			private function extract($path, array $options)
227			{
228			$this->notify($options['notifier'], self::NOTIFY_EXTRACT, $options['path']);
229
230			$zip = new \ZipArchive();
231			$zip->open($path);
232
233			$this->notify($options['notifier'], self::NOTIFY_EXTRACT_SIZE, $zip->numFiles);
234
235			$offset = 20 + strlen($options['release']) + strlen($options['version']);
236
237			for ($i = 0; $i < $zip->numFiles; ++$i) {
238			$this->extractFile(
239			$file = $zip->getNameIndex($i),
240			substr($file, $offset),
241			$path,
242			$options
243			);
244			}
245
246			$zip->close();
247
248			$this->notify($options['notifier'], self::NOTIFY_EXTRACT_COMPLETE);
249			$this->notify($options['notifier'], self::NOTIFY_CLEAR_ARCHIVE, $path);
250
251			if (!@unlink($path)) {
252			throw $this->createException(sprintf('Unable to remove the CKEditor ZIP archive "%s".', $path));
253			}
254			}
255
256			/**
257			* @param string $file
258			* @param string $rewrite
259			* @param string $origin
260			* @param mixed[] $options
261			*/
262			private function extractFile($file, $rewrite, $origin, array $options)
263			{
264			$this->notify($options['notifier'], self::NOTIFY_EXTRACT_PROGRESS, $rewrite);
265
266			$from = 'zip://'.$origin.'#'.$file;
267			$to = $options['path'].'/'.$rewrite;
268
269			foreach ($options['excludes'] as $exclude) {
270			if (strpos($rewrite, $exclude) === 0) {
271			return;
272			}
273			}
274
275			if (substr($from, -1) === '/') {
276			if (!is_dir($to) && !@mkdir($to)) {
277			throw $this->createException(sprintf('Unable to create the directory "%s".', $to));
278			}
279
280			return;
281			}
282
283			if (!@copy($from, $to)) {
284			throw $this->createException(sprintf('Unable to extract the file "%s" to "%s".', $file, $to));
285			}
286			}
287
288			/**
289			* @param callable\|null $notifier
290			* @param string $type
291			* @param mixed $data
292			*
293			* @return mixed
294			*/
295			private function notify(callable $notifier = null, $type, $data = null)
296			{
297			if ($notifier !== null) {
298			return $notifier($type, $data);
299			}
300			}
301
302			/**
303			* @param string $message
304			*
305			* @return \RuntimeException
306			*/
307			private function createException($message)
308			{
309			$error = error_get_last();
310
311			if (isset($error['message'])) {
312			$message .= sprintf(' (%s)', $error['message']);
313			}
314
315			return new \RuntimeException($message);
316			}
317			}
318

FriendsOfSymfony / FOSCKEditorBundle

Pull Request — master (#47)

CKEditorInstaller::extractFile() C

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like