Client::file() - Code Metrics - Inspection of "[Security Fix] CVE-2018-11386" - ankitpokhrel/tus-php - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 766963...aceb5e )

by Ankit

created 2018-06-24 15:08 UTC

Client::file() A

↳ Parent: Client

Complexity

Conditions	3
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	7
CRAP Score	3

Importance

Changes

Metric	Value
cc	3
nc	2
nop	2
dl	0
loc	12
ccs	7
cts	7
cp	1
crap	3
rs	9.8666
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 Symfony\Component\HttpFoundation\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 void
     */
    public function create(string $key)
    {
        $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,
        ]);

        $statusCode = $response->getStatusCode();

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

    /**
     * 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, /* $partialKey */) = 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 Symfony\Component\HttpFoundation\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 void
286		*/
287	3	public function create(string $key)
288		{
289		$headers = [
290	3	'Upload-Length' => $this->fileSize,
291	3	'Upload-Key' => $key,
292	3	'Upload-Checksum' => $this->getUploadChecksumHeader(),
293	3	'Upload-Metadata' => 'filename ' . base64_encode($this->fileName),
294		];
295
296	3	if ($this->isPartial()) {
297	1	$headers += ['Upload-Concat' => 'partial'];
298		}
299
300	3	$response = $this->getClient()->post($this->apiPath, [
301	3	'headers' => $headers,
302		]);
303
304	3	$statusCode = $response->getStatusCode();
305
306	3	if (HttpResponse::HTTP_CREATED !== $statusCode) {
307	1	throw new FileException('Unable to create resource.');
308		}
309	2	}
310
311		/**
312		* Concatenate 2 or more partial uploads.
313		*
314		* @param string $key
315		* @param mixed $partials
316		*
317		* @return string
318		*/
319	3	public function concat(string $key, ...$partials) : string
320		{
321	3	$response = $this->getClient()->post($this->apiPath, [
322		'headers' => [
323	3	'Upload-Length' => $this->fileSize,
324	3	'Upload-Key' => $key,
325	3	'Upload-Checksum' => $this->getUploadChecksumHeader(),
326	3	'Upload-Metadata' => 'filename ' . base64_encode($this->fileName),
327	3	'Upload-Concat' => self::UPLOAD_TYPE_FINAL . ';' . implode(' ', $partials),
328		],
329		]);
330
331	3	$data = json_decode($response->getBody(), true);
332	3	$checksum = $data['data']['checksum'] ?? null;
333	3	$statusCode = $response->getStatusCode();
334
335	3	if (HttpResponse::HTTP_CREATED !== $statusCode \|\| ! $checksum) {
336	2	throw new FileException('Unable to create resource.');
337		}
338
339	1	return $checksum;
340		}
341
342		/**
343		* Send DELETE request.
344		*
345		* @param string $key
346		*
347		* @throws FileException
348		*
349		* @return void
350		*/
351	3	public function delete(string $key)
352		{
353		try {
354	3	$this->getClient()->delete($this->apiPath . '/' . $key, [
355		'headers' => [
356	3	'Tus-Resumable' => self::TUS_PROTOCOL_VERSION,
357		],
358		]);
359	2	} catch (ClientException $e) {
360	2	$statusCode = $e->getResponse()->getStatusCode();
361
362	2	if (HttpResponse::HTTP_NOT_FOUND === $statusCode \|\| HttpResponse::HTTP_GONE === $statusCode) {
363	2	throw new FileException('File not found.');
364		}
365		}
366	1	}
367
368		/**
369		* Set as partial request.
370		*
371		* @param bool $state
372		*
373		* @return void
374		*/
375	3	protected function partial(bool $state = true)
376		{
377	3	$this->partial = $state;
378
379	3	if ( ! $this->partial) {
380	1	return;
381		}
382
383	2	$key = $this->getKey();
384
385	2	if (false !== strpos($key, self::PARTIAL_UPLOAD_NAME_SEPARATOR)) {
386	1	list($key, /* $partialKey */) = explode(self::PARTIAL_UPLOAD_NAME_SEPARATOR, $key);
387		}
388
389	2	$this->key = $key . uniqid(self::PARTIAL_UPLOAD_NAME_SEPARATOR);
390	2	}
391
392		/**
393		* Send HEAD request.
394		*
395		* @param string $key
396		*
397		* @throws FileException
398		*
399		* @return int
400		*/
401	2	protected function sendHeadRequest(string $key) : int
402		{
403	2	$response = $this->getClient()->head($this->apiPath . '/' . $key);
404
405	2	$statusCode = $response->getStatusCode();
406
407	2	if (HttpResponse::HTTP_OK !== $statusCode) {
408	1	throw new FileException('File not found.');
409		}
410
411	1	return (int) current($response->getHeader('upload-offset'));
412		}
413
414		/**
415		* Send PATCH request.
416		*
417		* @param string $key
418		* @param int $bytes
419		*
420		* @throws Exception
421		* @throws FileException
422		* @throws ConnectionException
423		*
424		* @return int
425		*/
426	6	protected function sendPatchRequest(string $key, int $bytes) : int
427		{
428	6	$data = $this->getData($key, $bytes);
429		$headers = [
430	6	'Content-Type' => 'application/offset+octet-stream',
431	6	'Content-Length' => strlen($data),
432	6	'Upload-Checksum' => $this->getUploadChecksumHeader(),
433		];
434
435	6	if ($this->isPartial()) {
436	1	$headers += ['Upload-Concat' => self::UPLOAD_TYPE_PARTIAL];
437		}
438
439		try {
440	6	$response = $this->getClient()->patch($this->apiPath . '/' . $key, [
441	6	'body' => $data,
442	6	'headers' => $headers,
443		]);
444
445	2	return (int) current($response->getHeader('upload-offset'));
446	4	} catch (ClientException $e) {
447	3	$statusCode = $e->getResponse()->getStatusCode();
448
449	3	if (HttpResponse::HTTP_REQUESTED_RANGE_NOT_SATISFIABLE === $statusCode) {
450	1	throw new FileException('The uploaded file is corrupt.');
451		}
452
453	2	if (HttpResponse::HTTP_CONTINUE === $statusCode) {
454	1	throw new ConnectionException('Connection aborted by user.');
455		}
456
457	1	throw new Exception($e->getResponse()->getBody(), $statusCode);
458	1	} catch (ConnectException $e) {
459	1	throw new ConnectionException("Couldn't connect to server.");
460		}
461		}
462
463		/**
464		* Get X bytes of data from file.
465		*
466		* @param string $key
467		* @param int $bytes
468		*
469		* @return string
470		*/
471	2	protected function getData(string $key, int $bytes) : string
472		{
473	2	$file = new File;
474	2	$handle = $file->open($this->getFilePath(), $file::READ_BINARY);
475	2	$offset = $this->partialOffset;
476
477	2	if ($offset < 0) {
478	2	$fileMeta = $this->getCache()->get($key);
479	2	$offset = $fileMeta['offset'];
480		}
481
482	2	$file->seek($handle, $offset);
483
484	2	$data = $file->read($handle, $bytes);
485
486	2	$file->close($handle);
487
488	2	return (string) $data;
489		}
490
491		/**
492		* Get upload checksum header.
493		*
494		* @return string
495		*/
496	1	protected function getUploadChecksumHeader() : string
497		{
498	1	return $this->getChecksumAlgorithm() . ' ' . base64_encode($this->getChecksum());
499		}
500		}
501

ankitpokhrel / tus-php

Push — master ( 766963...aceb5e )

Client::file() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like