ZipAdapter::doExtract() - Code Metrics - Inspection of "fix issue #131: allow the usage of .bat, .cmd and..." - alchemy-fr/Zippy - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#132)

unknown

created 2021-04-13 14:22 UTC

ZipAdapter::doExtract() B

↳ Parent: ZipAdapter

Complexity

Conditions	6
Paths	5

Size

Total Lines

Duplication

Lines	3
Ratio	8.82 %

Importance

Changes

Metric	Value
dl	3
loc	34
rs	8.7537
c	0
b	0
f	0
cc	6
nc	5
nop	2

<?php

/*
 * This file is part of Zippy.
 *
 * (c) Alchemy <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Alchemy\Zippy\Adapter;

use Alchemy\Zippy\Adapter\Resource\ResourceInterface;
use Alchemy\Zippy\Adapter\VersionProbe\ZipVersionProbe;
use Alchemy\Zippy\Archive\Archive;
use Alchemy\Zippy\Archive\Member;
use Alchemy\Zippy\Exception\InvalidArgumentException;
use Alchemy\Zippy\Exception\NotSupportedException;
use Alchemy\Zippy\Exception\RuntimeException;
use Alchemy\Zippy\Parser\ParserInterface;
use Alchemy\Zippy\ProcessBuilder\ProcessBuilderFactoryInterface;
use Alchemy\Zippy\Resource\Resource as ZippyResource;
use Alchemy\Zippy\Resource\ResourceManager;
use Symfony\Component\Process\Exception\ExceptionInterface as ProcessException;

/**
 * ZipAdapter allows you to create and extract files from archives using Zip
 *
 * @see http://www.gnu.org/software/tar/manual/tar.html
 */
class ZipAdapter extends AbstractBinaryAdapter
{
    public function __construct(
        ParserInterface $parser,
        ResourceManager $manager,
        ProcessBuilderFactoryInterface $inflator,
        ProcessBuilderFactoryInterface $deflator
    ) {
        parent::__construct($parser, $manager, $inflator, $deflator);

        $this->probe = new ZipVersionProbe($inflator, $deflator);
    }

    /**
     * @inheritdoc
     */
    protected function doCreate($path, $files, $recursive)
    {
        $files = (array) $files;

        $builder = $this
            ->inflator
            ->create();

        if (0 === count($files)) {
            throw new NotSupportedException('Can not create empty zip archive');
        }

        if ($recursive) {
            $builder->add('-r');
        }

        $builder->add($path);

        $collection = $this->manager->handle(getcwd(), $files);
        $builder->setWorkingDirectory($collection->getContext());

        $collection->forAll(function($i, ZippyResource $resource) use ($builder) {
            return $builder->add($resource->getTarget());
        });

        $process = $builder->getProcess();

        try {
            $process->run();
        } catch (ProcessException $e) {
            $this->manager->cleanup($collection);
            throw $e;
        }

        $this->manager->cleanup($collection);

        if (!$process->isSuccessful()) {
            throw new RuntimeException(sprintf(
                'Unable to execute the following command %s {output: %s}',
                $process->getCommandLine(),
                $process->getErrorOutput()
            ));
        }

        return new Archive($this->createResource($path), $this, $this->manager);
    }

    /**
     * @inheritdoc
     */
    protected function doListMembers(ResourceInterface $resource)
    {
        $process = $this
            ->deflator
            ->create()
            ->add('-l')
            ->add($resource->getResource())
            ->getProcess();

        $process->run();

        if (!$process->isSuccessful()) {
            throw new RuntimeException(sprintf(
                'Unable to execute the following command %s {output: %s}',
                $process->getCommandLine(),
                $process->getErrorOutput()
            ));
        }

        $members = array();

        foreach ($this->parser->parseFileListing($process->getOutput() ?: '') as $member) {

            $members[] = new Member(
                $resource,
                $this,
                $member['location'],
                $member['size'],
                $member['mtime'],
                $member['is_dir']
            );
        }

        return $members;
    }

    /**
     * @inheritdoc
     */
    protected function doAdd(ResourceInterface $resource, $files, $recursive)
    {
        $files = (array) $files;

        $builder = $this
            ->inflator
            ->create();

        if ($recursive) {
            $builder->add('-r');
        }

        $builder
            ->add('-u')
            ->add($resource->getResource());

        $collection = $this->manager->handle(getcwd(), $files);

        $builder->setWorkingDirectory($collection->getContext());

        $collection->forAll(function($i, ZippyResource $resource) use ($builder) {
            return $builder->add($resource->getTarget());
        });

        $process = $builder->getProcess();

        try {
            $process->run();
        } catch (ProcessException $e) {
            $this->manager->cleanup($collection);
            throw $e;
        }

        $this->manager->cleanup($collection);

        if (!$process->isSuccessful()) {
            throw new RuntimeException(sprintf(
                'Unable to execute the following command %s {output: %s}',
                $process->getCommandLine(),
                $process->getErrorOutput()
            ));
        }
    }

    /**
     * @inheritdoc
     */
    protected function doGetDeflatorVersion()

    {
        $process = $this
            ->deflator
            ->create()
            ->add('-h')
            ->getProcess();

        $process->run();

        if (!$process->isSuccessful()) {
            throw new RuntimeException(sprintf(
                'Unable to execute the following command %s {output: %s}',
                $process->getCommandLine(),
                $process->getErrorOutput()
            ));
        }

        return $this->parser->parseDeflatorVersion($process->getOutput() ?: '');
    }

    /**
     * @inheritdoc
     */
    protected function doGetInflatorVersion()

    {
        $process = $this
            ->inflator
            ->create()
            ->add('-h')
            ->getProcess();

        $process->run();

        if (!$process->isSuccessful()) {
            throw new RuntimeException(sprintf(
                'Unable to execute the following command %s {output: %s}',
                $process->getCommandLine(),
                $process->getErrorOutput()
            ));
        }

        return $this->parser->parseInflatorVersion($process->getOutput() ?: '');
    }

    /**
     * @inheritdoc
     */
    protected function doRemove(ResourceInterface $resource, $files)
    {
        $files = (array) $files;

        $builder = $this
            ->inflator
            ->create();

        $builder
            ->add('-d')
            ->add($resource->getResource());

        if (!$this->addBuilderFileArgument($files, $builder)) {
            throw new InvalidArgumentException('Invalid files');
        }

        $process = $builder->getProcess();

        $process->run();

        if (!$process->isSuccessful()) {
            throw new RuntimeException(sprintf(
                'Unable to execute the following command %s {output: %s}',
                $process->getCommandLine(),
                $process->getErrorOutput()
            ));
        }

        return $files;
    }

    /**
     * @inheritdoc
     */
    public static function getName()
    {
        return 'zip';
    }

    /**
     * @inheritdoc
     */
    public static function getDefaultDeflatorBinaryName()
    {
        return array('unzip');
    }

    /**
     * @inheritdoc
     */
    public static function getDefaultInflatorBinaryName()
    {
        return array('zip');
    }

    /**
     * @inheritdoc
     */
    protected function doExtract(ResourceInterface $resource, $to)
    {
        if (null !== $to && !is_dir($to)) {

            throw new InvalidArgumentException(sprintf("%s is not a directory", $to));
        }

        $builder = $this
            ->deflator
            ->create();

        $builder
            ->add('-o')
            ->add($resource->getResource());

        if (null !== $to) {
            $builder
                ->add('-d')
                ->add($to);
        }

        $process = $builder->getProcess();

        $process->run();

        if (!$process->isSuccessful()) {
            throw new RuntimeException(sprintf(
                'Unable to execute the following command %s {output: %s}',
                $process->getCommandLine(),
                $process->getErrorOutput()
            ));
        }

        return new \SplFileInfo($to ?: $resource->getResource());
    }

    /**
     * @inheritdoc
     */
    protected function doExtractMembers(ResourceInterface $resource, $members, $to, $overwrite = false)
    {
        if (null !== $to && !is_dir($to)) {

            throw new InvalidArgumentException(sprintf("%s is not a directory", $to));
        }

        $members = (array) $members;

        $builder = $this
            ->deflator
            ->create();

        if ((bool) $overwrite) {
            $builder->add('-o');
        }

        $builder
            ->add($resource->getResource());

        if (null !== $to) {
            $builder
                ->add('-d')
                ->add($to);
        }

        if (!$this->addBuilderFileArgument($members, $builder)) {
            throw new InvalidArgumentException('Invalid files');
        }

        $process = $builder->getProcess();

        $process->run();

        if (!$process->isSuccessful()) {
            throw new RuntimeException(sprintf(
                'Unable to execute the following command %s {output: %s}',
                $process->getCommandLine(),
                $process->getErrorOutput()
            ));
        }

        return $members;
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
    }
}


1		<?php
2
3		/*
4		* This file is part of Zippy.
5		*
6		* (c) Alchemy <[email protected]>
7		*
8		* For the full copyright and license information, please view the LICENSE
9		* file that was distributed with this source code.
10		*/
11
12		namespace Alchemy\Zippy\Adapter;
13
14		use Alchemy\Zippy\Adapter\Resource\ResourceInterface;
15		use Alchemy\Zippy\Adapter\VersionProbe\ZipVersionProbe;
16		use Alchemy\Zippy\Archive\Archive;
17		use Alchemy\Zippy\Archive\Member;
18		use Alchemy\Zippy\Exception\InvalidArgumentException;
19		use Alchemy\Zippy\Exception\NotSupportedException;
20		use Alchemy\Zippy\Exception\RuntimeException;
21		use Alchemy\Zippy\Parser\ParserInterface;
22		use Alchemy\Zippy\ProcessBuilder\ProcessBuilderFactoryInterface;
23		use Alchemy\Zippy\Resource\Resource as ZippyResource;
24		use Alchemy\Zippy\Resource\ResourceManager;
25		use Symfony\Component\Process\Exception\ExceptionInterface as ProcessException;
26
27		/**
28		* ZipAdapter allows you to create and extract files from archives using Zip
29		*
30		* @see http://www.gnu.org/software/tar/manual/tar.html
31		*/
32		class ZipAdapter extends AbstractBinaryAdapter
33		{
34		public function __construct(
35		ParserInterface $parser,
36		ResourceManager $manager,
37		ProcessBuilderFactoryInterface $inflator,
38		ProcessBuilderFactoryInterface $deflator
39		) {
40		parent::__construct($parser, $manager, $inflator, $deflator);
41
42		$this->probe = new ZipVersionProbe($inflator, $deflator);
43		}
44
45		/**
46		* @inheritdoc
47		*/
48		protected function doCreate($path, $files, $recursive)
49		{
50		$files = (array) $files;
51
52		$builder = $this
53		->inflator
54		->create();
55
56		if (0 === count($files)) {
57		throw new NotSupportedException('Can not create empty zip archive');
58		}
59
60		if ($recursive) {
61		$builder->add('-r');
62		}
63
64		$builder->add($path);
65
66		$collection = $this->manager->handle(getcwd(), $files);
67		$builder->setWorkingDirectory($collection->getContext());
68
69		$collection->forAll(function($i, ZippyResource $resource) use ($builder) {
70		return $builder->add($resource->getTarget());
71		});
72
73		$process = $builder->getProcess();
74
75		try {
76		$process->run();
77		} catch (ProcessException $e) {
78		$this->manager->cleanup($collection);
79		throw $e;
80		}
81
82		$this->manager->cleanup($collection);
83
84		if (!$process->isSuccessful()) {
85		throw new RuntimeException(sprintf(
86		'Unable to execute the following command %s {output: %s}',
87		$process->getCommandLine(),
88		$process->getErrorOutput()
89		));
90		}
91
92		return new Archive($this->createResource($path), $this, $this->manager);
93		}
94
95		/**
96		* @inheritdoc
97		*/
98		protected function doListMembers(ResourceInterface $resource)
99		{
100		$process = $this
101		->deflator
102		->create()
103		->add('-l')
104		->add($resource->getResource())
105		->getProcess();
106
107		$process->run();
108
109		if (!$process->isSuccessful()) {
110		throw new RuntimeException(sprintf(
111		'Unable to execute the following command %s {output: %s}',
112		$process->getCommandLine(),
113		$process->getErrorOutput()
114		));
115		}
116
117		$members = array();
118
119	View Code Duplication	foreach ($this->parser->parseFileListing($process->getOutput() ?: '') as $member) {
		0 ignored issues – show Duplication introduced 2016-02-12 10:17 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
120		$members[] = new Member(
121		$resource,
122		$this,
123		$member['location'],
124		$member['size'],
125		$member['mtime'],
126		$member['is_dir']
127		);
128		}
129
130		return $members;
131		}
132
133		/**
134		* @inheritdoc
135		*/
136		protected function doAdd(ResourceInterface $resource, $files, $recursive)
137		{
138		$files = (array) $files;
139
140		$builder = $this
141		->inflator
142		->create();
143
144		if ($recursive) {
145		$builder->add('-r');
146		}
147
148		$builder
149		->add('-u')
150		->add($resource->getResource());
151
152		$collection = $this->manager->handle(getcwd(), $files);
153
154		$builder->setWorkingDirectory($collection->getContext());
155
156		$collection->forAll(function($i, ZippyResource $resource) use ($builder) {
157		return $builder->add($resource->getTarget());
158		});
159
160		$process = $builder->getProcess();
161
162		try {
163		$process->run();
164		} catch (ProcessException $e) {
165		$this->manager->cleanup($collection);
166		throw $e;
167		}
168
169		$this->manager->cleanup($collection);
170
171		if (!$process->isSuccessful()) {
172		throw new RuntimeException(sprintf(
173		'Unable to execute the following command %s {output: %s}',
174		$process->getCommandLine(),
175		$process->getErrorOutput()
176		));
177		}
178		}
179
180		/**
181		* @inheritdoc
182		*/
183	View Code Duplication	protected function doGetDeflatorVersion()
		0 ignored issues – show Duplication introduced 2017-11-18 14:08 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
184		{
185		$process = $this
186		->deflator
187		->create()
188		->add('-h')
189		->getProcess();
190
191		$process->run();
192
193		if (!$process->isSuccessful()) {
194		throw new RuntimeException(sprintf(
195		'Unable to execute the following command %s {output: %s}',
196		$process->getCommandLine(),
197		$process->getErrorOutput()
198		));
199		}
200
201		return $this->parser->parseDeflatorVersion($process->getOutput() ?: '');
202		}
203
204		/**
205		* @inheritdoc
206		*/
207	View Code Duplication	protected function doGetInflatorVersion()
		0 ignored issues – show Duplication introduced 2017-11-18 14:08 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
208		{
209		$process = $this
210		->inflator
211		->create()
212		->add('-h')
213		->getProcess();
214
215		$process->run();
216
217		if (!$process->isSuccessful()) {
218		throw new RuntimeException(sprintf(
219		'Unable to execute the following command %s {output: %s}',
220		$process->getCommandLine(),
221		$process->getErrorOutput()
222		));
223		}
224
225		return $this->parser->parseInflatorVersion($process->getOutput() ?: '');
226		}
227
228		/**
229		* @inheritdoc
230		*/
231		protected function doRemove(ResourceInterface $resource, $files)
232		{
233		$files = (array) $files;
234
235		$builder = $this
236		->inflator
237		->create();
238
239		$builder
240		->add('-d')
241		->add($resource->getResource());
242
243		if (!$this->addBuilderFileArgument($files, $builder)) {
244		throw new InvalidArgumentException('Invalid files');
245		}
246
247		$process = $builder->getProcess();
248
249		$process->run();
250
251		if (!$process->isSuccessful()) {
252		throw new RuntimeException(sprintf(
253		'Unable to execute the following command %s {output: %s}',
254		$process->getCommandLine(),
255		$process->getErrorOutput()
256		));
257		}
258
259		return $files;
260		}
261
262		/**
263		* @inheritdoc
264		*/
265		public static function getName()
266		{
267		return 'zip';
268		}
269
270		/**
271		* @inheritdoc
272		*/
273		public static function getDefaultDeflatorBinaryName()
274		{
275		return array('unzip');
276		}
277
278		/**
279		* @inheritdoc
280		*/
281		public static function getDefaultInflatorBinaryName()
282		{
283		return array('zip');
284		}
285
286		/**
287		* @inheritdoc
288		*/
289		protected function doExtract(ResourceInterface $resource, $to)
290		{
291	View Code Duplication	if (null !== $to && !is_dir($to)) {
		0 ignored issues – show Duplication introduced 2016-02-12 10:17 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
292		throw new InvalidArgumentException(sprintf("%s is not a directory", $to));
293		}
294
295		$builder = $this
296		->deflator
297		->create();
298
299		$builder
300		->add('-o')
301		->add($resource->getResource());
302
303		if (null !== $to) {
304		$builder
305		->add('-d')
306		->add($to);
307		}
308
309		$process = $builder->getProcess();
310
311		$process->run();
312
313		if (!$process->isSuccessful()) {
314		throw new RuntimeException(sprintf(
315		'Unable to execute the following command %s {output: %s}',
316		$process->getCommandLine(),
317		$process->getErrorOutput()
318		));
319		}
320
321		return new \SplFileInfo($to ?: $resource->getResource());
322		}
323
324		/**
325		* @inheritdoc
326		*/
327		protected function doExtractMembers(ResourceInterface $resource, $members, $to, $overwrite = false)
328		{
329	View Code Duplication	if (null !== $to && !is_dir($to)) {
		0 ignored issues – show Duplication introduced 2016-02-12 10:17 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
330		throw new InvalidArgumentException(sprintf("%s is not a directory", $to));
331		}
332
333		$members = (array) $members;
334
335		$builder = $this
336		->deflator
337		->create();
338
339		if ((bool) $overwrite) {
340		$builder->add('-o');
341		}
342
343		$builder
344		->add($resource->getResource());
345
346		if (null !== $to) {
347		$builder
348		->add('-d')
349		->add($to);
350		}
351
352		if (!$this->addBuilderFileArgument($members, $builder)) {
353		throw new InvalidArgumentException('Invalid files');
354		}
355
356		$process = $builder->getProcess();
357
358		$process->run();
359
360		if (!$process->isSuccessful()) {
361		throw new RuntimeException(sprintf(
362		'Unable to execute the following command %s {output: %s}',
363		$process->getCommandLine(),
364		$process->getErrorOutput()
365		));
366		}
367
368		return $members;
		0 ignored issues – show Bug Best Practice introduced 2016-02-12 10:17 UTC by Report Bug Copy Issue Report The return type of `return $members;` (`array`) is incompatible with the return type declared by the abstract method `Alchemy\Zippy\Adapter\Ab...apter::doExtractMembers` of type `SplFileInfo`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
369		}
370		}
371

alchemy-fr / Zippy

Pull Request — master (#132)

ZipAdapter::doExtract() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like