FormatNegotiator::sanitize() - Code Metrics - Inspection of "Deprecate the maxDepth context attribute in favor..." - FriendsOfSymfony/FOSRestBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#1506)

by Guilh

created 2016-06-17 14:54 UTC

FormatNegotiator::sanitize() A

↳ Parent: FormatNegotiator

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes

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

<?php

/*
 * This file is part of the FOSRestBundle package.
 *
 * (c) FriendsOfSymfony <http://friendsofsymfony.github.com/>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace FOS\RestBundle\Negotiation;

use FOS\RestBundle\Util\StopFormatListenerException;
use Negotiation\Accept;
use Negotiation\Negotiator as BaseNegotiator;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\RequestMatcherInterface;
use Symfony\Component\HttpFoundation\RequestStack;

/**
 * @author Ener-Getick <[email protected]>
 */
class FormatNegotiator extends BaseNegotiator
{
    private $map = [];
    private $requestStack;

    public function __construct(RequestStack $requestStack, array $mimeTypes = array())
    {
        $this->requestStack = $requestStack;
        $this->mimeTypes = $mimeTypes;
class MyClass { }

$x = new MyClass();
$x->foo = true;
    }

    /**
     * @param RequestMatcherInterface $requestMatcher
     * @param array                   $options
     */
    public function add(RequestMatcherInterface $requestMatcher, array $options = [])
    {
        $this->map[] = [$requestMatcher, $options];
    }

    /**
     * {@inheritdoc}
     * The best format is also determined in function of the bundle configuration.
     *
     * @throws StopFormatListenerException
     */
    public function getBest($header, array $priorities = [])
    {
        $request = $this->getRequest();
        $header = $header ?: $request->headers->get('Accept');

        foreach ($this->map as $elements) {
            // Check if the current RequestMatcherInterface matches the current request
            if (!$elements[0]->matches($request)) {
                continue;
            }
            $options = &$elements[1]; // Do not reallow memory for this variable

            if (!empty($options['stop'])) {
                throw new StopFormatListenerException('Stopped format listener');
            }
            if (empty($options['priorities']) && empty($priorities)) {
                if (!empty($options['fallback_format'])) {
                    return new Accept($request->getMimeType($options['fallback_format']));
                }
                continue;
            }

            if (isset($options['prefer_extension']) && $options['prefer_extension'] && !isset($extensionHeader)) {
                $extension = pathinfo($request->getPathInfo(), PATHINFO_EXTENSION);

                if (!empty($extension)) {
                    // $extensionHeader will now be either a non empty string or an empty string
                    $extensionHeader = $request->getMimeType($extension);
                    if ($header && $extensionHeader) {
                        $header .= ',';
                    }
                    $header .= $extensionHeader.'; q='.$options['prefer_extension'];
                }
            }

            if ($header) {
                $mimeTypes = $this->normalizePriorities($request,
                    empty($priorities) ? $options['priorities'] : $priorities
                );

                $mimeType = parent::getBest($header, $mimeTypes);

                if ($mimeType !== null) {
                    return $mimeType;
                }
            }

            if (isset($options['fallback_format'])) {
                // if false === fallback_format then we fail here instead of considering more rules
                if (false === $options['fallback_format']) {
                    return;
                }

                // stop looking at rules since we have a fallback defined
                return new Accept($request->getMimeType($options['fallback_format']));
            }
        }
    }

    /**
     * @param array $values
     *
     * @return array
     */
    private function sanitize(array $values)
    {
        return array_map(function ($value) {
            return preg_replace('/\s+/', '', strtolower($value));
        }, $values);
    }

    /**
     * Transform the format (json, html, ...) to their mimeType form (application/json, text/html, ...).
     *
     * @param Request  $request
     * @param string[] $priorities
     *
     * @return string[] formatted priorities
     */
    private function normalizePriorities(Request $request, array $priorities)
    {
        $priorities = $this->sanitize($priorities);

        $mimeTypes = array();
        foreach ($priorities as $priority) {
            if (strpos($priority, '/')) {
                $mimeTypes[] = $priority;
                continue;
            }

            if (method_exists(Request::class, 'getMimeTypes')) {
                $mimeTypes = array_merge($mimeTypes, Request::getMimeTypes($priority));

            } elseif (null !== $request->getMimeType($priority)) {
                $class = new \ReflectionClass(Request::class);
                $properties = $class->getStaticProperties();
                $mimeTypes = array_merge($mimeTypes, $properties['formats'][$priority]);
            }

            if (isset($this->mimeTypes[$priority])) {
                foreach ($this->mimeTypes[$priority] as $mimeType) {
                    $mimeTypes[] = $mimeType;
                }
            }
        }

        return $mimeTypes;
    }

    /**
     * @throws \RuntimeException
     *
     * @return Request
     */
    private function getRequest()

    {
        $request = $this->requestStack->getCurrentRequest();
        if ($request === null) {
            throw new \RuntimeException('There is no current request.');
        }

        return $request;
    }
}


1			<?php
2
3			/*
4			* This file is part of the FOSRestBundle package.
5			*
6			* (c) FriendsOfSymfony <http://friendsofsymfony.github.com/>
7			*
8			* For the full copyright and license information, please view the LICENSE
9			* file that was distributed with this source code.
10			*/
11
12			namespace FOS\RestBundle\Negotiation;
13
14			use FOS\RestBundle\Util\StopFormatListenerException;
15			use Negotiation\Accept;
16			use Negotiation\Negotiator as BaseNegotiator;
17			use Symfony\Component\HttpFoundation\Request;
18			use Symfony\Component\HttpFoundation\RequestMatcherInterface;
19			use Symfony\Component\HttpFoundation\RequestStack;
20
21			/**
22			* @author Ener-Getick <[email protected]>
23			*/
24			class FormatNegotiator extends BaseNegotiator
25			{
26			private $map = [];
27			private $requestStack;
28
29	20		public function __construct(RequestStack $requestStack, array $mimeTypes = array())
30			{
31	20		$this->requestStack = $requestStack;
32	20		$this->mimeTypes = $mimeTypes;
			0 ignored issues – show Bug introduced 2016-03-27 12:36 UTC by Report Bug Copy Issue Report The property `mimeTypes` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
33	20		}
34
35			/**
36			* @param RequestMatcherInterface $requestMatcher
37			* @param array $options
38			*/
39	19		public function add(RequestMatcherInterface $requestMatcher, array $options = [])
40			{
41	19		$this->map[] = [$requestMatcher, $options];
42	19		}
43
44			/**
45			* {@inheritdoc}
46			* The best format is also determined in function of the bundle configuration.
47			*
48			* @throws StopFormatListenerException
49			*/
50	17		public function getBest($header, array $priorities = [])
51			{
52	17		$request = $this->getRequest();
53	17		$header = $header ?: $request->headers->get('Accept');
54
55	17		foreach ($this->map as $elements) {
56			// Check if the current RequestMatcherInterface matches the current request
57	16		if (!$elements[0]->matches($request)) {
58	1		continue;
59			}
60	16		$options = &$elements[1]; // Do not reallow memory for this variable
61
62	16		if (!empty($options['stop'])) {
63	1		throw new StopFormatListenerException('Stopped format listener');
64			}
65	15		if (empty($options['priorities']) && empty($priorities)) {
66	2		if (!empty($options['fallback_format'])) {
67	2		return new Accept($request->getMimeType($options['fallback_format']));
68			}
69	1		continue;
70			}
71
72	13		if (isset($options['prefer_extension']) && $options['prefer_extension'] && !isset($extensionHeader)) {
73	8		$extension = pathinfo($request->getPathInfo(), PATHINFO_EXTENSION);
74
75	8		if (!empty($extension)) {
76			// $extensionHeader will now be either a non empty string or an empty string
77			$extensionHeader = $request->getMimeType($extension);
78			if ($header && $extensionHeader) {
79			$header .= ',';
80			}
81			$header .= $extensionHeader.'; q='.$options['prefer_extension'];
82			}
83	8		}
84
85	13		if ($header) {
86	12		$mimeTypes = $this->normalizePriorities($request,
87	12		empty($priorities) ? $options['priorities'] : $priorities
88	12		);
89
90	12		$mimeType = parent::getBest($header, $mimeTypes);
91
92	12		if ($mimeType !== null) {
93	11		return $mimeType;
94			}
95	1		}
96
97	2		if (isset($options['fallback_format'])) {
98			// if false === fallback_format then we fail here instead of considering more rules
99	2		if (false === $options['fallback_format']) {
100			return;
101			}
102
103			// stop looking at rules since we have a fallback defined
104	2		return new Accept($request->getMimeType($options['fallback_format']));
105			}
106	3		}
107	3		}
108
109			/**
110			* @param array $values
111			*
112			* @return array
113			*/
114			private function sanitize(array $values)
115			{
116	12		return array_map(function ($value) {
117	12		return preg_replace('/\s+/', '', strtolower($value));
118	12		}, $values);
119			}
120
121			/**
122			* Transform the format (json, html, ...) to their mimeType form (application/json, text/html, ...).
123			*
124			* @param Request $request
125			* @param string[] $priorities
126			*
127			* @return string[] formatted priorities
128			*/
129	12		private function normalizePriorities(Request $request, array $priorities)
130			{
131	12		$priorities = $this->sanitize($priorities);
132
133	12		$mimeTypes = array();
134	12		foreach ($priorities as $priority) {
135	12		if (strpos($priority, '/')) {
136	2		$mimeTypes[] = $priority;
137	2		continue;
138			}
139
140	11		if (method_exists(Request::class, 'getMimeTypes')) {
141	11		$mimeTypes = array_merge($mimeTypes, Request::getMimeTypes($priority));
			0 ignored issues – show Bug introduced 2016-01-16 16:20 UTC by Report Bug Copy Issue Report The method `getMimeTypes()` does not exist on `Symfony\Component\HttpFoundation\Request`. Did you maybe mean `getMimeType()`? This check marks calls to methods that do not seem to exist on an object. This is most likely the result of a method being renamed without all references to it being renamed likewise. Loading history...
142	11		} elseif (null !== $request->getMimeType($priority)) {
143			$class = new \ReflectionClass(Request::class);
144			$properties = $class->getStaticProperties();
145			$mimeTypes = array_merge($mimeTypes, $properties['formats'][$priority]);
146			}
147
148	11		if (isset($this->mimeTypes[$priority])) {
149	3		foreach ($this->mimeTypes[$priority] as $mimeType) {
150	3		$mimeTypes[] = $mimeType;
151	3		}
152	3		}
153	12		}
154
155	12		return $mimeTypes;
156			}
157
158			/**
159			* @throws \RuntimeException
160			*
161			* @return Request
162			*/
163	17	View Code Duplication	private function getRequest()
			0 ignored issues – show Duplication introduced 2015-11-21 09:45 UTC by Report Bug Copy Issue Report This method seems to be duplicated in 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...
164			{
165	17		$request = $this->requestStack->getCurrentRequest();
166	17		if ($request === null) {
167			throw new \RuntimeException('There is no current request.');
168			}
169
170	17		return $request;
171			}
172			}
173

FriendsOfSymfony / FOSRestBundle

Pull Request — master (#1506)

FormatNegotiator::sanitize() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like