Server::serve() - Code Metrics - Inspection of "Add basic middleware support" - ankitpokhrel/tus-php - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#31)

by Ankit

created 2018-04-08 08:54 UTC

Server::serve() A

↳ Parent: Server

Complexity

Conditions	2
Paths	2

Size

Total Lines	13
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	7
CRAP Score	2

Importance

Changes

Metric	Value
cc	2
eloc	6
nc	2
nop	0
dl	0
loc	13
ccs	7
cts	7
cp	1
crap	2
rs	9.4285
c	0
b	0
f	0

<?php

namespace TusPhp\Tus;

use TusPhp\File;
use Carbon\Carbon;
use TusPhp\Request;
use TusPhp\Response;
use Ramsey\Uuid\Uuid;
use TusPhp\Cache\Cacheable;
use TusPhp\Middleware\Middleware;
use TusPhp\Exception\FileException;
use TusPhp\Exception\ConnectionException;
use TusPhp\Exception\OutOfRangeException;
use Illuminate\Http\Response as HttpResponse;
use Symfony\Component\HttpFoundation\BinaryFileResponse;

class Server extends AbstractTus
{
    /** @const string Tus Creation Extension */
    const TUS_EXTENSION_CREATION = 'creation';

    /** @const string Tus Termination Extension */
    const TUS_EXTENSION_TERMINATION = 'termination';

    /** @const string Tus Checksum Extension */
    const TUS_EXTENSION_CHECKSUM = 'checksum';

    /** @const string Tus Expiration Extension */
    const TUS_EXTENSION_EXPIRATION = 'expiration';

    /** @const string Tus Concatenation Extension */
    const TUS_EXTENSION_CONCATENATION = 'concatenation';

    /** @const array All supported tus extensions */
    const TUS_EXTENSIONS = [
        self::TUS_EXTENSION_CREATION,
        self::TUS_EXTENSION_TERMINATION,
        self::TUS_EXTENSION_CHECKSUM,
        self::TUS_EXTENSION_EXPIRATION,
        self::TUS_EXTENSION_CONCATENATION,
    ];

    /** @const int 460 Checksum Mismatch */
    const HTTP_CHECKSUM_MISMATCH = 460;

    /** @const string Default checksum algorithm */
    const DEFAULT_CHECKSUM_ALGORITHM = 'sha256';

    /** @const int 24 hours access control max age header */
    const HEADER_ACCESS_CONTROL_MAX_AGE = 86400;

    /** @var Request */
    protected $request;

    /** @var Response */
    protected $response;

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

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

    /** @var array */
    protected $middleware;

    /**
     * @var int Max upload size in bytes
     *          Default 0, no restriction.
     */
    protected $maxUploadSize = 0;

    /**
     * TusServer constructor.
     *
     * @param Cacheable|string $cacheAdapter
     */
    public function __construct($cacheAdapter = 'file')
    {
        $this->request   = new Request;
        $this->response  = new Response;
        $this->uploadDir = dirname(__DIR__, 2) . DIRECTORY_SEPARATOR . 'uploads';

        $this->middleware = new Middleware();


        $this->setCache($cacheAdapter);
    }

    /**
     * Set upload dir.
     *
     * @param string $path
     *
     * @return Server
     */
    public function setUploadDir(string $path) : self
    {
        $this->uploadDir = $path;

        return $this;
    }

    /**
     * Get upload dir.
     *
     * @return string
     */
    public function getUploadDir() : string
    {
        return $this->uploadDir;
    }

    /**
     * Get request.
     *
     * @return Request
     */
    public function getRequest() : Request
    {
        return $this->request;
    }

    /**
     * Get request.
     *
     * @return Response
     */
    public function getResponse() : Response
    {
        return $this->response;
    }

    /**
     * Get file checksum.
     *
     * @param string $filePath
     *
     * @return string
     */
    public function getServerChecksum(string $filePath) : string
    {
        return hash_file($this->getChecksumAlgorithm(), $filePath);
    }

    /**
     * Get checksum algorithm.
     *
     * @return string|null
     */
    public function getChecksumAlgorithm()
    {
        $checksumHeader = $this->getRequest()->header('Upload-Checksum');

        if (empty($checksumHeader)) {
            return self::DEFAULT_CHECKSUM_ALGORITHM;
        }

        list($checksumAlgorithm) = explode(' ', $checksumHeader);

        return $checksumAlgorithm;
    }

    /**
     * Set upload key.
     *
     * @param string $key
     *
     * @return Server
     */
    public function setUploadKey(string $key) : self
    {
        $this->uploadKey = $key;

        return $this;
    }

    /**
     * Get upload key from header.
     *
     * @return string|HttpResponse
     */
    public function getUploadKey()
    {
        if ( ! empty($this->uploadKey)) {
            return $this->uploadKey;
        }

        $key = $this->getRequest()->header('Upload-Key') ?? Uuid::uuid4()->toString();

        if (empty($key)) {
            return $this->response->send(null, HttpResponse::HTTP_BAD_REQUEST);
        }

        $this->uploadKey = $key;

        return $this->uploadKey;
    }

    /**
     * Set middleware.
     *
     * @param Middleware $middleware
     *
     * @return self
     */
    public function setMiddleware(Middleware $middleware) : self
    {
        $this->middleware = $middleware;


        return $this;
    }

    /**
     * Get middleware.
     *
     * @return Middleware
     */
    public function middleware() : Middleware
    {
        return $this->middleware;

    }

    /**
     * Set max upload size.
     *
     * @param int $uploadSize
     *
     * @return Server
     */
    public function setMaxUploadSize(int $uploadSize) : self
    {
        $this->maxUploadSize = $uploadSize;

        return $this;
    }

    /**
     * Get max upload size.
     *
     * @return int
     */
    public function getMaxUploadSize() : int
    {
        return $this->maxUploadSize;
    }

    /**
     * Handle all HTTP request.
     *
     * @return HttpResponse
     */
    public function serve() : HttpResponse
    {
        $requestMethod = $this->getRequestMethod();

        if ( ! in_array($requestMethod, $this->getRequest()->allowedHttpVerbs())) {
            return $this->response->send(null, HttpResponse::HTTP_METHOD_NOT_ALLOWED);
        }

        $this->applyMiddleware();

        $method = 'handle' . ucfirst(strtolower($requestMethod));

        return $this->{$method}();
    }

    /**
     * Get actual request method.
     *
     * @return null|string
     */
    protected function getRequestMethod()
    {
        $request = $this->getRequest();

        $requestMethod = $request->method();

        // Allow overriding the HTTP method. The reason for this is
        // that some libraries/environments do not support PATCH and
        // DELETE requests, e.g. Flash in a browser and parts of Java.
        $newMethod = $request->header('X-HTTP-Method-Override');

        if ( ! empty($newMethod)) {
            $requestMethod = $newMethod;
        }

        return $requestMethod;
    }

    /**
     * Apply middleware.
     *
     * @return null
     */
    protected function applyMiddleware()
    {
        $middleware = $this->middleware()->list();

        foreach ($middleware as $m) {
            $m->handle($this->getRequest(), $this->getResponse());
        }
    }

    /**
     * Handle OPTIONS request.
     *
     * @return HttpResponse
     */
    protected function handleOptions() : HttpResponse
    {
        $headers = [
            'Allow' => implode(',', $this->request->allowedHttpVerbs()),
            'Tus-Version' => self::TUS_PROTOCOL_VERSION,
            'Tus-Extension' => implode(',', self::TUS_EXTENSIONS),
            'Tus-Checksum-Algorithm' => $this->getSupportedHashAlgorithms(),
        ];

        $maxUploadSize = $this->getMaxUploadSize();

        if ($maxUploadSize > 0) {
            $headers['Tus-Max-Size'] = $maxUploadSize;
        }

        return $this->response->send(null, HttpResponse::HTTP_OK, $headers);
    }

    /**
     * Handle HEAD request.
     *
     * @return HttpResponse
     */
    protected function handleHead() : HttpResponse
    {
        $key = $this->request->key();

        if ( ! $fileMeta = $this->cache->get($key)) {
            return $this->response->send(null, HttpResponse::HTTP_NOT_FOUND);
        }

        $offset = $fileMeta['offset'] ?? false;

        if (false === $offset) {
            return $this->response->send(null, HttpResponse::HTTP_GONE);
        }

        return $this->response->send(null, HttpResponse::HTTP_OK, $this->getHeadersForHeadRequest($fileMeta));
    }

    /**
     * Handle POST request.
     *
     * @return HttpResponse
     */
    protected function handlePost() : HttpResponse
    {
        $fileName   = $this->getRequest()->extractFileName();
        $uploadType = self::UPLOAD_TYPE_NORMAL;

        if (empty($fileName)) {
            return $this->response->send(null, HttpResponse::HTTP_BAD_REQUEST);
        }

        if ( ! $this->verifyUploadSize()) {
            return $this->response->send(null, HttpResponse::HTTP_REQUEST_ENTITY_TOO_LARGE);
        }

        $uploadKey = $this->getUploadKey();
        $filePath  = $this->uploadDir . DIRECTORY_SEPARATOR . $fileName;

        if ($this->getRequest()->isFinal()) {
            return $this->handleConcatenation($fileName, $filePath);
        }

        if ($this->getRequest()->isPartial()) {
            $filePath   = $this->getPathForPartialUpload($uploadKey) . $fileName;
            $uploadType = self::UPLOAD_TYPE_PARTIAL;
        }

        $checksum = $this->getClientChecksum();
        $location = $this->getRequest()->url() . $this->getApiPath() . '/' . $uploadKey;

        $file = $this->buildFile([
            'name' => $fileName,
            'offset' => 0,
            'size' => $this->getRequest()->header('Upload-Length'),
            'file_path' => $filePath,
            'location' => $location,
        ])->setChecksum($checksum);

        $this->cache->set($uploadKey, $file->details() + ['upload_type' => $uploadType]);

        return $this->response->send(
            ['data' => ['checksum' => $checksum]],
            HttpResponse::HTTP_CREATED,
            [
                'Location' => $location,
                'Upload-Expires' => $this->cache->get($uploadKey)['expires_at'],
            ]
        );
    }

    /**
     * Handle file concatenation.
     *
     * @param string $fileName
     * @param string $filePath
     *
     * @return HttpResponse
     */
    protected function handleConcatenation(string $fileName, string $filePath) : HttpResponse
    {
        $partials  = $this->getRequest()->extractPartials();
        $uploadKey = $this->getUploadKey();
        $files     = $this->getPartialsMeta($partials);
        $filePaths = array_column($files, 'file_path');
        $location  = $this->getRequest()->url() . $this->getApiPath() . '/' . $uploadKey;

        $file = $this->buildFile([
            'name' => $fileName,
            'offset' => 0,
            'size' => 0,
            'file_path' => $filePath,
            'location' => $location,
        ])->setFilePath($filePath);

        $file->setOffset($file->merge($files));

        // Verify checksum.
        $checksum = $this->getServerChecksum($filePath);

        if ($checksum !== $this->getClientChecksum()) {
            return $this->response->send(null, self::HTTP_CHECKSUM_MISMATCH);
        }

        $this->cache->set($uploadKey, $file->details() + ['upload_type' => self::UPLOAD_TYPE_FINAL]);

        // Cleanup.
        if ($file->delete($filePaths, true)) {
            $this->cache->deleteAll($partials);
        }

        return $this->response->send(
            ['data' => ['checksum' => $checksum]],
            HttpResponse::HTTP_CREATED,
            [
                'Location' => $location,
            ]
        );
    }

    /**
     * Handle PATCH request.
     *
     * @return HttpResponse
     */
    protected function handlePatch() : HttpResponse
    {
        $uploadKey = $this->request->key();

        if ( ! $meta = $this->cache->get($uploadKey)) {
            return $this->response->send(null, HttpResponse::HTTP_GONE);
        }

        if (self::UPLOAD_TYPE_FINAL === $meta['upload_type']) {
            return $this->response->send(null, HttpResponse::HTTP_FORBIDDEN);
        }

        $file     = $this->buildFile($meta);
        $checksum = $meta['checksum'];

        try {
            $fileSize = $file->getFileSize();
            $offset   = $file->setKey($uploadKey)->setChecksum($checksum)->upload($fileSize);

            // If upload is done, verify checksum.
            if ($offset === $fileSize && ! $this->verifyChecksum($checksum, $meta['file_path'])) {
                return $this->response->send(null, self::HTTP_CHECKSUM_MISMATCH);
            }
        } catch (FileException $e) {
            return $this->response->send($e->getMessage(), HttpResponse::HTTP_UNPROCESSABLE_ENTITY);
        } catch (OutOfRangeException $e) {
            return $this->response->send(null, HttpResponse::HTTP_REQUESTED_RANGE_NOT_SATISFIABLE);
        } catch (ConnectionException $e) {
            return $this->response->send(null, HttpResponse::HTTP_CONTINUE);
        }

        return $this->response->send(null, HttpResponse::HTTP_NO_CONTENT, [
            'Content-Type' => 'application/offset+octet-stream',
            'Upload-Expires' => $this->cache->get($uploadKey)['expires_at'],
            'Upload-Offset' => $offset,
        ]);
    }

    /**
     * Handle GET request.
     *
     * @return BinaryFileResponse|HttpResponse
     */
    protected function handleGet()
    {
        $key = $this->request->key();

        if (empty($key)) {
            return $this->response->send('400 bad request.', HttpResponse::HTTP_BAD_REQUEST);
        }

        if ( ! $fileMeta = $this->cache->get($key)) {
            return $this->response->send('404 upload not found.', HttpResponse::HTTP_NOT_FOUND);
        }

        $resource = $fileMeta['file_path'] ?? null;
        $fileName = $fileMeta['name'] ?? null;

        if ( ! $resource || ! file_exists($resource)) {
            return $this->response->send('404 upload not found.', HttpResponse::HTTP_NOT_FOUND);
        }

        return $this->response->download($resource, $fileName);
    }

    /**
     * Handle DELETE request.
     *
     * @return HttpResponse
     */
    protected function handleDelete() : HttpResponse
    {
        $key      = $this->request->key();
        $fileMeta = $this->cache->get($key);
        $resource = $fileMeta['file_path'] ?? null;

        if ( ! $resource) {
            return $this->response->send(null, HttpResponse::HTTP_NOT_FOUND);
        }

        $isDeleted = $this->cache->delete($key);

        if ( ! $isDeleted || ! file_exists($resource)) {
            return $this->response->send(null, HttpResponse::HTTP_GONE);
        }

        unlink($resource);

        return $this->response->send(null, HttpResponse::HTTP_NO_CONTENT, [
            'Tus-Extension' => self::TUS_EXTENSION_TERMINATION,
        ]);
    }

    /**
     * Get required headers for head request.
     *
     * @param array $fileMeta
     *
     * @return array
     */
    protected function getHeadersForHeadRequest(array $fileMeta) : array
    {
        $headers = [
            'Upload-Length' => (int) $fileMeta['size'],
            'Upload-Offset' => (int) $fileMeta['offset'],
            'Cache-Control' => 'no-store',
        ];

        if (self::UPLOAD_TYPE_FINAL === $fileMeta['upload_type'] && $fileMeta['size'] !== $fileMeta['offset']) {
            unset($headers['Upload-Offset']);
        }

        if (self::UPLOAD_TYPE_NORMAL !== $fileMeta['upload_type']) {
            $headers += ['Upload-Concat' => $fileMeta['upload_type']];
        }

        return $headers;
    }

    /**
     * Build file object.
     *
     * @param array $meta
     *
     * @return File
     */
    protected function buildFile(array $meta) : File
    {
        $file = new File($meta['name'], $this->cache);

        if (array_key_exists('offset', $meta)) {
            $file->setMeta($meta['offset'], $meta['size'], $meta['file_path'], $meta['location']);
        }

        return $file;
    }

    /**
     * Get list of supported hash algorithms.
     *
     * @return string
     */
    protected function getSupportedHashAlgorithms() : string
    {
        $supportedAlgorithms = hash_algos();

        $algorithms = [];
        foreach ($supportedAlgorithms as $hashAlgo) {
            if (false !== strpos($hashAlgo, ',')) {
                $algorithms[] = "'{$hashAlgo}'";
            } else {
                $algorithms[] = $hashAlgo;
            }
        }

        return implode(',', $algorithms);
    }

    /**
     * Verify and get upload checksum from header.
     *
     * @return string|HttpResponse
     */
    protected function getClientChecksum()
    {
        $checksumHeader = $this->getRequest()->header('Upload-Checksum');

        if (empty($checksumHeader)) {
            return '';
        }

        list($checksumAlgorithm, $checksum) = explode(' ', $checksumHeader);

        $checksum = base64_decode($checksum);

        if ( ! in_array($checksumAlgorithm, hash_algos()) || false === $checksum) {
            return $this->response->send(null, HttpResponse::HTTP_BAD_REQUEST);
        }

        return $checksum;
    }

    /**
     * Get expired but incomplete uploads.
     *
     * @param array|null $contents
     *
     * @return bool
     */
    protected function isExpired($contents) : bool
    {
        $isExpired = empty($contents['expires_at']) || Carbon::parse($contents['expires_at'])->lt(Carbon::now());

        if ($isExpired && $contents['offset'] !== $contents['size']) {
            return true;
        }

        return false;
    }

    /**
     * Get path for partial upload.
     *
     * @param string $key
     *
     * @return string
     */
    protected function getPathForPartialUpload(string $key) : string
    {
        list($actualKey) = explode(self::PARTIAL_UPLOAD_NAME_SEPARATOR, $key);

        $path = $this->uploadDir . DIRECTORY_SEPARATOR . $actualKey . DIRECTORY_SEPARATOR;

        if ( ! file_exists($path)) {
            mkdir($path);
        }

        return $path;
    }

    /**
     * Get metadata of partials.
     *
     * @param array $partials
     *
     * @return array
     */
    protected function getPartialsMeta(array $partials) : array
    {
        $files = [];

        foreach ($partials as $partial) {
            $fileMeta = $this->getCache()->get($partial);

            $files[] = $fileMeta;
        }

        return $files;
    }

    /**
     * Delete expired resources.
     *
     * @return array
     */
    public function handleExpiration() : array
    {
        $deleted   = [];
        $cacheKeys = $this->cache->keys();

        foreach ($cacheKeys as $key) {
            $fileMeta = $this->cache->get($key, true);

            if ( ! $this->isExpired($fileMeta)) {
                continue;
            }

            if ( ! $this->cache->delete($key)) {
                continue;
            }

            if (is_writable($fileMeta['file_path'])) {
                unlink($fileMeta['file_path']);
            }

            $deleted[] = $fileMeta;
        }

        return $deleted;
    }

    /**
     * Verify max upload size.
     *
     * @return bool
     */
    protected function verifyUploadSize() : bool
    {
        $maxUploadSize = $this->getMaxUploadSize();

        if ($maxUploadSize > 0 && $this->getRequest()->header('Upload-Length') > $maxUploadSize) {
            return false;
        }

        return true;
    }

    /**
     * Verify checksum if available.
     *
     * @param string $checksum
     * @param string $filePath
     *
     * @return bool
     */
    protected function verifyChecksum(string $checksum, string $filePath) : bool
    {
        // Skip if checksum is empty.
        if (empty($checksum)) {
            return true;
        }

        return $checksum === $this->getServerChecksum($filePath);
    }

    /**
     * No other methods are allowed.
     *
     * @param string $method
     * @param array  $params
     *
     * @return HttpResponse|BinaryFileResponse
     */
    public function __call(string $method, array $params)
    {
        return $this->response->send(null, HttpResponse::HTTP_BAD_REQUEST);
    }
}


1		<?php
2
3		namespace TusPhp\Tus;
4
5		use TusPhp\File;
6		use Carbon\Carbon;
7		use TusPhp\Request;
8		use TusPhp\Response;
9		use Ramsey\Uuid\Uuid;
10		use TusPhp\Cache\Cacheable;
11		use TusPhp\Middleware\Middleware;
12		use TusPhp\Exception\FileException;
13		use TusPhp\Exception\ConnectionException;
14		use TusPhp\Exception\OutOfRangeException;
15		use Illuminate\Http\Response as HttpResponse;
16		use Symfony\Component\HttpFoundation\BinaryFileResponse;
17
18		class Server extends AbstractTus
19		{
20		/** @const string Tus Creation Extension */
21		const TUS_EXTENSION_CREATION = 'creation';
22
23		/** @const string Tus Termination Extension */
24		const TUS_EXTENSION_TERMINATION = 'termination';
25
26		/** @const string Tus Checksum Extension */
27		const TUS_EXTENSION_CHECKSUM = 'checksum';
28
29		/** @const string Tus Expiration Extension */
30		const TUS_EXTENSION_EXPIRATION = 'expiration';
31
32		/** @const string Tus Concatenation Extension */
33		const TUS_EXTENSION_CONCATENATION = 'concatenation';
34
35		/** @const array All supported tus extensions */
36		const TUS_EXTENSIONS = [
37		self::TUS_EXTENSION_CREATION,
38		self::TUS_EXTENSION_TERMINATION,
39		self::TUS_EXTENSION_CHECKSUM,
40		self::TUS_EXTENSION_EXPIRATION,
41		self::TUS_EXTENSION_CONCATENATION,
42		];
43
44		/** @const int 460 Checksum Mismatch */
45		const HTTP_CHECKSUM_MISMATCH = 460;
46
47		/** @const string Default checksum algorithm */
48		const DEFAULT_CHECKSUM_ALGORITHM = 'sha256';
49
50		/** @const int 24 hours access control max age header */
51		const HEADER_ACCESS_CONTROL_MAX_AGE = 86400;
52
53		/** @var Request */
54		protected $request;
55
56		/** @var Response */
57		protected $response;
58
59		/** @var string */
60		protected $uploadDir;
61
62		/** @var string */
63		protected $uploadKey;
64
65		/** @var array */
66		protected $middleware;
67
68		/**
69		* @var int Max upload size in bytes
70		* Default 0, no restriction.
71		*/
72		protected $maxUploadSize = 0;
73
74		/**
75		* TusServer constructor.
76		*
77		* @param Cacheable\|string $cacheAdapter
78		*/
79	3	public function __construct($cacheAdapter = 'file')
80		{
81	3	$this->request = new Request;
82	3	$this->response = new Response;
83	3	$this->uploadDir = dirname(__DIR__, 2) . DIRECTORY_SEPARATOR . 'uploads';
84
85	3	$this->middleware = new Middleware();
		0 ignored issues – show Documentation Bug introduced 2018-04-08 08:56 UTC by Report Bug Copy Issue Report It seems like `new TusPhp\Middleware\Middleware()` of type `TusPhp\Middleware\Middleware` is incompatible with the declared type `array` of property `$middleware`. 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...
86
87	3	$this->setCache($cacheAdapter);
88	3	}
89
90		/**
91		* Set upload dir.
92		*
93		* @param string $path
94		*
95		* @return Server
96		*/
97	1	public function setUploadDir(string $path) : self
98		{
99	1	$this->uploadDir = $path;
100
101	1	return $this;
102		}
103
104		/**
105		* Get upload dir.
106		*
107		* @return string
108		*/
109	1	public function getUploadDir() : string
110		{
111	1	return $this->uploadDir;
112		}
113
114		/**
115		* Get request.
116		*
117		* @return Request
118		*/
119	1	public function getRequest() : Request
120		{
121	1	return $this->request;
122		}
123
124		/**
125		* Get request.
126		*
127		* @return Response
128		*/
129	1	public function getResponse() : Response
130		{
131	1	return $this->response;
132		}
133
134		/**
135		* Get file checksum.
136		*
137		* @param string $filePath
138		*
139		* @return string
140		*/
141	1	public function getServerChecksum(string $filePath) : string
142		{
143	1	return hash_file($this->getChecksumAlgorithm(), $filePath);
144		}
145
146		/**
147		* Get checksum algorithm.
148		*
149		* @return string\|null
150		*/
151	1	public function getChecksumAlgorithm()
152		{
153	1	$checksumHeader = $this->getRequest()->header('Upload-Checksum');
154
155	1	if (empty($checksumHeader)) {
156	1	return self::DEFAULT_CHECKSUM_ALGORITHM;
157		}
158
159	1	list($checksumAlgorithm) = explode(' ', $checksumHeader);
160
161	1	return $checksumAlgorithm;
162		}
163
164		/**
165		* Set upload key.
166		*
167		* @param string $key
168		*
169		* @return Server
170		*/
171		public function setUploadKey(string $key) : self
172		{
173		$this->uploadKey = $key;
174
175		return $this;
176		}
177
178		/**
179		* Get upload key from header.
180		*
181		* @return string\|HttpResponse
182		*/
183		public function getUploadKey()
184		{
185		if ( ! empty($this->uploadKey)) {
186		return $this->uploadKey;
187		}
188
189		$key = $this->getRequest()->header('Upload-Key') ?? Uuid::uuid4()->toString();
190
191		if (empty($key)) {
192		return $this->response->send(null, HttpResponse::HTTP_BAD_REQUEST);
193		}
194
195		$this->uploadKey = $key;
196
197		return $this->uploadKey;
198		}
199
200		/**
201		* Set middleware.
202		*
203		* @param Middleware $middleware
204		*
205		* @return self
206		*/
207		public function setMiddleware(Middleware $middleware) : self
208		{
209		$this->middleware = $middleware;
		0 ignored issues – show Documentation Bug introduced 2018-04-08 08:56 UTC by Report Bug Copy Issue Report It seems like `$middleware` of type `TusPhp\Middleware\Middleware` is incompatible with the declared type `array` of property `$middleware`. 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...
210
211		return $this;
212		}
213
214		/**
215		* Get middleware.
216		*
217		* @return Middleware
218		*/
219		public function middleware() : Middleware
220		{
221		return $this->middleware;
		0 ignored issues – show Bug Best Practice introduced 2018-04-08 08:56 UTC by Report Bug Copy Issue Report The expression `return $this->middleware` returns the type `array` which is incompatible with the type-hinted return `TusPhp\Middleware\Middleware`. Loading history...
222		}
223
224		/**
225		* Set max upload size.
226		*
227		* @param int $uploadSize
228		*
229		* @return Server
230		*/
231	1	public function setMaxUploadSize(int $uploadSize) : self
232		{
233	1	$this->maxUploadSize = $uploadSize;
234
235	1	return $this;
236		}
237
238		/**
239		* Get max upload size.
240		*
241		* @return int
242		*/
243	1	public function getMaxUploadSize() : int
244		{
245	1	return $this->maxUploadSize;
246		}
247
248		/**
249		* Handle all HTTP request.
250		*
251		* @return HttpResponse
252		*/
253	3	public function serve() : HttpResponse
254		{
255	3	$requestMethod = $this->getRequestMethod();
256
257	3	if ( ! in_array($requestMethod, $this->getRequest()->allowedHttpVerbs())) {
258	1	return $this->response->send(null, HttpResponse::HTTP_METHOD_NOT_ALLOWED);
259		}
260
261	2	$this->applyMiddleware();
262
263	2	$method = 'handle' . ucfirst(strtolower($requestMethod));
264
265	2	return $this->{$method}();
266		}
267
268		/**
269		* Get actual request method.
270		*
271		* @return null\|string
272		*/
273		protected function getRequestMethod()
274		{
275		$request = $this->getRequest();
276
277		$requestMethod = $request->method();
278
279		// Allow overriding the HTTP method. The reason for this is
280		// that some libraries/environments do not support PATCH and
281		// DELETE requests, e.g. Flash in a browser and parts of Java.
282		$newMethod = $request->header('X-HTTP-Method-Override');
283
284		if ( ! empty($newMethod)) {
285		$requestMethod = $newMethod;
286		}
287
288		return $requestMethod;
289		}
290
291		/**
292		* Apply middleware.
293		*
294		* @return null
295		*/
296		protected function applyMiddleware()
297		{
298		$middleware = $this->middleware()->list();
299
300		foreach ($middleware as $m) {
301		$m->handle($this->getRequest(), $this->getResponse());
302		}
303		}
304
305		/**
306		* Handle OPTIONS request.
307		*
308		* @return HttpResponse
309		*/
310		protected function handleOptions() : HttpResponse
311		{
312		$headers = [
313		'Allow' => implode(',', $this->request->allowedHttpVerbs()),
314		'Tus-Version' => self::TUS_PROTOCOL_VERSION,
315		'Tus-Extension' => implode(',', self::TUS_EXTENSIONS),
316		'Tus-Checksum-Algorithm' => $this->getSupportedHashAlgorithms(),
317		];
318
319		$maxUploadSize = $this->getMaxUploadSize();
320
321		if ($maxUploadSize > 0) {
322		$headers['Tus-Max-Size'] = $maxUploadSize;
323		}
324
325		return $this->response->send(null, HttpResponse::HTTP_OK, $headers);
326		}
327
328		/**
329		* Handle HEAD request.
330		*
331		* @return HttpResponse
332		*/
333		protected function handleHead() : HttpResponse
334		{
335		$key = $this->request->key();
336
337		if ( ! $fileMeta = $this->cache->get($key)) {
338		return $this->response->send(null, HttpResponse::HTTP_NOT_FOUND);
339		}
340
341		$offset = $fileMeta['offset'] ?? false;
342
343		if (false === $offset) {
344		return $this->response->send(null, HttpResponse::HTTP_GONE);
345		}
346
347		return $this->response->send(null, HttpResponse::HTTP_OK, $this->getHeadersForHeadRequest($fileMeta));
348		}
349
350		/**
351		* Handle POST request.
352		*
353		* @return HttpResponse
354		*/
355		protected function handlePost() : HttpResponse
356		{
357		$fileName = $this->getRequest()->extractFileName();
358		$uploadType = self::UPLOAD_TYPE_NORMAL;
359
360		if (empty($fileName)) {
361		return $this->response->send(null, HttpResponse::HTTP_BAD_REQUEST);
362		}
363
364		if ( ! $this->verifyUploadSize()) {
365		return $this->response->send(null, HttpResponse::HTTP_REQUEST_ENTITY_TOO_LARGE);
366		}
367
368		$uploadKey = $this->getUploadKey();
369		$filePath = $this->uploadDir . DIRECTORY_SEPARATOR . $fileName;
370
371		if ($this->getRequest()->isFinal()) {
372		return $this->handleConcatenation($fileName, $filePath);
373		}
374
375		if ($this->getRequest()->isPartial()) {
376		$filePath = $this->getPathForPartialUpload($uploadKey) . $fileName;
377		$uploadType = self::UPLOAD_TYPE_PARTIAL;
378		}
379
380		$checksum = $this->getClientChecksum();
381		$location = $this->getRequest()->url() . $this->getApiPath() . '/' . $uploadKey;
382
383		$file = $this->buildFile([
384		'name' => $fileName,
385		'offset' => 0,
386		'size' => $this->getRequest()->header('Upload-Length'),
387		'file_path' => $filePath,
388		'location' => $location,
389		])->setChecksum($checksum);
390
391		$this->cache->set($uploadKey, $file->details() + ['upload_type' => $uploadType]);
392
393		return $this->response->send(
394		['data' => ['checksum' => $checksum]],
395		HttpResponse::HTTP_CREATED,
396		[
397		'Location' => $location,
398		'Upload-Expires' => $this->cache->get($uploadKey)['expires_at'],
399		]
400		);
401		}
402
403		/**
404		* Handle file concatenation.
405		*
406		* @param string $fileName
407		* @param string $filePath
408		*
409		* @return HttpResponse
410		*/
411		protected function handleConcatenation(string $fileName, string $filePath) : HttpResponse
412		{
413		$partials = $this->getRequest()->extractPartials();
414		$uploadKey = $this->getUploadKey();
415		$files = $this->getPartialsMeta($partials);
416		$filePaths = array_column($files, 'file_path');
417		$location = $this->getRequest()->url() . $this->getApiPath() . '/' . $uploadKey;
418
419		$file = $this->buildFile([
420		'name' => $fileName,
421		'offset' => 0,
422		'size' => 0,
423		'file_path' => $filePath,
424		'location' => $location,
425		])->setFilePath($filePath);
426
427		$file->setOffset($file->merge($files));
428
429		// Verify checksum.
430		$checksum = $this->getServerChecksum($filePath);
431
432		if ($checksum !== $this->getClientChecksum()) {
433		return $this->response->send(null, self::HTTP_CHECKSUM_MISMATCH);
434		}
435
436		$this->cache->set($uploadKey, $file->details() + ['upload_type' => self::UPLOAD_TYPE_FINAL]);
437
438		// Cleanup.
439		if ($file->delete($filePaths, true)) {
440		$this->cache->deleteAll($partials);
441		}
442
443		return $this->response->send(
444		['data' => ['checksum' => $checksum]],
445		HttpResponse::HTTP_CREATED,
446		[
447		'Location' => $location,
448		]
449		);
450		}
451
452		/**
453		* Handle PATCH request.
454		*
455		* @return HttpResponse
456		*/
457		protected function handlePatch() : HttpResponse
458		{
459		$uploadKey = $this->request->key();
460
461		if ( ! $meta = $this->cache->get($uploadKey)) {
462		return $this->response->send(null, HttpResponse::HTTP_GONE);
463		}
464
465		if (self::UPLOAD_TYPE_FINAL === $meta['upload_type']) {
466		return $this->response->send(null, HttpResponse::HTTP_FORBIDDEN);
467		}
468
469		$file = $this->buildFile($meta);
470		$checksum = $meta['checksum'];
471
472		try {
473		$fileSize = $file->getFileSize();
474		$offset = $file->setKey($uploadKey)->setChecksum($checksum)->upload($fileSize);
475
476		// If upload is done, verify checksum.
477		if ($offset === $fileSize && ! $this->verifyChecksum($checksum, $meta['file_path'])) {
478		return $this->response->send(null, self::HTTP_CHECKSUM_MISMATCH);
479		}
480		} catch (FileException $e) {
481		return $this->response->send($e->getMessage(), HttpResponse::HTTP_UNPROCESSABLE_ENTITY);
482		} catch (OutOfRangeException $e) {
483		return $this->response->send(null, HttpResponse::HTTP_REQUESTED_RANGE_NOT_SATISFIABLE);
484		} catch (ConnectionException $e) {
485		return $this->response->send(null, HttpResponse::HTTP_CONTINUE);
486		}
487
488		return $this->response->send(null, HttpResponse::HTTP_NO_CONTENT, [
489		'Content-Type' => 'application/offset+octet-stream',
490		'Upload-Expires' => $this->cache->get($uploadKey)['expires_at'],
491		'Upload-Offset' => $offset,
492		]);
493		}
494
495		/**
496		* Handle GET request.
497		*
498		* @return BinaryFileResponse\|HttpResponse
499		*/
500		protected function handleGet()
501		{
502		$key = $this->request->key();
503
504		if (empty($key)) {
505		return $this->response->send('400 bad request.', HttpResponse::HTTP_BAD_REQUEST);
506		}
507
508		if ( ! $fileMeta = $this->cache->get($key)) {
509		return $this->response->send('404 upload not found.', HttpResponse::HTTP_NOT_FOUND);
510		}
511
512		$resource = $fileMeta['file_path'] ?? null;
513		$fileName = $fileMeta['name'] ?? null;
514
515		if ( ! $resource \|\| ! file_exists($resource)) {
516		return $this->response->send('404 upload not found.', HttpResponse::HTTP_NOT_FOUND);
517		}
518
519		return $this->response->download($resource, $fileName);
520		}
521
522		/**
523		* Handle DELETE request.
524		*
525		* @return HttpResponse
526		*/
527		protected function handleDelete() : HttpResponse
528		{
529		$key = $this->request->key();
530		$fileMeta = $this->cache->get($key);
531		$resource = $fileMeta['file_path'] ?? null;
532
533		if ( ! $resource) {
534		return $this->response->send(null, HttpResponse::HTTP_NOT_FOUND);
535		}
536
537		$isDeleted = $this->cache->delete($key);
538
539		if ( ! $isDeleted \|\| ! file_exists($resource)) {
540		return $this->response->send(null, HttpResponse::HTTP_GONE);
541		}
542
543		unlink($resource);
544
545		return $this->response->send(null, HttpResponse::HTTP_NO_CONTENT, [
546		'Tus-Extension' => self::TUS_EXTENSION_TERMINATION,
547		]);
548		}
549
550		/**
551		* Get required headers for head request.
552		*
553		* @param array $fileMeta
554		*
555		* @return array
556		*/
557		protected function getHeadersForHeadRequest(array $fileMeta) : array
558		{
559		$headers = [
560		'Upload-Length' => (int) $fileMeta['size'],
561		'Upload-Offset' => (int) $fileMeta['offset'],
562		'Cache-Control' => 'no-store',
563		];
564
565		if (self::UPLOAD_TYPE_FINAL === $fileMeta['upload_type'] && $fileMeta['size'] !== $fileMeta['offset']) {
566		unset($headers['Upload-Offset']);
567		}
568
569		if (self::UPLOAD_TYPE_NORMAL !== $fileMeta['upload_type']) {
570		$headers += ['Upload-Concat' => $fileMeta['upload_type']];
571		}
572
573		return $headers;
574		}
575
576		/**
577		* Build file object.
578		*
579		* @param array $meta
580		*
581		* @return File
582		*/
583		protected function buildFile(array $meta) : File
584		{
585		$file = new File($meta['name'], $this->cache);
586
587		if (array_key_exists('offset', $meta)) {
588		$file->setMeta($meta['offset'], $meta['size'], $meta['file_path'], $meta['location']);
589		}
590
591		return $file;
592		}
593
594		/**
595		* Get list of supported hash algorithms.
596		*
597		* @return string
598		*/
599		protected function getSupportedHashAlgorithms() : string
600		{
601		$supportedAlgorithms = hash_algos();
602
603		$algorithms = [];
604		foreach ($supportedAlgorithms as $hashAlgo) {
605		if (false !== strpos($hashAlgo, ',')) {
606		$algorithms[] = "'{$hashAlgo}'";
607		} else {
608		$algorithms[] = $hashAlgo;
609		}
610		}
611
612		return implode(',', $algorithms);
613		}
614
615		/**
616		* Verify and get upload checksum from header.
617		*
618		* @return string\|HttpResponse
619		*/
620		protected function getClientChecksum()
621		{
622		$checksumHeader = $this->getRequest()->header('Upload-Checksum');
623
624		if (empty($checksumHeader)) {
625		return '';
626		}
627
628		list($checksumAlgorithm, $checksum) = explode(' ', $checksumHeader);
629
630		$checksum = base64_decode($checksum);
631
632		if ( ! in_array($checksumAlgorithm, hash_algos()) \|\| false === $checksum) {
633		return $this->response->send(null, HttpResponse::HTTP_BAD_REQUEST);
634		}
635
636		return $checksum;
637		}
638
639		/**
640		* Get expired but incomplete uploads.
641		*
642		* @param array\|null $contents
643		*
644		* @return bool
645		*/
646		protected function isExpired($contents) : bool
647		{
648		$isExpired = empty($contents['expires_at']) \|\| Carbon::parse($contents['expires_at'])->lt(Carbon::now());
649
650		if ($isExpired && $contents['offset'] !== $contents['size']) {
651		return true;
652		}
653
654		return false;
655		}
656
657		/**
658		* Get path for partial upload.
659		*
660		* @param string $key
661		*
662		* @return string
663		*/
664		protected function getPathForPartialUpload(string $key) : string
665		{
666		list($actualKey) = explode(self::PARTIAL_UPLOAD_NAME_SEPARATOR, $key);
667
668		$path = $this->uploadDir . DIRECTORY_SEPARATOR . $actualKey . DIRECTORY_SEPARATOR;
669
670		if ( ! file_exists($path)) {
671		mkdir($path);
672		}
673
674		return $path;
675		}
676
677		/**
678		* Get metadata of partials.
679		*
680		* @param array $partials
681		*
682		* @return array
683		*/
684		protected function getPartialsMeta(array $partials) : array
685		{
686		$files = [];
687
688		foreach ($partials as $partial) {
689		$fileMeta = $this->getCache()->get($partial);
690
691		$files[] = $fileMeta;
692		}
693
694		return $files;
695		}
696
697		/**
698		* Delete expired resources.
699		*
700		* @return array
701		*/
702		public function handleExpiration() : array
703		{
704		$deleted = [];
705		$cacheKeys = $this->cache->keys();
706
707		foreach ($cacheKeys as $key) {
708		$fileMeta = $this->cache->get($key, true);
709
710		if ( ! $this->isExpired($fileMeta)) {
711		continue;
712		}
713
714		if ( ! $this->cache->delete($key)) {
715		continue;
716		}
717
718		if (is_writable($fileMeta['file_path'])) {
719		unlink($fileMeta['file_path']);
720		}
721
722		$deleted[] = $fileMeta;
723		}
724
725		return $deleted;
726		}
727
728		/**
729		* Verify max upload size.
730		*
731		* @return bool
732		*/
733		protected function verifyUploadSize() : bool
734		{
735		$maxUploadSize = $this->getMaxUploadSize();
736
737		if ($maxUploadSize > 0 && $this->getRequest()->header('Upload-Length') > $maxUploadSize) {
738		return false;
739		}
740
741		return true;
742		}
743
744		/**
745		* Verify checksum if available.
746		*
747		* @param string $checksum
748		* @param string $filePath
749		*
750		* @return bool
751		*/
752		protected function verifyChecksum(string $checksum, string $filePath) : bool
753		{
754		// Skip if checksum is empty.
755		if (empty($checksum)) {
756		return true;
757		}
758
759		return $checksum === $this->getServerChecksum($filePath);
760		}
761
762		/**
763		* No other methods are allowed.
764		*
765		* @param string $method
766		* @param array $params
767		*
768		* @return HttpResponse\|BinaryFileResponse
769		*/
770		public function __call(string $method, array $params)
771		{
772		return $this->response->send(null, HttpResponse::HTTP_BAD_REQUEST);
773		}
774		}
775

ankitpokhrel / tus-php

Pull Request — master (#31)

Server::serve() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like