DropboxAdapter::listContents() - Code Metrics - Inspection of "Ensure the path is case sensitive" - spatie/flysystem-dropbox - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#10)

unknown

created 2017-05-08 01:39 UTC

DropboxAdapter::listContents() C

↳ Parent: DropboxAdapter

Complexity

Conditions	7
Paths	5

Size

Total Lines	44
Code Lines	27

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	44
rs	6.7272
c	0
b	0
f	0
cc	7
eloc	27
nc	5
nop	2

<?php

namespace Spatie\FlysystemDropbox;

use LogicException;
use Spatie\Dropbox\Client;
use League\Flysystem\Config;
use Spatie\Dropbox\Exceptions\BadRequest;
use League\Flysystem\Adapter\AbstractAdapter;
use League\Flysystem\Adapter\Polyfill\NotSupportingVisibilityTrait;

class DropboxAdapter extends AbstractAdapter
{
    use NotSupportingVisibilityTrait;

    /** @var \Spatie\FlysystemDropbox\DropboxClient */
    protected $client;

    public function __construct(Client $client, string $prefix = '')
    {
        $this->client = $client;


        $this->setPathPrefix($prefix);
    }

    /**
     * {@inheritdoc}
     */
    public function write($path, $contents, Config $config)
    {
        return $this->upload($path, $contents, 'add');
    }

    /**
     * {@inheritdoc}
     */
    public function writeStream($path, $resource, Config $config)
    {
        return $this->upload($path, $resource, 'add');
    }

    /**
     * {@inheritdoc}
     */
    public function update($path, $contents, Config $config)
    {
        return $this->upload($path, $contents, 'overwrite');
    }

    /**
     * {@inheritdoc}
     */
    public function updateStream($path, $resource, Config $config)
    {
        return $this->upload($path, $resource, 'overwrite');
    }

    /**
     * {@inheritdoc}
     */
    public function rename($path, $newPath): bool
    {
        $path = $this->applyPathPrefix($path);
        $newPath = $this->applyPathPrefix($newPath);

        try {
            $this->client->move($path, $newPath);
        } catch (BadRequest $e) {
            return false;
        }

        return true;
    }

    /**
     * {@inheritdoc}
     */
    public function copy($path, $newpath): bool

    {
        $path = $this->applyPathPrefix($path);
        $newpath = $this->applyPathPrefix($newpath);

        try {
            $this->client->copy($path, $newpath);
        } catch (BadRequest $e) {
            return false;
        }

        return true;
    }

    /**
     * {@inheritdoc}
     */
    public function delete($path): bool
    {
        $location = $this->applyPathPrefix($path);

        try {
            $this->client->delete($location);
        } catch (BadRequest $e) {
            return false;
        }

        return true;
    }

    /**
     * {@inheritdoc}
     */
    public function deleteDir($dirname): bool
    {
        return $this->delete($dirname);
    }

    /**
     * {@inheritdoc}
     */
    public function createDir($dirname, Config $config)

    {
        $path = $this->applyPathPrefix($dirname);

        try {
            $object = $this->client->createFolder($path);
        } catch (BadRequest $e) {
            return false;
        }

        return $this->normalizeResponse($object);
    }

    /**
     * {@inheritdoc}
     */
    public function has($path)
    {
        return $this->getMetadata($path);
    }

    /**
     * {@inheritdoc}
     */
    public function read($path)
    {
        if (! $object = $this->readStream($path)) {
            return false;
        }

        $object['contents'] = stream_get_contents($object['stream']);
        fclose($object['stream']);
        unset($object['stream']);

        return $object;
    }

    /**
     * {@inheritdoc}
     */
    public function readStream($path)

    {
        $path = $this->applyPathPrefix($path);

        try {
            $stream = $this->client->download($path);
        } catch (BadRequest $e) {
            return false;
        }

        return compact('stream');
    }

    /**
     * {@inheritdoc}
     */
    public function listContents($directory = '', $recursive = false): array
    {
        $location = $this->applyPathPrefix($directory);

        $result = $this->client->listFolder($location, $recursive);

        if (! count($result['entries'])) {
            return [];
        }

        $cleanedPathDisplay = [];
        foreach ($result['entries'] as $item) {
            if ($item['.tag'] === 'folder') {
                $cleanedPathDisplay[$item['path_lower']] = $item['path_display'];

                $pathParts = explode('/', $item['path_lower']);
                do {
                    array_pop($pathParts);
                    $parentPathLower = implode('/', $pathParts);
                    if (!array_key_exists($parentPathLower, $cleanedPathDisplay)) {
                        $prefixedPath = $this->applyPathPrefix($parentPathLower);
                        $metadata = $this->client->getMetadata($prefixedPath);
                        $cleanedPathDisplay = [$metadata['path_lower'] => $metadata['path_display']] + $cleanedPathDisplay;
                    }
                } while (count($pathParts) > 2);
            }
        }

        $cleanedPathDisplay = array_reverse($cleanedPathDisplay);

        $result = array_map(function ($entry) use ($cleanedPathDisplay) {
            $path = $this->removePathPrefix($entry['path_display']);

            foreach ($cleanedPathDisplay as $pathLower => $pathDisplay) {
                $path = preg_replace('/^' . preg_quote($pathLower, '/') . '/i', $pathDisplay, $path);
            }

            $entry['path_display'] = $path;

            return $this->normalizeResponse($entry);
        }, $result['entries']);

        return $result;
    }

    /**
     * {@inheritdoc}
     */
    public function getMetadata($path)

    {
        $path = $this->applyPathPrefix($path);

        try {
            $object = $this->client->getMetadata($path);
        } catch (BadRequest $e) {
            return false;
        }

        return $this->normalizeResponse($object);
    }

    /**
     * {@inheritdoc}
     */
    public function getSize($path)
    {
        return $this->getMetadata($path);
    }

    /**
     * {@inheritdoc}
     */
    public function getMimetype($path)
    {
        throw new LogicException("The Dropbox API v2 does not support mimetypes. Given path: `{$path}`.");
    }

    /**
     * {@inheritdoc}
     */
    public function getTimestamp($path)
    {
        return $this->getMetadata($path);
    }

    public function getTemporaryLink(string $path): string
    {
        return $this->client->getTemporaryLink($path);
    }

    public function getThumbnail(string $path, string $format = 'jpeg', string $size = 'w64h64')
    {
        return $this->client->getThumbnail($path, $format, $size);
    }

    /**
     * {@inheritdoc}
     */
    public function applyPathPrefix($path): string
    {
        $path = parent::applyPathPrefix($path);

        return '/'.trim($path, '/');
    }

    public function getClient(): Client
    {
        return $this->client;
    }

    /**
     * @param string $path
     * @param resource|string $contents
     * @param string $mode
     *
     * @return array|false file metadata
     */
    protected function upload(string $path, $contents, string $mode)

    {
        $path = $this->applyPathPrefix($path);

        try {
            $object = $this->client->upload($path, $contents, $mode);
        } catch (BadRequest $e) {
            return false;
        }

        return $this->normalizeResponse($object);
    }

    protected function normalizeResponse(array $response): array
    {
        $normalizedPath = ltrim($this->removePathPrefix($response['path_display']), '/');

        $normalizedResponse = ['path' => $normalizedPath];

        if (isset($response['server_modified'])) {
            $normalizedResponse['timestamp'] = strtotime($response['server_modified']);
        }

        if (isset($response['size'])) {
            $normalizedResponse['bytes'] = $response['size'];
        }

        $type = ($response['.tag'] === 'folder' ? 'dir' : 'file');
        $normalizedResponse['type'] = $type;

        return $normalizedResponse;
    }
}


1		<?php
2
3		namespace Spatie\FlysystemDropbox;
4
5		use LogicException;
6		use Spatie\Dropbox\Client;
7		use League\Flysystem\Config;
8		use Spatie\Dropbox\Exceptions\BadRequest;
9		use League\Flysystem\Adapter\AbstractAdapter;
10		use League\Flysystem\Adapter\Polyfill\NotSupportingVisibilityTrait;
11
12		class DropboxAdapter extends AbstractAdapter
13		{
14		use NotSupportingVisibilityTrait;
15
16		/** @var \Spatie\FlysystemDropbox\DropboxClient */
17		protected $client;
18
19		public function __construct(Client $client, string $prefix = '')
20		{
21		$this->client = $client;
		0 ignored issues – show Documentation Bug introduced 2017-04-18 16:57 UTC by Report Bug Copy Issue Report It seems like `$client` of type `object<Spatie\Dropbox\Client>` is incompatible with the declared type `object<Spatie\FlysystemDropbox\DropboxClient>` of property `$client`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
22
23		$this->setPathPrefix($prefix);
24		}
25
26		/**
27		* {@inheritdoc}
28		*/
29		public function write($path, $contents, Config $config)
30		{
31		return $this->upload($path, $contents, 'add');
32		}
33
34		/**
35		* {@inheritdoc}
36		*/
37		public function writeStream($path, $resource, Config $config)
38		{
39		return $this->upload($path, $resource, 'add');
40		}
41
42		/**
43		* {@inheritdoc}
44		*/
45		public function update($path, $contents, Config $config)
46		{
47		return $this->upload($path, $contents, 'overwrite');
48		}
49
50		/**
51		* {@inheritdoc}
52		*/
53		public function updateStream($path, $resource, Config $config)
54		{
55		return $this->upload($path, $resource, 'overwrite');
56		}
57
58		/**
59		* {@inheritdoc}
60		*/
61		public function rename($path, $newPath): bool
62		{
63		$path = $this->applyPathPrefix($path);
64		$newPath = $this->applyPathPrefix($newPath);
65
66		try {
67		$this->client->move($path, $newPath);
68		} catch (BadRequest $e) {
69		return false;
70		}
71
72		return true;
73		}
74
75		/**
76		* {@inheritdoc}
77		*/
78	View Code Duplication	public function copy($path, $newpath): bool
		0 ignored issues – show Duplication introduced 2017-04-19 09:34 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...
79		{
80		$path = $this->applyPathPrefix($path);
81		$newpath = $this->applyPathPrefix($newpath);
82
83		try {
84		$this->client->copy($path, $newpath);
85		} catch (BadRequest $e) {
86		return false;
87		}
88
89		return true;
90		}
91
92		/**
93		* {@inheritdoc}
94		*/
95		public function delete($path): bool
96		{
97		$location = $this->applyPathPrefix($path);
98
99		try {
100		$this->client->delete($location);
101		} catch (BadRequest $e) {
102		return false;
103		}
104
105		return true;
106		}
107
108		/**
109		* {@inheritdoc}
110		*/
111		public function deleteDir($dirname): bool
112		{
113		return $this->delete($dirname);
114		}
115
116		/**
117		* {@inheritdoc}
118		*/
119	View Code Duplication	public function createDir($dirname, Config $config)
		0 ignored issues – show Duplication introduced 2017-04-18 13:15 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...
120		{
121		$path = $this->applyPathPrefix($dirname);
122
123		try {
124		$object = $this->client->createFolder($path);
125		} catch (BadRequest $e) {
126		return false;
127		}
128
129		return $this->normalizeResponse($object);
130		}
131
132		/**
133		* {@inheritdoc}
134		*/
135		public function has($path)
136		{
137		return $this->getMetadata($path);
138		}
139
140		/**
141		* {@inheritdoc}
142		*/
143		public function read($path)
144		{
145		if (! $object = $this->readStream($path)) {
146		return false;
147		}
148
149		$object['contents'] = stream_get_contents($object['stream']);
150		fclose($object['stream']);
151		unset($object['stream']);
152
153		return $object;
154		}
155
156		/**
157		* {@inheritdoc}
158		*/
159	View Code Duplication	public function readStream($path)
		0 ignored issues – show Duplication introduced 2017-04-18 13:15 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...
160		{
161		$path = $this->applyPathPrefix($path);
162
163		try {
164		$stream = $this->client->download($path);
165		} catch (BadRequest $e) {
166		return false;
167		}
168
169		return compact('stream');
170		}
171
172		/**
173		* {@inheritdoc}
174		*/
175		public function listContents($directory = '', $recursive = false): array
176		{
177		$location = $this->applyPathPrefix($directory);
178
179		$result = $this->client->listFolder($location, $recursive);
180
181		if (! count($result['entries'])) {
182		return [];
183		}
184
185		$cleanedPathDisplay = [];
186		foreach ($result['entries'] as $item) {
187		if ($item['.tag'] === 'folder') {
188		$cleanedPathDisplay[$item['path_lower']] = $item['path_display'];
189
190		$pathParts = explode('/', $item['path_lower']);
191		do {
192		array_pop($pathParts);
193		$parentPathLower = implode('/', $pathParts);
194		if (!array_key_exists($parentPathLower, $cleanedPathDisplay)) {
195		$prefixedPath = $this->applyPathPrefix($parentPathLower);
196		$metadata = $this->client->getMetadata($prefixedPath);
197		$cleanedPathDisplay = [$metadata['path_lower'] => $metadata['path_display']] + $cleanedPathDisplay;
198		}
199		} while (count($pathParts) > 2);
200		}
201		}
202
203		$cleanedPathDisplay = array_reverse($cleanedPathDisplay);
204
205		$result = array_map(function ($entry) use ($cleanedPathDisplay) {
206		$path = $this->removePathPrefix($entry['path_display']);
207
208		foreach ($cleanedPathDisplay as $pathLower => $pathDisplay) {
209		$path = preg_replace('/^' . preg_quote($pathLower, '/') . '/i', $pathDisplay, $path);
210		}
211
212		$entry['path_display'] = $path;
213
214		return $this->normalizeResponse($entry);
215		}, $result['entries']);
216
217		return $result;
218		}
219
220		/**
221		* {@inheritdoc}
222		*/
223	View Code Duplication	public function getMetadata($path)
		0 ignored issues – show Duplication introduced 2017-04-19 09:34 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...
224		{
225		$path = $this->applyPathPrefix($path);
226
227		try {
228		$object = $this->client->getMetadata($path);
229		} catch (BadRequest $e) {
230		return false;
231		}
232
233		return $this->normalizeResponse($object);
234		}
235
236		/**
237		* {@inheritdoc}
238		*/
239		public function getSize($path)
240		{
241		return $this->getMetadata($path);
242		}
243
244		/**
245		* {@inheritdoc}
246		*/
247		public function getMimetype($path)
248		{
249		throw new LogicException("The Dropbox API v2 does not support mimetypes. Given path: `{$path}`.");
250		}
251
252		/**
253		* {@inheritdoc}
254		*/
255		public function getTimestamp($path)
256		{
257		return $this->getMetadata($path);
258		}
259
260		public function getTemporaryLink(string $path): string
261		{
262		return $this->client->getTemporaryLink($path);
263		}
264
265		public function getThumbnail(string $path, string $format = 'jpeg', string $size = 'w64h64')
266		{
267		return $this->client->getThumbnail($path, $format, $size);
268		}
269
270		/**
271		* {@inheritdoc}
272		*/
273		public function applyPathPrefix($path): string
274		{
275		$path = parent::applyPathPrefix($path);
276
277		return '/'.trim($path, '/');
278		}
279
280		public function getClient(): Client
281		{
282		return $this->client;
283		}
284
285		/**
286		* @param string $path
287		* @param resource\|string $contents
288		* @param string $mode
289		*
290		* @return array\|false file metadata
291		*/
292	View Code Duplication	protected function upload(string $path, $contents, string $mode)
		0 ignored issues – show Duplication introduced 2017-04-19 09:34 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...
293		{
294		$path = $this->applyPathPrefix($path);
295
296		try {
297		$object = $this->client->upload($path, $contents, $mode);
298		} catch (BadRequest $e) {
299		return false;
300		}
301
302		return $this->normalizeResponse($object);
303		}
304
305		protected function normalizeResponse(array $response): array
306		{
307		$normalizedPath = ltrim($this->removePathPrefix($response['path_display']), '/');
308
309		$normalizedResponse = ['path' => $normalizedPath];
310
311		if (isset($response['server_modified'])) {
312		$normalizedResponse['timestamp'] = strtotime($response['server_modified']);
313		}
314
315		if (isset($response['size'])) {
316		$normalizedResponse['bytes'] = $response['size'];
317		}
318
319		$type = ($response['.tag'] === 'folder' ? 'dir' : 'file');
320		$normalizedResponse['type'] = $type;
321
322		return $normalizedResponse;
323		}
324		}
325

spatie / flysystem-dropbox

GitHub Access Token became invalid

Pull Request — master (#10)

DropboxAdapter::listContents() C

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like