Server::handleHead() - Code Metrics - Inspection of "Allow for request to be set on the server" - ankitpokhrel/tus-php - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#184)

unknown

created 2019-09-05 08:58 UTC

Server::handleHead() A

↳ Parent: Server

Complexity

Conditions	3
Paths	3

Size

Total Lines	15
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	8
CRAP Score	3

Importance

Changes	1
Bugs	0	Features	0

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

<?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\Events\UploadMerged;
use TusPhp\Events\UploadCreated;
use TusPhp\Events\UploadComplete;
use TusPhp\Events\UploadProgress;
use TusPhp\Middleware\Middleware;
use TusPhp\Exception\FileException;
use TusPhp\Exception\ConnectionException;
use TusPhp\Exception\OutOfRangeException;
use Symfony\Component\HttpFoundation\BinaryFileResponse;
use Symfony\Component\HttpFoundation\Request as HttpRequest;
use Symfony\Component\HttpFoundation\Response as HttpResponse;

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';

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

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

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

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

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

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

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

        $this->setCache($cacheAdapter);
    }

    /**
     * Set the request
     *
     * @param \Symfony\Component\HttpFoundation\Request $request
     * @return \TusPhp\Tus\Server
     */
    public function setRequest(HttpRequest $request): self
    {
        $this->request->setRequest($request);

        return $this;
    }

    /**
     * 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() : ?string
    {
        $checksumHeader = $this->getRequest()->header('Upload-Checksum');

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

        list($checksumAlgorithm, /* $checksum */) = 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|BinaryFileResponse
     */
    public function serve()
    {
        $this->applyMiddleware();

        $requestMethod = $this->getRequest()->method();

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

        $clientVersion = $this->getRequest()->header('Tus-Resumable');

        if ($clientVersion && $clientVersion !== self::TUS_PROTOCOL_VERSION) {
            return $this->response->send(null, HttpResponse::HTTP_PRECONDITION_FAILED, [
                'Tus-Version' => self::TUS_PROTOCOL_VERSION,
            ]);
        }

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

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

    /**
     * Apply middleware.
     *
     * @return void
     */
    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 . '/' . $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,
        ])->setKey($uploadKey)->setChecksum($checksum)->setUploadMetadata($this->getRequest()->extractAllMeta());

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

        $this->event()->dispatch(
            UploadCreated::NAME,
            new UploadCreated($file, $this->getRequest(), $this->getResponse())
        );

        return $this->response->send(
            null,
            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)->setKey($uploadKey)->setUploadMetadata($this->getRequest()->extractAllMeta());

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

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

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

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

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

        $this->event()->dispatch(
            UploadMerged::NAME,
            new UploadMerged($file, $this->getRequest(), $this->getResponse())
        );

        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);
        }

        $status = $this->verifyPatchRequest($meta);

        if (HttpResponse::HTTP_OK !== $status) {
            return $this->response->send(null, $status);
        }

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

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

            // If upload is done, verify checksum.
            if ($offset === $fileSize) {
                if ( ! $this->verifyChecksum($checksum, $meta['file_path'])) {
                    return $this->response->send(null, self::HTTP_CHECKSUM_MISMATCH);
                }

                $this->event()->dispatch(
                    UploadComplete::NAME,
                    new UploadComplete($file, $this->getRequest(), $this->getResponse())
                );
            } else {
                $this->event()->dispatch(
                    UploadProgress::NAME,
                    new UploadProgress($file, $this->getRequest(), $this->getResponse())
                );
            }
        } 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' => self::HEADER_CONTENT_TYPE,
            'Upload-Expires' => $this->cache->get($uploadKey)['expires_at'],
            'Upload-Offset' => $offset,
        ]);
    }

    /**
     * Verify PATCH request.
     *
     * @param array $meta
     *
     * @return int
     */
    protected function verifyPatchRequest(array $meta) : int
    {
        if (self::UPLOAD_TYPE_FINAL === $meta['upload_type']) {
            return HttpResponse::HTTP_FORBIDDEN;
        }

        $uploadOffset = $this->request->header('upload-offset');

        if ($uploadOffset && $uploadOffset !== (string) $meta['offset']) {
            return HttpResponse::HTTP_CONFLICT;
        }

        $contentType = $this->request->header('Content-Type');

        if ($contentType !== self::HEADER_CONTENT_TYPE) {
            return HTTPRESPONSE::HTTP_UNSUPPORTED_MEDIA_TYPE;
        }

        return HttpResponse::HTTP_OK;
    }

    /**
     * Handle GET request.
     *
     * As per RFC7231, we need to treat HEAD and GET as an identical request.
     * All major PHP frameworks follows the same and silently transforms each
     * HEAD requests to GET.
     *
     * @return BinaryFileResponse|HttpResponse
     */
    protected function handleGet()
    {
        // We will treat '/files/<key>/get' as a download request.
        if ('get' === $this->request->key()) {
            return $this->handleDownload();
        }

        return $this->handleHead();
    }

    /**
     * Handle Download request.
     *
     * @return BinaryFileResponse|HttpResponse
     */
    protected function handleDownload()
    {
        $path = explode('/', str_replace('/get', '', $this->request->path()));
        $key  = end($path);

        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, /* $partialUploadKey */) = explode(self::PARTIAL_UPLOAD_NAME_SEPARATOR, $key);

        $path = $this->uploadDir . '/' . $actualKey . '/';

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

ankitpokhrel / tus-php

Pull Request — master (#184)

Server::handleHead() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like