Client::getKey() - Code Metrics - Inspection of "Compatibility with uppy (#21)" - ankitpokhrel/tus-php - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 664d8f...1716c0 )

by Ankit

created 2018-03-13 17:02 UTC

Client::getKey() A

↳ Parent: Client

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

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

<?php

namespace TusPhp\Tus;

use TusPhp\File;
use TusPhp\Cache\Cacheable;
use TusPhp\Exception\Exception;
use TusPhp\Exception\FileException;
use GuzzleHttp\Client as GuzzleClient;
use GuzzleHttp\Exception\ClientException;
use TusPhp\Exception\ConnectionException;
use GuzzleHttp\Exception\ConnectException;
use Illuminate\Http\Response as HttpResponse;

class Client extends AbstractTus
{
    /** @var GuzzleClient */
    protected $client;

    /** @var string */
    protected $filePath;

    /** @var int */
    protected $fileSize;

    /** @var string */
    protected $fileName;

    /** @var string */
    protected $key;

    /** @var string */
    protected $checksum;

    /** @var int */
    protected $partialOffset = -1;

    /** @var bool */
    protected $partial = false;

    /** @var string */
    protected $checksumAlgorithm = 'sha256';

    /**
     * Client constructor.
     *
     * @param string           $baseUrl
     * @param Cacheable|string $cacheAdapter
     */
    public function __construct(string $baseUrl, $cacheAdapter = 'file')
    {
        $this->client = new GuzzleClient([
            'base_uri' => $baseUrl,
        ]);

        $this->setCache($cacheAdapter);
    }

    /**
     * Set file properties.
     *
     * @param string $file File path.
     * @param string $name File name.
     *
     * @return Client
     */
    public function file(string $file, string $name = null) : self
    {
        $this->filePath = $file;

        if ( ! file_exists($file) || ! is_readable($file)) {
            throw new FileException('Cannot read file: ' . $file);
        }

        $this->fileName = $name ?? basename($this->filePath);
        $this->fileSize = filesize($file);

        return $this;
    }

    /**
     * Get file path.
     *
     * @return string|null
     */
    public function getFilePath()
    {
        return $this->filePath;
    }

    /**
     * Set file name.
     *
     * @param string $name
     *
     * @return Client
     */
    public function setFileName(string $name) : self
    {
        $this->fileName = $name;

        return $this;
    }

    /**
     * Get file name.
     *
     * @return string|null
     */
    public function getFileName()
    {
        return $this->fileName;
    }

    /**
     * Get file size.
     *
     * @return int|null
     */
    public function getFileSize()
    {
        return $this->fileSize;
    }

    /**
     * Get guzzle client.
     *
     * @return GuzzleClient
     */
    public function getClient() : GuzzleClient
    {
        return $this->client;
    }

    /**
     * Get checksum.
     *
     * @return string
     */
    public function getChecksum() : string
    {
        if (empty($this->checksum)) {
            $this->checksum = hash_file($this->getChecksumAlgorithm(), $this->getFilePath());
        }

        return $this->checksum;
    }

    /**
     * Set key.
     *
     * @param string $key
     *
     * @return Client
     */
    public function setKey(string $key) : self
    {
        $this->key = $key;

        return $this;
    }

    /**
     * Get key.
     *
     * @return string
     */
    public function getKey() : string
    {
        return $this->key;
    }

    /**
     * Set checksum algorithm.
     *
     * @param string $algorithm
     *
     * @return Client
     */
    public function setChecksumAlgorithm(string $algorithm) : self
    {
        $this->checksumAlgorithm = $algorithm;

        return $this;
    }

    /**
     * Get checksum algorithm.
     *
     * @return string
     */
    public function getChecksumAlgorithm() : string
    {
        return $this->checksumAlgorithm;
    }

    /**
     * Check if this is a partial upload request.
     *
     * @return bool
     */
    public function isPartial() : bool
    {
        return $this->partial;
    }

    /**
     * Get partial offset.
     *
     * @return int
     */
    public function getPartialOffset() : int
    {
        return $this->partialOffset;
    }

    /**
     * Set offset and force this to be a partial upload request.
     *
     * @param int $offset
     *
     * @return self
     */
    public function seek(int $offset) : self
    {
        $this->partialOffset = $offset;

        $this->partial();

        return $this;
    }

    /**
     * Upload file.
     *
     * @param int $bytes Bytes to upload
     *
     * @throws ConnectionException
     *
     * @return int
     */
    public function upload(int $bytes = -1) : int
    {
        $bytes = $bytes < 0 ? $this->getFileSize() : $bytes;
        $key   = $this->getKey();

        try {
            // Check if this upload exists with HEAD request
            $this->sendHeadRequest($key);
        } catch (FileException | ClientException $e) {
            $this->create($key);
        } catch (ConnectException $e) {
            throw new ConnectionException("Couldn't connect to server.");
        }

        // Now, resume upload with PATCH request
        return $this->sendPatchRequest($key, $bytes);
    }

    /**
     * Returns offset if file is partially uploaded.
     *
     * @return bool|int
     */
    public function getOffset()
    {
        $key = $this->getKey();

        try {
            $offset = $this->sendHeadRequest($key);
        } catch (FileException | ClientException $e) {
            return false;
        }

        return $offset;
    }

    /**
     * Create resource with POST request.
     *
     * @param string $key
     *
     * @throws FileException
     *
     * @return string
     */
    public function create(string $key) : string
    {
        $headers = [
            'Upload-Length' => $this->fileSize,
            'Upload-Key' => $key,
            'Upload-Checksum' => $this->getUploadChecksumHeader(),
            'Upload-Metadata' => 'filename ' . base64_encode($this->fileName),
        ];

        if ($this->isPartial()) {
            $headers += ['Upload-Concat' => 'partial'];
        }

        $response = $this->getClient()->post($this->apiPath, [
            'headers' => $headers,
        ]);

        $data       = json_decode($response->getBody(), true);
        $checksum   = $data['data']['checksum'] ?? null;
        $statusCode = $response->getStatusCode();

        if (HttpResponse::HTTP_CREATED !== $statusCode || ! $checksum) {
            throw new FileException('Unable to create resource.');
        }

        return $checksum;
    }

    /**
     * Concatenate 2 or more partial uploads.
     *
     * @param string $key
     * @param mixed  $partials
     *
     * @return string
     */
    public function concat(string $key, ...$partials) : string
    {
        $response = $this->getClient()->post($this->apiPath, [
            'headers' => [
                'Upload-Length' => $this->fileSize,
                'Upload-Key' => $key,
                'Upload-Checksum' => $this->getUploadChecksumHeader(),
                'Upload-Metadata' => 'filename ' . base64_encode($this->fileName),
                'Upload-Concat' => self::UPLOAD_TYPE_FINAL . ';' . implode(' ', $partials),
            ],
        ]);

        $data       = json_decode($response->getBody(), true);
        $checksum   = $data['data']['checksum'] ?? null;
        $statusCode = $response->getStatusCode();

        if (HttpResponse::HTTP_CREATED !== $statusCode || ! $checksum) {
            throw new FileException('Unable to create resource.');
        }

        return $checksum;
    }

    /**
     * Send DELETE request.
     *
     * @param string $key
     *
     * @throws FileException
     *
     * @return void
     */
    public function delete(string $key)
    {
        try {
            $this->getClient()->delete($this->apiPath . '/' . $key, [
                'headers' => [
                    'Tus-Resumable' => self::TUS_PROTOCOL_VERSION,
                ],
            ]);
        } catch (ClientException $e) {
            $statusCode = $e->getResponse()->getStatusCode();

            if (HttpResponse::HTTP_NOT_FOUND === $statusCode || HttpResponse::HTTP_GONE === $statusCode) {
                throw new FileException('File not found.');
            }
        }
    }

    /**
     * Set as partial request.
     *
     * @param bool $state
     *
     * @return void
     */
    protected function partial(bool $state = true)
    {
        $this->partial = $state;

        if ( ! $this->partial) {
            return;
        }

        $key = $this->getKey();

        if (false !== strpos($key, self::PARTIAL_UPLOAD_NAME_SEPARATOR)) {
            list($key) = explode(self::PARTIAL_UPLOAD_NAME_SEPARATOR, $key);
        }

        $this->key = $key . uniqid(self::PARTIAL_UPLOAD_NAME_SEPARATOR);
    }

    /**
     * Send HEAD request.
     *
     * @param string $key
     *
     * @throws FileException
     *
     * @return int
     */
    protected function sendHeadRequest(string $key) : int
    {
        $response = $this->getClient()->head($this->apiPath . '/' . $key);

        $statusCode = $response->getStatusCode();

        if (HttpResponse::HTTP_OK !== $statusCode) {
            throw new FileException('File not found.');
        }

        return (int) current($response->getHeader('upload-offset'));
    }

    /**
     * Send PATCH request.
     *
     * @param string $key
     * @param int    $bytes
     *
     * @throws Exception
     * @throws FileException
     * @throws ConnectionException
     *
     * @return int
     */
    protected function sendPatchRequest(string $key, int $bytes) : int
    {
        $data    = $this->getData($key, $bytes);
        $headers = [
            'Content-Type' => 'application/offset+octet-stream',
            'Content-Length' => strlen($data),
            'Upload-Checksum' => $this->getUploadChecksumHeader(),
        ];

        if ($this->isPartial()) {
            $headers += ['Upload-Concat' => self::UPLOAD_TYPE_PARTIAL];
        }

        try {
            $response = $this->getClient()->patch($this->apiPath . '/' . $key, [
                'body' => $data,
                'headers' => $headers,
            ]);

            return (int) current($response->getHeader('upload-offset'));
        } catch (ClientException $e) {
            $statusCode = $e->getResponse()->getStatusCode();

            if (HttpResponse::HTTP_REQUESTED_RANGE_NOT_SATISFIABLE === $statusCode) {
                throw new FileException('The uploaded file is corrupt.');
            }

            if (HttpResponse::HTTP_CONTINUE === $statusCode) {
                throw new ConnectionException('Connection aborted by user.');
            }

            throw new Exception($e->getResponse()->getBody(), $statusCode);
        } catch (ConnectException $e) {
            throw new ConnectionException("Couldn't connect to server.");
        }
    }

    /**
     * Get X bytes of data from file.
     *
     * @param string $key
     * @param int    $bytes
     *
     * @return string
     */
    protected function getData(string $key, int $bytes) : string
    {
        $file   = new File;
        $handle = $file->open($this->getFilePath(), $file::READ_BINARY);
        $offset = $this->partialOffset;

        if ($offset < 0) {
            $fileMeta = $this->getCache()->get($key);
            $offset   = $fileMeta['offset'];
        }

        $file->seek($handle, $offset);

        $data = $file->read($handle, $bytes);

        $file->close($handle);

        return (string) $data;
    }

    /**
     * Get upload checksum header.
     *
     * @return string
     */
    protected function getUploadChecksumHeader() : string
    {
        return $this->getChecksumAlgorithm() . ' ' . base64_encode($this->getChecksum());
    }
}


1		<?php
2
3		namespace TusPhp\Tus;
4
5		use TusPhp\File;
6		use TusPhp\Cache\Cacheable;
7		use TusPhp\Exception\Exception;
8		use TusPhp\Exception\FileException;
9		use GuzzleHttp\Client as GuzzleClient;
10		use GuzzleHttp\Exception\ClientException;
11		use TusPhp\Exception\ConnectionException;
12		use GuzzleHttp\Exception\ConnectException;
13		use Illuminate\Http\Response as HttpResponse;
14
15		class Client extends AbstractTus
16		{
17		/** @var GuzzleClient */
18		protected $client;
19
20		/** @var string */
21		protected $filePath;
22
23		/** @var int */
24		protected $fileSize;
25
26		/** @var string */
27		protected $fileName;
28
29		/** @var string */
30		protected $key;
31
32		/** @var string */
33		protected $checksum;
34
35		/** @var int */
36		protected $partialOffset = -1;
37
38		/** @var bool */
39		protected $partial = false;
40
41		/** @var string */
42		protected $checksumAlgorithm = 'sha256';
43
44		/**
45		* Client constructor.
46		*
47		* @param string $baseUrl
48		* @param Cacheable\|string $cacheAdapter
49		*/
50	1	public function __construct(string $baseUrl, $cacheAdapter = 'file')
51		{
52	1	$this->client = new GuzzleClient([
53	1	'base_uri' => $baseUrl,
54		]);
55
56	1	$this->setCache($cacheAdapter);
57	1	}
58
59		/**
60		* Set file properties.
61		*
62		* @param string $file File path.
63		* @param string $name File name.
64		*
65		* @return Client
66		*/
67	3	public function file(string $file, string $name = null) : self
68		{
69	3	$this->filePath = $file;
70
71	3	if ( ! file_exists($file) \|\| ! is_readable($file)) {
72	2	throw new FileException('Cannot read file: ' . $file);
73		}
74
75	1	$this->fileName = $name ?? basename($this->filePath);
76	1	$this->fileSize = filesize($file);
77
78	1	return $this;
79		}
80
81		/**
82		* Get file path.
83		*
84		* @return string\|null
85		*/
86	1	public function getFilePath()
87		{
88	1	return $this->filePath;
89		}
90
91		/**
92		* Set file name.
93		*
94		* @param string $name
95		*
96		* @return Client
97		*/
98	1	public function setFileName(string $name) : self
99		{
100	1	$this->fileName = $name;
101
102	1	return $this;
103		}
104
105		/**
106		* Get file name.
107		*
108		* @return string\|null
109		*/
110	2	public function getFileName()
111		{
112	2	return $this->fileName;
113		}
114
115		/**
116		* Get file size.
117		*
118		* @return int\|null
119		*/
120	1	public function getFileSize()
121		{
122	1	return $this->fileSize;
123		}
124
125		/**
126		* Get guzzle client.
127		*
128		* @return GuzzleClient
129		*/
130	1	public function getClient() : GuzzleClient
131		{
132	1	return $this->client;
133		}
134
135		/**
136		* Get checksum.
137		*
138		* @return string
139		*/
140	1	public function getChecksum() : string
141		{
142	1	if (empty($this->checksum)) {
143	1	$this->checksum = hash_file($this->getChecksumAlgorithm(), $this->getFilePath());
144		}
145
146	1	return $this->checksum;
147		}
148
149		/**
150		* Set key.
151		*
152		* @param string $key
153		*
154		* @return Client
155		*/
156	1	public function setKey(string $key) : self
157		{
158	1	$this->key = $key;
159
160	1	return $this;
161		}
162
163		/**
164		* Get key.
165		*
166		* @return string
167		*/
168	1	public function getKey() : string
169		{
170	1	return $this->key;
171		}
172
173		/**
174		* Set checksum algorithm.
175		*
176		* @param string $algorithm
177		*
178		* @return Client
179		*/
180	1	public function setChecksumAlgorithm(string $algorithm) : self
181		{
182	1	$this->checksumAlgorithm = $algorithm;
183
184	1	return $this;
185		}
186
187		/**
188		* Get checksum algorithm.
189		*
190		* @return string
191		*/
192	1	public function getChecksumAlgorithm() : string
193		{
194	1	return $this->checksumAlgorithm;
195		}
196
197		/**
198		* Check if this is a partial upload request.
199		*
200		* @return bool
201		*/
202	2	public function isPartial() : bool
203		{
204	2	return $this->partial;
205		}
206
207		/**
208		* Get partial offset.
209		*
210		* @return int
211		*/
212	1	public function getPartialOffset() : int
213		{
214	1	return $this->partialOffset;
215		}
216
217		/**
218		* Set offset and force this to be a partial upload request.
219		*
220		* @param int $offset
221		*
222		* @return self
223		*/
224	1	public function seek(int $offset) : self
225		{
226	1	$this->partialOffset = $offset;
227
228	1	$this->partial();
229
230	1	return $this;
231		}
232
233		/**
234		* Upload file.
235		*
236		* @param int $bytes Bytes to upload
237		*
238		* @throws ConnectionException
239		*
240		* @return int
241		*/
242	5	public function upload(int $bytes = -1) : int
243		{
244	5	$bytes = $bytes < 0 ? $this->getFileSize() : $bytes;
245	5	$key = $this->getKey();
246
247		try {
248		// Check if this upload exists with HEAD request
249	5	$this->sendHeadRequest($key);
250	3	} catch (FileException \| ClientException $e) {
251	2	$this->create($key);
252	1	} catch (ConnectException $e) {
253	1	throw new ConnectionException("Couldn't connect to server.");
254		}
255
256		// Now, resume upload with PATCH request
257	4	return $this->sendPatchRequest($key, $bytes);
258		}
259
260		/**
261		* Returns offset if file is partially uploaded.
262		*
263		* @return bool\|int
264		*/
265	3	public function getOffset()
266		{
267	3	$key = $this->getKey();
268
269		try {
270	3	$offset = $this->sendHeadRequest($key);
271	2	} catch (FileException \| ClientException $e) {
272	2	return false;
273		}
274
275	1	return $offset;
276		}
277
278		/**
279		* Create resource with POST request.
280		*
281		* @param string $key
282		*
283		* @throws FileException
284		*
285		* @return string
286		*/
287	4	public function create(string $key) : string
288		{
289		$headers = [
290	4	'Upload-Length' => $this->fileSize,
291	4	'Upload-Key' => $key,
292	4	'Upload-Checksum' => $this->getUploadChecksumHeader(),
293	4	'Upload-Metadata' => 'filename ' . base64_encode($this->fileName),
294		];
295
296	4	if ($this->isPartial()) {
297	1	$headers += ['Upload-Concat' => 'partial'];
298		}
299
300	4	$response = $this->getClient()->post($this->apiPath, [
301	4	'headers' => $headers,
302		]);
303
304	4	$data = json_decode($response->getBody(), true);
305	4	$checksum = $data['data']['checksum'] ?? null;
306	4	$statusCode = $response->getStatusCode();
307
308	4	if (HttpResponse::HTTP_CREATED !== $statusCode \|\| ! $checksum) {
309	2	throw new FileException('Unable to create resource.');
310		}
311
312	2	return $checksum;
313		}
314
315		/**
316		* Concatenate 2 or more partial uploads.
317		*
318		* @param string $key
319		* @param mixed $partials
320		*
321		* @return string
322		*/
323	3	public function concat(string $key, ...$partials) : string
324		{
325	3	$response = $this->getClient()->post($this->apiPath, [
326		'headers' => [
327	3	'Upload-Length' => $this->fileSize,
328	3	'Upload-Key' => $key,
329	3	'Upload-Checksum' => $this->getUploadChecksumHeader(),
330	3	'Upload-Metadata' => 'filename ' . base64_encode($this->fileName),
331	3	'Upload-Concat' => self::UPLOAD_TYPE_FINAL . ';' . implode(' ', $partials),
332		],
333		]);
334
335	3	$data = json_decode($response->getBody(), true);
336	3	$checksum = $data['data']['checksum'] ?? null;
337	3	$statusCode = $response->getStatusCode();
338
339	3	if (HttpResponse::HTTP_CREATED !== $statusCode \|\| ! $checksum) {
340	2	throw new FileException('Unable to create resource.');
341		}
342
343	1	return $checksum;
344		}
345
346		/**
347		* Send DELETE request.
348		*
349		* @param string $key
350		*
351		* @throws FileException
352		*
353		* @return void
354		*/
355	3	public function delete(string $key)
356		{
357		try {
358	3	$this->getClient()->delete($this->apiPath . '/' . $key, [
359		'headers' => [
360	3	'Tus-Resumable' => self::TUS_PROTOCOL_VERSION,
361		],
362		]);
363	2	} catch (ClientException $e) {
364	2	$statusCode = $e->getResponse()->getStatusCode();
365
366	2	if (HttpResponse::HTTP_NOT_FOUND === $statusCode \|\| HttpResponse::HTTP_GONE === $statusCode) {
367	2	throw new FileException('File not found.');
368		}
369		}
370	1	}
371
372		/**
373		* Set as partial request.
374		*
375		* @param bool $state
376		*
377		* @return void
378		*/
379	3	protected function partial(bool $state = true)
380		{
381	3	$this->partial = $state;
382
383	3	if ( ! $this->partial) {
384	1	return;
385		}
386
387	2	$key = $this->getKey();
388
389	2	if (false !== strpos($key, self::PARTIAL_UPLOAD_NAME_SEPARATOR)) {
390	1	list($key) = explode(self::PARTIAL_UPLOAD_NAME_SEPARATOR, $key);
391		}
392
393	2	$this->key = $key . uniqid(self::PARTIAL_UPLOAD_NAME_SEPARATOR);
394	2	}
395
396		/**
397		* Send HEAD request.
398		*
399		* @param string $key
400		*
401		* @throws FileException
402		*
403		* @return int
404		*/
405	2	protected function sendHeadRequest(string $key) : int
406		{
407	2	$response = $this->getClient()->head($this->apiPath . '/' . $key);
408
409	2	$statusCode = $response->getStatusCode();
410
411	2	if (HttpResponse::HTTP_OK !== $statusCode) {
412	1	throw new FileException('File not found.');
413		}
414
415	1	return (int) current($response->getHeader('upload-offset'));
416		}
417
418		/**
419		* Send PATCH request.
420		*
421		* @param string $key
422		* @param int $bytes
423		*
424		* @throws Exception
425		* @throws FileException
426		* @throws ConnectionException
427		*
428		* @return int
429		*/
430	6	protected function sendPatchRequest(string $key, int $bytes) : int
431		{
432	6	$data = $this->getData($key, $bytes);
433		$headers = [
434	6	'Content-Type' => 'application/offset+octet-stream',
435	6	'Content-Length' => strlen($data),
436	6	'Upload-Checksum' => $this->getUploadChecksumHeader(),
437		];
438
439	6	if ($this->isPartial()) {
440	1	$headers += ['Upload-Concat' => self::UPLOAD_TYPE_PARTIAL];
441		}
442
443		try {
444	6	$response = $this->getClient()->patch($this->apiPath . '/' . $key, [
445	6	'body' => $data,
446	6	'headers' => $headers,
447		]);
448
449	2	return (int) current($response->getHeader('upload-offset'));
450	4	} catch (ClientException $e) {
451	3	$statusCode = $e->getResponse()->getStatusCode();
452
453	3	if (HttpResponse::HTTP_REQUESTED_RANGE_NOT_SATISFIABLE === $statusCode) {
454	1	throw new FileException('The uploaded file is corrupt.');
455		}
456
457	2	if (HttpResponse::HTTP_CONTINUE === $statusCode) {
458	1	throw new ConnectionException('Connection aborted by user.');
459		}
460
461	1	throw new Exception($e->getResponse()->getBody(), $statusCode);
462	1	} catch (ConnectException $e) {
463	1	throw new ConnectionException("Couldn't connect to server.");
464		}
465		}
466
467		/**
468		* Get X bytes of data from file.
469		*
470		* @param string $key
471		* @param int $bytes
472		*
473		* @return string
474		*/
475	2	protected function getData(string $key, int $bytes) : string
476		{
477	2	$file = new File;
478	2	$handle = $file->open($this->getFilePath(), $file::READ_BINARY);
479	2	$offset = $this->partialOffset;
480
481	2	if ($offset < 0) {
482	2	$fileMeta = $this->getCache()->get($key);
483	2	$offset = $fileMeta['offset'];
484		}
485
486	2	$file->seek($handle, $offset);
487
488	2	$data = $file->read($handle, $bytes);
489
490	2	$file->close($handle);
491
492	2	return (string) $data;
493		}
494
495		/**
496		* Get upload checksum header.
497		*
498		* @return string
499		*/
500	1	protected function getUploadChecksumHeader() : string
501		{
502	1	return $this->getChecksumAlgorithm() . ' ' . base64_encode($this->getChecksum());
503		}
504		}
505

ankitpokhrel / tus-php

Push — master ( 664d8f...1716c0 )

Client::getKey() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like