Divergence\Controllers\MediaRequestHandler::handleMediaRequest()

Complexity

Conditions	29
Paths	3334

Size

Total Lines	141
Code Lines	78

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

<?php
    public function handleMediaRequest($mediaID): ResponseInterface
    {
        if (empty($mediaID) || !is_numeric($mediaID)) {
            return $this->throwNotFoundError('Media ID #%u was not found', $mediaID);

The call to Divergence\Controllers\RecordsRequestHandler::throwNotFoundError() has too many arguments starting with 'Media ID #%u was not found'.

        }

        // get media
        try {
            $Media = Media::getById($mediaID);
        } catch (Exception $e) {
            return $this->throwUnauthorizedError();
        }

        if (!$Media) {
            return $this->throwNotFoundError('Media ID #%u was not found', $mediaID);
        }

        if (!$this->checkReadAccess($Media)) {
            return $this->throwNotFoundError();
        }

        if (isset($_SERVER['HTTP_ACCEPT'])) {
            if ($_SERVER['HTTP_ACCEPT'] == 'application/json') {
                $this->responseBuilder = JsonBuilder::class;
            }
        }

        if ($this->responseBuilder == JsonBuilder::class) {
            return $this->respond('media', [
                'success' => true
                ,'data' => $Media,
            ]);
        } else {

            // determine variant
            if ($variant = $this->shiftPath()) {
                if (!$Media->isVariantAvailable($variant)) {
                    return $this->throwNotFoundError();
                }
            } else {
                $variant = 'original';
            }

            // send caching headers
            $expires = 60*60*24*365;
            if (!headers_sent()) {
                // @codeCoverageIgnoreStart
                header("Cache-Control: public, max-age=$expires");
                header('Expires: '.gmdate('D, d M Y H:i:s \G\M\T', time()+$expires));
                header('Pragma: public');
                // @codeCoverageIgnoreEnd
            }

            // media are immutable for a given URL, so no need to actually check anything if the browser wants to revalidate its cache
            if (!empty($_SERVER['HTTP_IF_NONE_MATCH']) || !empty($_SERVER['HTTP_IF_MODIFIED_SINCE'])) {
                // @codeCoverageIgnoreStart
                header('HTTP/1.0 304 Not Modified');
                exit();

In this branch, the function will implicitly return null which is incompatible with the type-hinted return Psr\Http\Message\ResponseInterface. Consider adding a return statement or allowing null as return value.

                // @codeCoverageIgnoreEnd
            }

            // initialize response
            set_time_limit(0);
            $filePath = $Media->getFilesystemPath($variant);
            $fp = fopen($filePath, 'rb');

It seems like $filePath can also be of type null; however, parameter $filename of fopen() does only seem to accept string, maybe add an additional type check?

            $size = filesize($filePath);

It seems like $filePath can also be of type null; however, parameter $filename of filesize() does only seem to accept string, maybe add an additional type check?

            $length = $size;
            $start = 0;
            $end = $size - 1;

            if (!headers_sent()) {
                // @codeCoverageIgnoreStart
                header('Content-Type: '.$Media->getMIMEType($variant));
                header('ETag: media-'.$Media->ID.'-'.$variant);
                header('Accept-Ranges: bytes');
                // @codeCoverageIgnoreEnd
            }

            // interpret range requests
            if (!empty($_SERVER['HTTP_RANGE'])) {
                $chunkStart = $start;

The assignment to $chunkStart is dead and can be removed.

                $chunkEnd = $end;

                list(, $range) = explode('=', $_SERVER['HTTP_RANGE'], 2);

                if (strpos($range, ',') !== false) {
                    // @codeCoverageIgnoreStart
                    header('HTTP/1.1 416 Requested Range Not Satisfiable');
                    header("Content-Range: bytes $start-$end/$size");
                    exit();

In this branch, the function will implicitly return null which is incompatible with the type-hinted return Psr\Http\Message\ResponseInterface. Consider adding a return statement or allowing null as return value.

                    // @codeCoverageIgnoreEnd
                }

                if ($range == '-') {
                    $chunkStart = $size - substr($range, 1);
                } else {
                    $range = explode('-', $range);
                    $chunkStart = $range[0];
                    $chunkEnd = (isset($range[1]) && is_numeric($range[1])) ? $range[1] : $size;
                }

                $chunkEnd = ($chunkEnd > $end) ? $end : $chunkEnd;
                if ($chunkStart > $chunkEnd || $chunkStart > $size - 1 || $chunkEnd >= $size) {
                    // @codeCoverageIgnoreStart
                    header('HTTP/1.1 416 Requested Range Not Satisfiable');
                    header("Content-Range: bytes $start-$end/$size");
                    exit();

In this branch, the function will implicitly return null which is incompatible with the type-hinted return Psr\Http\Message\ResponseInterface. Consider adding a return statement or allowing null as return value.

                    // @codeCoverageIgnoreEnd
                }

                $start = $chunkStart;
                $end = $chunkEnd;
                $length = $end - $start + 1;

                fseek($fp, $start);

It seems like $start can also be of type string; however, parameter $offset of fseek() does only seem to accept integer, maybe add an additional type check?

                // @codeCoverageIgnoreStart
                header('HTTP/1.1 206 Partial Content');
                // @codeCoverageIgnoreEnd
            }

            // finish response
            if (!headers_sent()) {
                // @codeCoverageIgnoreStart
                header("Content-Range: bytes $start-$end/$size");
                header("Content-Length: $length");
                // @codeCoverageIgnoreEnd
            }

            $buffer = 1024 * 8;
            while (!feof($fp) && ($p = ftell($fp)) <= $end) {
                if ($p + $buffer > $end) {
                    $buffer = $end - $p + 1;
                }

                echo fread($fp, $buffer);
                flush();
            }

            fclose($fp);
            if ($this->responseBuilder != JsonBuilder::class) {
                exit;

Using exit here is not recommended.

In this branch, the function will implicitly return null which is incompatible with the type-hinted return Psr\Http\Message\ResponseInterface. Consider adding a return statement or allowing null as return value.

            }