SwooleRequest::resolveAuthorizationHeaders() - Code Metrics - Inspection of "update coding standar" - bakaphp/phalcon-api - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions
Pull Request — master (#30)

by Maximo
created 2018-12-30 22:05 UTC
SwooleRequest::resolveAuthorizationHeaders() F

↳ Parent: SwooleRequest
Complexity

Conditions	22
Paths	2052
Size

Total Lines	71
Code Lines	45
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	0
CRAP Score	506
Importance

Changes
Metric	Value
cc	22
eloc	45
nc	2052
nop	0
dl	0
loc	71
ccs	0
cts	62
cp	0
crap	506
rs	0
c	0
b	0
f	0
How to fix Long Method Complexity

<?php
// +----------------------------------------------------------------------
// | SwooleRequest.php [ WE CAN DO IT JUST THINK IT ]
// +----------------------------------------------------------------------
// | Copyright (c) 2016-2017 limingxinleo All rights reserved.
// +----------------------------------------------------------------------
// | Author: limx <[email protected]> <https://github.com/limingxinleo>
// +----------------------------------------------------------------------

namespace Gewaer\Http;

use Phalcon\DiInterface;
use Phalcon\Events\Manager;
use Phalcon\FilterInterface;
use Phalcon\Http\RequestInterface;
use Phalcon\Di\InjectionAwareInterface;
use Phalcon\Http\Request\File;
use Phalcon\Text;
use swoole_http_request;
filter:
    dependency_paths: ["lib/*"]
use Exception;
use Phalcon\Di\FactoryDefault;
use function Gewaer\Core\isJson;

class SwooleRequest implements RequestInterface, InjectionAwareInterface
{
    protected $_dependencyInjector;

    protected $_httpMethodParameterOverride = false;

    protected $_filter;

    protected $_putCache;

    protected $_strictHostCheck = false;

    protected $_files;

    protected $_rawBody;

    protected $headers;

    protected $server;

    protected $get;

    protected $post;

    protected $cookies;

    protected $files;

    protected $swooleRequest;

    public function init(swoole_http_request $request)
    {
        $this->swooleRequest = $request;
        $this->headers = [];
        $this->server = [];

        $this->get = isset($request->get) ? $request->get : [];
        $this->post = isset($request->post) ? $request->post : [];
        $this->cookies = isset($request->cookie) ? $request->cookie : [];
        $this->files = isset($request->files) ? $request->files : [];
        $this->_rawBody = $request->rawContent();

        foreach ($request->header as $key => $val) {
            $key = strtoupper(str_replace(['-'], '_', $key));
            $this->headers[$key] = $val;
            $this->server[$key] = $val;
        }
        foreach ($request->server as $key => $val) {
            $key = strtoupper(str_replace(['-'], '_', $key));
            $this->server[$key] = $val;
        }

        /** @var Cookies $cookies */
        //$cookies = FactoryDefault::getDefault()->getCookies();
        //  $cookies->setSwooleCookies($this->cookies);
    }

    public function setDI(DiInterface $dependencyInjector)
    {
        $this->_dependencyInjector = $dependencyInjector;
    }

    public function getDI()
    {
        return $this->_dependencyInjector;
    }

    public function get($name = null, $filters = null, $defaultValue = null, $notAllowEmpty = false, $noRecursive = false)
    {
        $source = array_merge($this->get, $this->post);
        return $this->getHelper($source, $name, $filters, $defaultValue, $notAllowEmpty, $noRecursive);
    }

    public function getPost($name = null, $filters = null, $defaultValue = null, $notAllowEmpty = false, $noRecursive = false)
    {
        $source = $this->post;
        return $this->getHelper($source, $name, $filters, $defaultValue, $notAllowEmpty, $noRecursive);
    }

    public function getQuery($name = null, $filters = null, $defaultValue = null, $notAllowEmpty = false, $noRecursive = false)
    {
        $source = $this->get;
        return $this->getHelper($source, $name, $filters, $defaultValue, $notAllowEmpty, $noRecursive);
    }

    public function getServer($name)
    {
        $name = strtoupper(str_replace(['-'], '_', $name));
        if (isset($this->server[$name])) {
            return $this->server[$name];
        }
        return null;
    }

    public function getPut($name = null, $filters = null, $defaultValue = null, $notAllowEmpty = false, $noRecursive = false)
    {
        $put = $this->_putCache;

        if (empty($put)) {
            if (!isJson($this->getRawBody())) {
                parse_str($this->getRawBody(), $put);
            } else {
                $put = $this->getJsonRawBody(true);
            }
            $this->_putCache = $put;
        }

        return $this->getHelper($put, $name, $filters, $defaultValue, $notAllowEmpty, $noRecursive);
    }

    public function has($name)
    {
        $source = array_merge($this->get, $this->post);
        return isset($source[$name]);
    }

    public function hasPost($name)
    {
        return isset($this->post[$name]);
    }

    public function hasPut($name)
    {
        $put = $this->getPut();

        return isset($put[$name]);
    }

    public function hasQuery($name)
    {
        return isset($this->get[$name]);
    }

    public function hasServer($name)
    {
        $name = strtoupper(str_replace(['-'], '_', $name));

        return isset($this->server[$name]);
    }

    public function hasHeader($header)
    {
        if ($this->hasServer($header)) {
            return true;
        }
        if ($this->hasServer('HTTP_' . $header)) {
            return true;
        }
        return false;
    }

    public function getHeader($header)
    {
        $header = $this->getServer($header);
        if (isset($header)) {
            return $header;
        }

        $header = $this->getServer('HTTP_' . $header);
        if (isset($header)) {
            return $header;
        }

        return '';
    }

    public function getScheme()
    {
        $https = $this->getServer('HTTPS');
        if ($https && $https != 'off') {
            return 'https';
        }

        return 'http';
    }

    public function isAjax()
    {
        return $this->getServer('HTTP_X_REQUESTED_WITH') === 'XMLHttpRequest';
    }

    public function isSoap()
    {
        if ($this->hasServer('HTTP_SOAPACTION')) {
            return true;
        }

        $contentType = $this->getContentType();
        if (!empty($contentType)) {
            return (bool) strpos($contentType, 'application/soap+xml') !== false;
        }

        return false;
    }

    public function isSoapRequested()
    {
        return $this->isSoap();
    }

    public function isSecure()
    {
        return $this->getScheme() === 'https';
    }

    public function isSecureRequest()
    {
        return $this->isSecure();
    }

    public function getRawBody()
    {
        return $this->_rawBody;
    }

    public function getJsonRawBody($associative = false)
    {
        $rawBody = $this->getRawBody();
        if (!is_string($rawBody)) {
            return false;
        }

        return json_decode($rawBody, $associative);
    }

    public function getServerAddress()
    {
        $serverAddr = $this->getServer('SERVER_ADDR');
        if ($serverAddr) {
            return $serverAddr;
        }

        return gethostbyname('localhost');
    }

    public function getServerName()
    {
        $serverName = $this->getServer('SERVER_NAME');
        if ($serverName) {
            return $serverName;
        }

        return 'localhost';
    }

    public function getHttpHost()
    {
        $strict = $this->_strictHostCheck;

        /**
         * Get the server name from $_SERVER["HTTP_HOST"]
         */
        $host = $this->getServer('HTTP_HOST');
        if (!$host) {
            /**
             * Get the server name from $_SERVER["SERVER_NAME"]
             */
            $host = $this->getServer('SERVER_NAME');
            if (!host) {

                /**
                 * Get the server address from $_SERVER["SERVER_ADDR"]
                 */
                $host = $this->getServer('SERVER_ADDR');
            }
        }

        if ($host && $strict) {
            /**
             * Cleanup. Force lowercase as per RFC 952/2181
             */
            $host = strtolower(trim($host));
            if (strpos($host, ':') !== false) {
                $host = preg_replace('/:[[:digit:]]+$/', '', $host);
            }

            /**
             * Host may contain only the ASCII letters 'a' through 'z' (in a case-insensitive manner),
             * the digits '0' through '9', and the hyphen ('-') as per RFC 952/2181
             */
            if ('' !== preg_replace("/[a-z0-9-]+\.?/", '', $host)) {
                throw new \UnexpectedValueException('Invalid host ' . host);
            }
        }

        return (string)host;
    }

    /**
     * Sets if the `Request::getHttpHost` method must be use strict validation of host name or not
     */
    public function setStrictHostCheck($flag = true)
    {
        $this->_strictHostCheck = $flag;

        return $this;
    }

    /**
     * Checks if the `Request::getHttpHost` method will be use strict validation of host name or not
     */
    public function isStrictHostCheck()
    {
        return $this->_strictHostCheck;
    }

    public function getPort()
    {
        /**
         * Get the server name from $_SERVER["HTTP_HOST"]
         */
        $host = $this->getServer('HTTP_HOST');
        if ($host) {
            if (strpos($host, ':') !== false) {
                $pos = strrpos($host, ':');

                if (false !== $pos) {
                    return (int)substr($host, $pos + 1);
                }

                return 'https' === $this->getScheme() ? 443 : 80;
            }
        }
        return (int)$this->getServer('SERVER_PORT');
    }

    /**
     * Gets HTTP URI which request has been made
     */
    public function getURI()
    {
        $requestURI = $this->getServer('request_uri'); //$this->getServer('REQUEST_URI') == $this->getQuery('_url') ? $this->getServer('REQUEST_URI') : $this->getQuery('_url');
        if ($requestURI) {
            return $requestURI;
        }

        return '';
    }

    public function getClientAddress($trustForwardedHeader = true)
    {
        $address = null;

        /**
         * Proxies uses this IP
         */
        if ($trustForwardedHeader) {
            $address = $this->getServer('X_FORWARDED_FOR');
            if ($address === null) {
                $address = $this->getServer('X_REAL_IP');
            }
        }

        if ($address === null) {
            $address = $this->getServer('REMOTE_ADDR');
        }

        if (is_string($address)) {
            if (strpos($address, ',') !== false) {
                /**
                 * The client address has multiples parts, only return the first part
                 */
                return explode(',', $address)[0];
            }
            return $address;
        }

        return false;
    }

    public function getMethod()
    {
        $returnMethod = $this->getServer('REQUEST_METHOD');
        if (!isset($returnMethod)) {
            return 'GET';
        }

        $returnMethod = strtoupper($returnMethod);
        if ($returnMethod === 'POST') {
            $overridedMethod = $this->getHeader('X-HTTP-METHOD-OVERRIDE');
            if (!empty($overridedMethod)) {
                $returnMethod = strtoupper($overridedMethod);
            } elseif ($this->_httpMethodParameterOverride) {
                if ($spoofedMethod = $this->get('_method')) {
                    $returnMethod = strtoupper($spoofedMethod);
                }
            }
        }

        if (!$this->isValidHttpMethod($returnMethod)) {
            return 'GET';
        }

        return $returnMethod;
    }

    public function getUserAgent()
    {
        $userAgent = $this->getServer('HTTP_USER_AGENT');
        if ($userAgent) {
            return $userAgent;
        }
        return '';
    }

    public function isMethod($methods, $strict = false)
    {
        $httpMethod = $this->getMethod();

        if (is_string($methods)) {
            if ($strict && !$this->isValidHttpMethod($methods)) {
                throw new Exception('Invalid HTTP method: ' . $methods);
            }
            return $methods == $httpMethod;
        }

        if (is_array($methods)) {
            foreach ($methods as $method) {
                if ($this->isMethod($method, $strict)) {
                    return true;
                }
            }

            return false;
        }

        if ($strict) {
            throw new Exception('Invalid HTTP method: non-string');
        }

        return false;
    }

    public function isPost()
    {
        return $this->getMethod() === 'POST';
    }

    public function isGet()
    {
        return $this->getMethod() === 'GET';
    }

    public function isPut()
    {
        return $this->getMethod() === 'PUT';
    }

    public function isPatch()
    {
        return $this->getMethod() === 'PATCH';
    }

    public function isHead()
    {
        return $this->getMethod() === 'HEAD';
    }

    public function isDelete()
    {
        return $this->getMethod() === 'DELETE';
    }

    public function isOptions()
    {
        return $this->getMethod() === 'OPTIONS';
    }

    public function isPurge()
    {
        return $this->getMethod() === 'PURGE';
    }

    public function isTrace()
    {
        return $this->getMethod() === 'TRACE';
    }

    public function isConnect()
    {
        return $this->getMethod() === 'CONNECT';
    }

    public function hasFiles($onlySuccessful = false)
    {
        $numberFiles = 0;

        $files = $this->files;

        if (empty($files)) {
            return $numberFiles;
        }

        foreach ($files as $file) {
            $error = $file['error'];
            if ($error) {
                if (!is_array($error)) {
                    if (!$error || !$onlySuccessful) {
                        $numberFiles++;
                    }
                } else {
                    $numberFiles += $this->hasFileHelper($error, $onlySuccessful);
                }
            }
        }

        return $numberFiles;
    }

    /**
     * Recursively counts file in an array of files
     */
    protected function hasFileHelper($data, $onlySuccessful)
    {
        $numberFiles = 0;

        if (!is_array($data)) {
            return 1;
        }

        foreach ($data as $value) {
            if (!is_array($value)) {
                if (!$value || !$onlySuccessful) {
                    $numberFiles++;
                }
            } else {
                $numberFiles += $this->hasFileHelper($value, $onlySuccessful);
            }
        }

        return $numberFiles;
    }

    public function getUploadedFiles($onlySuccessful = false)
    {
        $files = [];

        $superFiles = $this->files;

        if (count($superFiles) > 0) {
            foreach ($superFiles as $prefix => $input) {
                if (is_array(!$input['name'])) {
                    $smoothInput = $this->smoothFiles(
                        $input['name'],
                        $input['type'],
                        $input['tmp_name'],
                        $input['size'],
                        $input['error'],
                        $prefix
                    );

                    foreach ($smoothInput as $file) {
                        if ($onlySuccessful == false || $file['error'] == UPLOAD_ERR_OK) {
                            $dataFile = [
                                'name' => $file['name'],
                                'type' => $file['type'],
                                'tmp_name' => $file['tmp_name'],
                                'size' => $file['size'],
                                'error' => $file['error']
                            ];

                            $files[] = new File($dataFile, $file['key']);
                        }
                    }
                } else {
                    if ($onlySuccessful == false || $input['error'] == UPLOAD_ERR_OK) {
                        $files[] = new File($input, $prefix);
                    }
                }
            }
        }

        return $files;
    }

    public function getFile($key)
    {
        if (!isset($this->_files)) {
            $this->_files = [];
            $files = $this->getUploadedFiles();
            foreach ($files as $file) {
                $this->_files[$file->getKey()] = $file;
            }
        }

        if (!isset($this->_files[$key])) {
            return null;
        }

        return $this->_files[$key];
    }

    /**
     * Smooth out $_FILES to have plain array with all files uploaded
     */
    protected function smoothFiles($names, $types, $tmp_names, $sizes, $errors, $prefix)
    {
        $files = [];

        foreach ($names as $idx => $name) {
            $p = $prefix . '.' . $idx;

            if (is_string($name)) {
                $files[] = [
                    'name' => $name,
                    'type' => $types[$idx],
                    'tmp_name' => $tmp_names[$idx],
                    'size' => $sizes[$idx],
                    'error' => $errors[$idx],
                    'key' => $p
                ];
            }

            if (is_array($name)) {
                $parentFiles = $this->smoothFiles(
                    $names[$idx],
                    $types[$idx],
                    $tmp_names[$idx],
                    $sizes[$idx],
                    $errors[$idx],
                    $p
                );

                foreach ($parentFiles as $file) {
                    $files[] = $file;
                }
            }
        }

        return $files;
    }

    public function getServers()
    {
        return $this->server;
    }

    public function getHeaders()
    {
        $headers = [];
        $contentHeaders = ['CONTENT_TYPE' => true, 'CONTENT_LENGTH' => true, 'CONTENT_MD5' => true];

        $servers = $this->getServers();
        foreach ($servers as $name => $value) {
            if (Text::startsWith($name, 'HTTP_')) {
                $name = ucwords(strtolower(str_replace('_', ' ', substr($name, 5))));
                $name = str_replace(' ', '-', $name);
                $headers[$name] = $value;
            }

            $name = strtoupper($name);
            if (isset($contentHeaders[$name])) {
                $name = ucwords(strtolower(str_replace('_', ' ', $name)));
                $name = str_replace(' ', '-', $name);
                $headers[$name] = $value;
            }
        }

        $authHeaders = $this->resolveAuthorizationHeaders();

        // Protect for future (child classes) changes
        if (is_array($authHeaders)) {
            $headers = array_merge($headers, $authHeaders);
        }

        return $headers;
    }

    public function getHTTPReferer()
    {
        $httpReferer = $this->getServer('HTTP_REFERER');
        if ($httpReferer) {
            return $httpReferer;
        }

        return '';
    }

    /**
     * Process a request header and return the one with best quality
     */
    protected function _getBestQuality($qualityParts, $name)
    {
        $i = 0;
        $quality = 0.0;
        $selectedName = '';

        foreach ($qualityParts as $accept) {
            if ($i == 0) {
                $quality = (double)$accept['quality'];
                $selectedName = $accept[$name];
            } else {
                $acceptQuality = (double)$accept['quality'];
                if ($acceptQuality > $quality) {
                    $quality = $acceptQuality;
                    $selectedName = $accept[$name];
                }
            }
            $i++;
        }

        return $selectedName;
    }

    public function getAcceptableContent()
    {
        return $this->_getQualityHeader('HTTP_ACCEPT', 'accept');
    }

    public function getBestAccept()
    {
        return $this->_getBestQuality($this->getAcceptableContent(), 'accept');
    }

    public function getClientCharsets()
    {
        return $this->_getQualityHeader('HTTP_ACCEPT_CHARSET', 'charset');
    }

    public function getBestCharset()
    {
        return $this->_getBestQuality($this->getClientCharsets(), 'charset');
    }

    public function getLanguages()
    {
        return $this->_getQualityHeader('HTTP_ACCEPT_LANGUAGE', 'language');
    }

    public function getBestLanguage()
    {
        return $this->_getBestQuality($this->getLanguages(), 'language');
    }

    public function getBasicAuth()
    {
        if ($this->hasServer('PHP_AUTH_USER') && $this->hasServer('PHP_AUTH_PW')) {
            return [
                'username' => $this->getServer('PHP_AUTH_USER'),
                'password' => $this->getServer('PHP_AUTH_PW')
            ];
        }

        return null;
    }

    public function getDigestAuth()
    {
        $auth = [];
        if ($this->hasServer('PHP_AUTH_DIGEST')) {
            $digest = $this->getServer('PHP_AUTH_DIGEST');
            $matches = [];
            if (!preg_match_all("#(\\w+)=(['\"]?)([^'\" ,]+)\\2#", $digest, $matches, 2)) {
                return $auth;
            }
            if (is_array($matches)) {
                foreach ($matches as $match) {
                    $auth[$match[1]] = $match[3];
                }
            }
        }

        return $auth;
    }

    /**
     * Checks if a method is a valid HTTP method
     */
    public function isValidHttpMethod($method)
    {
        switch (strtoupper($method)) {
            case 'GET':
            case 'POST':
            case 'PUT':
            case 'DELETE':
            case 'HEAD':
            case 'OPTIONS':
            case 'PATCH':
            case 'PURGE': // Squid and Varnish support
            case 'TRACE':
            case 'CONNECT':
                return true;
        }

        return false;
    }

    /**
     * Helper to get data from superglobals, applying filters if needed.
     * If no parameters are given the superglobal is returned.
     */
    protected function getHelper($source, $name = null, $filters = null, $defaultValue = null, $notAllowEmpty = false, $noRecursive = false)
    {
        if ($name === null) {
            return $source;
        }

        if (!isset($source[$name])) {
            return $defaultValue;
        }

        $value = $source[$name];

        if ($filters !== null) {
            $filter = $this->_filter;
            if (!$filter instanceof FilterInterface) {
                $dependencyInjector = $this->_dependencyInjector;
                if (!$dependencyInjector instanceof DiInterface) {
                    throw new Exception("A dependency injection object is required to access the 'filter' service");
                }

                $filter = $dependencyInjector->getShared('filter');
                $this->_filter = $filter;
            }

            $value = $filter->sanitize($value, $filters, $noRecursive);
            $value = $filter->sanitize($value, $filters, $noRecursive);
        }

        if (empty($value) && $notAllowEmpty === true) {
            return $defaultValue;
        }

        return $value;
    }

    /**
     * Gets content type which request has been made
     */
    public function getContentType()
    {
        $contentType = $this->getHeader('CONTENT_TYPE');
        if ($contentType) {
            return $contentType;
        }

        return null;
    }

    /**
     * Process a request header and return an array of values with their qualities
     */
    protected function _getQualityHeader($serverIndex, $name)
    {
        $returnedParts = [];
        $parts = preg_split('/,\\s*/', $this->getServer($serverIndex), -1, PREG_SPLIT_NO_EMPTY);
        foreach ($parts as $part) {
            $headerParts = [];
            $hParts = preg_split("/\s*;\s*/", trim($part), -1, PREG_SPLIT_NO_EMPTY);
            foreach ($hParts as $headerPart) {
                if (strpos($headerPart, '=') !== false) {
                    $split = explode('=', $headerPart, 2);
                    if ($split[0] === 'q') {
                        $headerParts['quality'] = (double)$split[1];
                    } else {
                        $headerParts[$split[0]] = $split[1];
                    }
                } else {
                    $headerParts[$name] = $headerPart;
                    $headerParts['quality'] = 1.0;
                }
            }

            $returnedParts[] = $headerParts;
        }

        return $returnedParts;
    }

    /**
     * Resolve authorization headers.
     */
    protected function resolveAuthorizationHeaders()
    {
        $headers = [];
        $authHeader = null;

        $dependencyInjector = $this->getDI();
        if ($dependencyInjector instanceof DiInterface) {
            $hasEventsManager = (bool)$dependencyInjector->has('eventsManager');
            if ($hasEventsManager) {
                $eventsManager = $dependencyInjector->getShared('eventsManager');
            }
        }

        if ($hasEventsManager && $eventsManager instanceof Manager) {

            $resolved = $eventsManager->fire(
                'request:beforeAuthorizationResolve',
                $this,
                ['server' => $this->getServers()]
            );

            if (is_array($resolved)) {
                $headers = array_merge($headers, $resolved);
            }
        }

        if ($this->hasServer('PHP_AUTH_USER') && $this->hasServer('PHP_AUTH_PW')) {
            $headers['Php-Auth-User'] = $this->getServer('PHP_AUTH_USER');
            $headers['Php-Auth-Pw'] = $this->getServer('PHP_AUTH_PW');
        } else {
            if ($this->hasServer('HTTP_AUTHORIZATION')) {
                $authHeader = $this->getServer('HTTP_AUTHORIZATION');
            } elseif ($this->hasServer('REDIRECT_HTTP_AUTHORIZATION')) {
                $authHeader = $this->getServer('REDIRECT_HTTP_AUTHORIZATION');
            }

            if ($authHeader) {
                if (stripos($authHeader, 'basic ') === 0) {
                    $exploded = explode(':', base64_decode(substr($authHeader, 6)), 2);
                    if (count($exploded) == 2) {
                        $headers['Php-Auth-User'] = $exploded[0];
                        $headers['Php-Auth-Pw'] = $exploded[1];
                    }
                } elseif (stripos($authHeader, 'digest ') === 0 && !$this->hasServer('PHP_AUTH_DIGEST')) {
                    $headers['Php-Auth-Digest'] = $authHeader;
                } elseif (stripos($authHeader, 'bearer ') === 0) {
                    $headers['Authorization'] = $authHeader;
                }
            }
        }

        if (!isset($headers['Authorization'])) {
            if (isset($headers['Php-Auth-User'])) {
                $headers['Authorization'] = 'Basic ' . base64_encode($headers['Php-Auth-User'] . ':' . $headers['Php-Auth-Pw']);
            } elseif (isset($headers['Php-Auth-Digest'])) {
                $headers['Authorization'] = $headers['Php-Auth-Digest'];
            }
        }

        if ($hasEventsManager && $eventsManager instanceof Manager) {
            $resolved = $eventsManager->fire(
                'request:afterAuthorizationResolve',
                $this,
                ['headers' => $headers, 'server' => $this->getServers()]
            );

            if (is_array($resolved)) {
                $headers = array_merge($headers, $resolved);
            }
        }

        return $headers;
    }
}

bakaphp / phalcon-api

Pull Request — master (#30)

SwooleRequest::resolveAuthorizationHeaders() F

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like
