Request::isValidFilename() - Code Metrics - Inspection of "Validate file name passed in upload metadata" - ankitpokhrel/tus-php - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#168)

by Ankit

created 2019-07-21 08:48 UTC

Request::isValidFilename() A

↳ Parent: Request

Complexity

Conditions	3
Paths	3

Size

Total Lines	11
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	6
CRAP Score	3

Importance

Changes

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

<?php

namespace TusPhp;

use TusPhp\Tus\Server;
use Symfony\Component\HttpFoundation\Request as HttpRequest;

class Request
{
    /** @var HttpRequest */
    protected $request;

    /**
     * Request constructor.
     */
    public function __construct()
    {
        if (null === $this->request) {
            $this->request = HttpRequest::createFromGlobals();
        }
    }

    /**
     * Get http method from current request.
     *
     * @return string
     */
    public function method() : string
    {
        return $this->request->getMethod();
    }

    /**
     * Get the current path info for the request.
     *
     * @return string
     */
    public function path() : string
    {
        return $this->request->getPathInfo();
    }

    /**
     * Get upload key from url.
     *
     * @return string
     */
    public function key() : string
    {
        return basename($this->path());
    }

    /**
     * Supported http requests.
     *
     * @return array
     */
    public function allowedHttpVerbs() : array
    {
        return [
            HttpRequest::METHOD_GET,
            HttpRequest::METHOD_POST,
            HttpRequest::METHOD_PATCH,
            HttpRequest::METHOD_DELETE,
            HttpRequest::METHOD_HEAD,
            HttpRequest::METHOD_OPTIONS,
        ];
    }

    /**
     * Retrieve a header from the request.
     *
     * @param string               $key
     * @param string|string[]|null $default
     *
     * @return string|null
     */
    public function header(string $key, $default = null)
    {
        return $this->request->headers->get($key, $default);
        return $this->request->headers->get($key, /** @scrutinizer ignore-type */ $default);
    }

    /**
     * Get the root URL for the request.
     *
     * @return string
     */
    public function url() : string
    {
        return rtrim($this->request->getUriForPath('/'), '/');
    }

    /**
     * Extract metadata from header.
     *
     * @param string $key
     * @param string $value
     *
     * @return array
     */
    public function extractFromHeader(string $key, string $value) : array
    {
        $meta = $this->header($key);

        if (false !== strpos($meta, $value)) {
            $meta = trim(str_replace($value, '', $meta));

            return explode(' ', $meta) ?? [];
        }

        return [];
    }

    /**
     * Extract base64 encoded filename from header.
     *
     * @return string
     */
    public function extractFileName() : string
    {
        $name = $this->extractMeta('name') ?: $this->extractMeta('filename');

        if ( ! $this->isValidFilename($name)) {
            return '';
        }

        return $name;
    }

    /**
     * Extracts the meta data from the request header.
     *
     * @param string $requestedKey
     *
     * @return string
     */
    public function extractMeta(string $requestedKey) : string
    {
        $uploadMetaData = $this->request->headers->get('Upload-Metadata');

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

        $uploadMetaDataChunks = explode(',', $uploadMetaData);

        foreach ($uploadMetaDataChunks as $chunk) {
            list($key, $value) = explode(' ', $chunk);

            if ($key === $requestedKey) {
                return base64_decode($value);
            }
        }

        return '';
    }

    /**
     * Extract partials from header.
     *
     * @return array
     */
    public function extractPartials() : array
    {
        return $this->extractFromHeader('Upload-Concat', Server::UPLOAD_TYPE_FINAL . ';');
    }

    /**
     * Check if this is a partial upload request.
     *
     * @return bool
     */
    public function isPartial() : bool
    {
        return Server::UPLOAD_TYPE_PARTIAL === $this->header('Upload-Concat');
    }

    /**
     * Check if this is a final concatenation request.
     *
     * @return bool
     */
    public function isFinal() : bool
    {
        return false !== strpos($this->header('Upload-Concat'), Server::UPLOAD_TYPE_FINAL . ';');
    }

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

    /**
     * Validate file name.
     *
     * @param string $filename
     *
     * @return bool
     */
    protected function isValidFilename(string $filename) : bool
    {
        $forbidden = ['../', ' ', '"', "'", '&', '/', '\\', '?', '#', ':'];

        foreach ($forbidden as $char) {
            if (false !== strpos($filename, $char)) {
                return false;
            }
        }

        return true;
    }
}


ankitpokhrel / tus-php

Pull Request — master (#168)

Request::isValidFilename() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like