FormatNegotiator::getFromHeader() - Code Metrics - Inspection of "Filter list of acceptable headers; use default if..." - oscarotero/psr7-middlewares - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#81)

unknown

created 2017-08-16 23:08 UTC

FormatNegotiator::getFromHeader() D

↳ Parent: FormatNegotiator

Complexity

Conditions	10
Paths	9

Size

Total Lines	31
Code Lines	17

Duplication

Lines	5
Ratio	16.13 %

Importance

Changes

Metric	Value
dl	5
loc	31
rs	4.8196
c	0
b	0
f	0
cc	10
eloc	17
nc	9
nop	1

How to fix Complexity

<?php

namespace Psr7Middlewares\Middleware;

use Psr7Middlewares\Utils;
use Psr\Http\Message\ServerRequestInterface;
use Psr\Http\Message\ResponseInterface;
use Negotiation\Negotiator;

/**
 * Middleware returns the client preferred format.
 */
class FormatNegotiator
{
    use Utils\NegotiateTrait;
    use Utils\AttributeTrait;

    const KEY = 'FORMAT';

    /**
     * @var string Default format
     */
    private $default = 'html';

    /**
     * @var string[] Formats which the server supports
     */
    private $priorities = array();

    /**
     * @var array Available formats with the mime types
     */
    private $formats = [
        //text
        'html' => [['html', 'htm', 'php'], ['text/html', 'application/xhtml+xml']],
        'txt' => [['txt'], ['text/plain']],
        'css' => [['css'], ['text/css']],
        'json' => [['json'], ['application/json', 'text/json', 'application/x-json']],
        'jsonp' => [['jsonp'], ['text/javascript', 'application/javascript', 'application/x-javascript']],
        'js' => [['js'], ['text/javascript', 'application/javascript', 'application/x-javascript']],

        //xml
        'rdf' => [['rdf'], ['application/rdf+xml']],
        'rss' => [['rss'], ['application/rss+xml']],
        'atom' => [['atom'], ['application/atom+xml']],
        'xml' => [['xml'], ['text/xml', 'application/xml', 'application/x-xml']],

        //images
        'bmp' => [['bmp'], ['image/bmp']],
        'gif' => [['gif'], ['image/gif']],
        'png' => [['png'], ['image/png', 'image/x-png']],
        'jpg' => [['jpg', 'jpeg', 'jpe'], ['image/jpeg', 'image/jpg']],
        'svg' => [['svg', 'svgz'], ['image/svg+xml']],
        'psd' => [['psd'], ['image/vnd.adobe.photoshop']],
        'eps' => [['ai', 'eps', 'ps'], ['application/postscript']],
        'ico' => [['ico'], ['image/x-icon', 'image/vnd.microsoft.icon']],

        //audio/video
        'mov' => [['mov', 'qt'], ['video/quicktime']],
        'mp3' => [['mp3'], ['audio/mpeg']],
        'mp4' => [['mp4'], ['video/mp4']],
        'ogg' => [['ogg'], ['audio/ogg']],
        'ogv' => [['ogv'], ['video/ogg']],
        'webm' => [['webm'], ['video/webm']],
        'webp' => [['webp'], ['image/webp']],

        //fonts
        'eot' => [['eot'], ['application/vnd.ms-fontobject']],
        'otf' => [['otf'], ['font/opentype', 'application/x-font-opentype']],
        'ttf' => [['ttf'], ['font/ttf', 'application/font-ttf', 'application/x-font-ttf']],
        'woff' => [['woff'], ['font/woff', 'application/font-woff', 'application/x-font-woff']],
        'woff2' => [['woff2'], ['font/woff2', 'application/font-woff2', 'application/x-font-woff2']],

        //other formats
        'pdf' => [['pdf'], ['application/pdf', 'application/x-download']],
        'zip' => [['zip'], ['application/zip', 'application/x-zip', 'application/x-zip-compressed']],
        'rar' => [['rar'], ['application/rar', 'application/x-rar', 'application/x-rar-compressed']],
        'exe' => [['exe'], ['application/x-msdownload']],
        'msi' => [['msi'], ['application/x-msdownload']],
        'cab' => [['cab'], ['application/vnd.ms-cab-compressed']],
        'doc' => [['doc'], ['application/msword']],
        'rtf' => [['rtf'], ['application/rtf']],
        'xls' => [['xls'], ['application/vnd.ms-excel']],
        'ppt' => [['ppt'], ['application/vnd.ms-powerpoint']],
        'odt' => [['odt'], ['application/vnd.oasis.opendocument.text']],
        'ods' => [['ods'], ['application/vnd.oasis.opendocument.spreadsheet']],
    ];

    /**
     * Returns the format.
     *
     * @param ServerRequestInterface $request
     *
     * @return string|null
     */
    public static function getFormat(ServerRequestInterface $request)
    {
        return self::getAttribute($request, self::KEY);
    }

    /**
     * Add a new format.
     *
     * @param string     $format
     * @param array      $mimeTypes
     * @param array|null $extensions
     *
     * @return self
     */
    public function addFormat($format, array $mimeTypes, array $extensions = null)
    {
        $this->formats[$format] = [is_null($extensions) ? [$format] : $extensions, $mimeTypes];

        return $this;
    }

    /**
     * Set the default format.
     *
     * @param string $format
     *
     * @return self
     */
    public function defaultFormat($format)
    {
        $this->default = $format;

        return $this;
    }

    /**
     * @param string[]|null $priorities Formats which the server supports, in priority order.
     */
    public function __construct($priorities = null)
    {
        $this->priorities = $priorities;
function aContainsB(array $needle = null, array  $haystack) {
    if (!$needle) {
        return false;
    }

    return array_intersect($haystack, $needle) == $haystack;
}
    }

    /**
     * Execute the middleware.
     *
     * @param ServerRequestInterface $request
     * @param ResponseInterface      $response
     * @param callable               $next
     *
     * @return ResponseInterface
     */
    public function __invoke(ServerRequestInterface $request, ResponseInterface $response, callable $next)
    {
        $format = $this->getFromExtension($request) ?: $this->getFromHeader($request) ?: $this->default;
        $contentType = $this->formats[$format][1][0].'; charset=utf-8';

        $response = $next(
            self::setAttribute($request, self::KEY, $format),
            $response->withHeader('Content-Type', $contentType)
        );

        if (!$response->hasHeader('Content-Type')) {
            $response = $response->withHeader('Content-Type', $contentType);
        }

        return $response;
    }

    /**
     * Returns the format using the file extension.
     *
     * @return null|string
     */
    private function getFromExtension(ServerRequestInterface $request)
    {
        $extension = strtolower(pathinfo($request->getUri()->getPath(), PATHINFO_EXTENSION));

        if (empty($extension)) {
            return;
        }

        foreach ($this->formats as $format => $data) {

            if (in_array($extension, $data[0], true)) {
                return $format;
            }
        }
    }

    /**
     * Returns the format using the Accept header.
     *
     * @return null|string
     */
    private function getFromHeader(ServerRequestInterface $request)
    {
        $accept = $request->getHeaderLine('Accept');

        //If the client accepts everything, then return null and allow the default to be used.
        if (empty($accept) || $accept === "*" || $accept === "*/*") {
            return null;
        }

        if (empty($this->priorities)) {
            $formats = $this->formats;
        } else {
            //Filter the list of formats.
            $formats = [];
            foreach ($this->priorities as $priority) {
                if (isset($this->formats[$priority])) {
                    $formats[$priority] = $this->formats[$priority];
                }
            }
        }
        $headers = call_user_func_array('array_merge', array_column($formats, 1));
        $mime = $this->negotiateHeader($accept, new Negotiator(), $headers);

        if ($mime !== null) {
            foreach ($this->formats as $format => $data) {

                if (in_array($mime, $data[1], true)) {
                    return $format;
                }
            }
        }
    }
}


1		<?php
2
3		namespace Psr7Middlewares\Middleware;
4
5		use Psr7Middlewares\Utils;
6		use Psr\Http\Message\ServerRequestInterface;
7		use Psr\Http\Message\ResponseInterface;
8		use Negotiation\Negotiator;
9
10		/**
11		* Middleware returns the client preferred format.
12		*/
13		class FormatNegotiator
14		{
15		use Utils\NegotiateTrait;
16		use Utils\AttributeTrait;
17
18		const KEY = 'FORMAT';
19
20		/**
21		* @var string Default format
22		*/
23		private $default = 'html';
24
25		/**
26		* @var string[] Formats which the server supports
27		*/
28		private $priorities = array();
29
30		/**
31		* @var array Available formats with the mime types
32		*/
33		private $formats = [
34		//text
35		'html' => [['html', 'htm', 'php'], ['text/html', 'application/xhtml+xml']],
36		'txt' => [['txt'], ['text/plain']],
37		'css' => [['css'], ['text/css']],
38		'json' => [['json'], ['application/json', 'text/json', 'application/x-json']],
39		'jsonp' => [['jsonp'], ['text/javascript', 'application/javascript', 'application/x-javascript']],
40		'js' => [['js'], ['text/javascript', 'application/javascript', 'application/x-javascript']],
41
42		//xml
43		'rdf' => [['rdf'], ['application/rdf+xml']],
44		'rss' => [['rss'], ['application/rss+xml']],
45		'atom' => [['atom'], ['application/atom+xml']],
46		'xml' => [['xml'], ['text/xml', 'application/xml', 'application/x-xml']],
47
48		//images
49		'bmp' => [['bmp'], ['image/bmp']],
50		'gif' => [['gif'], ['image/gif']],
51		'png' => [['png'], ['image/png', 'image/x-png']],
52		'jpg' => [['jpg', 'jpeg', 'jpe'], ['image/jpeg', 'image/jpg']],
53		'svg' => [['svg', 'svgz'], ['image/svg+xml']],
54		'psd' => [['psd'], ['image/vnd.adobe.photoshop']],
55		'eps' => [['ai', 'eps', 'ps'], ['application/postscript']],
56		'ico' => [['ico'], ['image/x-icon', 'image/vnd.microsoft.icon']],
57
58		//audio/video
59		'mov' => [['mov', 'qt'], ['video/quicktime']],
60		'mp3' => [['mp3'], ['audio/mpeg']],
61		'mp4' => [['mp4'], ['video/mp4']],
62		'ogg' => [['ogg'], ['audio/ogg']],
63		'ogv' => [['ogv'], ['video/ogg']],
64		'webm' => [['webm'], ['video/webm']],
65		'webp' => [['webp'], ['image/webp']],
66
67		//fonts
68		'eot' => [['eot'], ['application/vnd.ms-fontobject']],
69		'otf' => [['otf'], ['font/opentype', 'application/x-font-opentype']],
70		'ttf' => [['ttf'], ['font/ttf', 'application/font-ttf', 'application/x-font-ttf']],
71		'woff' => [['woff'], ['font/woff', 'application/font-woff', 'application/x-font-woff']],
72		'woff2' => [['woff2'], ['font/woff2', 'application/font-woff2', 'application/x-font-woff2']],
73
74		//other formats
75		'pdf' => [['pdf'], ['application/pdf', 'application/x-download']],
76		'zip' => [['zip'], ['application/zip', 'application/x-zip', 'application/x-zip-compressed']],
77		'rar' => [['rar'], ['application/rar', 'application/x-rar', 'application/x-rar-compressed']],
78		'exe' => [['exe'], ['application/x-msdownload']],
79		'msi' => [['msi'], ['application/x-msdownload']],
80		'cab' => [['cab'], ['application/vnd.ms-cab-compressed']],
81		'doc' => [['doc'], ['application/msword']],
82		'rtf' => [['rtf'], ['application/rtf']],
83		'xls' => [['xls'], ['application/vnd.ms-excel']],
84		'ppt' => [['ppt'], ['application/vnd.ms-powerpoint']],
85		'odt' => [['odt'], ['application/vnd.oasis.opendocument.text']],
86		'ods' => [['ods'], ['application/vnd.oasis.opendocument.spreadsheet']],
87		];
88
89		/**
90		* Returns the format.
91		*
92		* @param ServerRequestInterface $request
93		*
94		* @return string\|null
95		*/
96		public static function getFormat(ServerRequestInterface $request)
97		{
98		return self::getAttribute($request, self::KEY);
99		}
100
101		/**
102		* Add a new format.
103		*
104		* @param string $format
105		* @param array $mimeTypes
106		* @param array\|null $extensions
107		*
108		* @return self
109		*/
110		public function addFormat($format, array $mimeTypes, array $extensions = null)
111		{
112		$this->formats[$format] = [is_null($extensions) ? [$format] : $extensions, $mimeTypes];
113
114		return $this;
115		}
116
117		/**
118		* Set the default format.
119		*
120		* @param string $format
121		*
122		* @return self
123		*/
124		public function defaultFormat($format)
125		{
126		$this->default = $format;
127
128		return $this;
129		}
130
131		/**
132		* @param string[]\|null $priorities Formats which the server supports, in priority order.
133		*/
134		public function __construct($priorities = null)
135		{
136		$this->priorities = $priorities;
		0 ignored issues – show Documentation Bug introduced 2017-08-16 23:09 UTC by Report Bug Copy Issue Report It seems like `$priorities` can be `null`. However, the property `$priorities` is declared as `array`. Maybe change the type of the property to `array\|null` or add a type check? Our type inference engine has found an assignment of a scalar value (like a string, an integer or null) to a property which is an array. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property. To type hint that a parameter can be either an array or null, you can set a type hint of array and a default value of null. The PHP interpreter will then accept both an array or null for that parameter. function aContainsB(array $needle = null, array $haystack) { if (!$needle) { return false; } return array_intersect($haystack, $needle) == $haystack; } The function can be called with either null or an array for the parameter `$needle` but will only accept an array as `$haystack`. Loading history...
137		}
138
139		/**
140		* Execute the middleware.
141		*
142		* @param ServerRequestInterface $request
143		* @param ResponseInterface $response
144		* @param callable $next
145		*
146		* @return ResponseInterface
147		*/
148		public function __invoke(ServerRequestInterface $request, ResponseInterface $response, callable $next)
149		{
150		$format = $this->getFromExtension($request) ?: $this->getFromHeader($request) ?: $this->default;
151		$contentType = $this->formats[$format][1][0].'; charset=utf-8';
152
153		$response = $next(
154		self::setAttribute($request, self::KEY, $format),
155		$response->withHeader('Content-Type', $contentType)
156		);
157
158		if (!$response->hasHeader('Content-Type')) {
159		$response = $response->withHeader('Content-Type', $contentType);
160		}
161
162		return $response;
163		}
164
165		/**
166		* Returns the format using the file extension.
167		*
168		* @return null\|string
169		*/
170		private function getFromExtension(ServerRequestInterface $request)
171		{
172		$extension = strtolower(pathinfo($request->getUri()->getPath(), PATHINFO_EXTENSION));
173
174		if (empty($extension)) {
175		return;
176		}
177
178	View Code Duplication	foreach ($this->formats as $format => $data) {
		0 ignored issues – show Duplication introduced 2016-03-22 19:12 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
179		if (in_array($extension, $data[0], true)) {
180		return $format;
181		}
182		}
183		}
184
185		/**
186		* Returns the format using the Accept header.
187		*
188		* @return null\|string
189		*/
190		private function getFromHeader(ServerRequestInterface $request)
191		{
192		$accept = $request->getHeaderLine('Accept');
193
194		//If the client accepts everything, then return null and allow the default to be used.
195		if (empty($accept) \|\| $accept === "" \|\| $accept === "/*") {
196		return null;
197		}
198
199		if (empty($this->priorities)) {
200		$formats = $this->formats;
201		} else {
202		//Filter the list of formats.
203		$formats = [];
204		foreach ($this->priorities as $priority) {
205		if (isset($this->formats[$priority])) {
206		$formats[$priority] = $this->formats[$priority];
207		}
208		}
209		}
210		$headers = call_user_func_array('array_merge', array_column($formats, 1));
211		$mime = $this->negotiateHeader($accept, new Negotiator(), $headers);
212
213		if ($mime !== null) {
214	View Code Duplication	foreach ($this->formats as $format => $data) {
		0 ignored issues – show Duplication introduced 2016-03-22 19:12 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
215		if (in_array($mime, $data[1], true)) {
216		return $format;
217		}
218		}
219		}
220		}
221		}
222

oscarotero / psr7-middlewares

Pull Request — master (#81)

FormatNegotiator::getFromHeader() D

Complexity

Size

Duplication

Importance

How to fix Complexity

Long Method

Duplication Side-by-Side

Filter issues like