MultipartRequestListener::setRequestContent() - Code Metrics - Inspection of "Merge pull request #6 from goetas/remove-old-part" - goetas/MultipartUploadBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — master (95c7f4)

by Asmir

created 2019-01-05 22:39 UTC

MultipartRequestListener::setRequestContent() A

↳ Parent: MultipartRequestListener

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	5
CRAP Score	1

Importance

Changes

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

<?php

namespace Goetas\MultipartUploadBundle\EventListener;

use Riverline\MultiPartParser\Converters\HttpFoundation;
use Symfony\Component\HttpFoundation\File\UploadedFile;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\HttpKernel\Event\GetResponseEvent;

class MultipartRequestListener
{
    /**
     * @var bool
     */
    private $injectFirstPart;

    public function __construct(bool $injectFirstPart = true)
    {
        $this->injectFirstPart = $injectFirstPart;
    }

    public function onKernelRequest(GetResponseEvent $event)
    {
        try {
            $this->processRequest($event->getRequest());
        } catch (\LogicException $e) {
            $message = 'Bad Request';

            if ($e->getMessage()) {
                $message .= ': ' . $e->getMessage();
            }

            $response = new Response($message, 400);

            $event->setResponse($response);
        }
    }

    private function processRequest(Request $request)
    {
        $contentType = $request->headers->get('Content-Type');
        if (0 === strpos($contentType, 'multipart/')) {

            $streamedPart = HttpFoundation::convert($request);

            if ($this->injectFirstPart === true) {
                $request->headers->remove('Content-Type');
                $request->headers->remove('Content-Length');
            }
            $attachments = [];
            $relatedParts = $streamedPart->getParts();

            foreach ($relatedParts as $k => $part) {

                if ($this->injectFirstPart === true && 0 === $k) {
                    $request->headers->add($part->getHeaders());
                    if ('application/x-www-form-urlencoded' === $part->getHeader('Content-Type')) {
                        $output = [];
                        parse_str($part->getBody(), $output);
                        $request->request->add($output);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
                    } else {
                        $this->setRequestContent($request, $part->getBody());
                    }
                    continue;
                }

                $contentDisposition = $part->getHeader('Content-Disposition');

                if ($contentDisposition === null) {
                    continue;
                }

                $fileName = $part->getFileName();

                if ($fileName!== null) {
                    $fp = tmpfile();
                    fwrite($fp, $part->getBody());
                    rewind($fp);

                    $tmpPath = stream_get_meta_data($fp)['uri'];

                    $ref = new \ReflectionClass('Symfony\Component\HttpFoundation\File\UploadedFile');
                    $params = $ref->getConstructor()->getParameters();
                    if ('error' === $params[3]->getName()) { // symfony 4
                        $file = new UploadedFile($tmpPath, urldecode($fileName), $part->getMimeType(), null, true);
                    } else { // symfony < 4
                        $file = new UploadedFile($tmpPath, urldecode($fileName), $part->getMimeType(), filesize($tmpPath), null, false);
                    }
                    @$file->ref = $fp;
// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
                    $attachments[] = $file;
                }

                if (($formName = $this->isDispositionFormData($contentDisposition)) !== null) {
                    $formPath = $this->parseKey($formName);

                    if ($fileName !== null) {
                        $files = $request->files->all();
                        $files = $this->mergeFormArray($files, $formPath, $file);
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
                        $request->files->replace($files);
                    } else {
                        $data = $request->request->all();
                        $data = $this->mergeFormArray($data, $formPath, $part->getBody());
                        $request->request->replace($data);
                    }
                }
            }

            $request->attributes->set('attachments', $attachments);
            $request->attributes->set('related-parts', $relatedParts);
        }
    }

    protected function mergeFormArray($array, $path, $data)
    {
        if (count($path) > 0) {
            $key = array_shift($path);

            if (!is_array($array)) {
                $array = [];
            }

            if (!empty($key)) {
                $array[$key] = $this->mergeFormArray($array[$key] ?? [], $path, $data);
            } else {
                $array[] = $data;
            }

            return $array;
        }

        return $data;
    }

    private function parseKey($key)
    {
        return array_map(
            function ($v) {
                return trim($v, ']');
            },
            explode('[', $key)
        );
    }

    private function isDispositionFormData($value)
    {
        if (preg_match('/(?:^|form-data;\s*)name="?([^";]+)("|;|$)/', $value, $matches)) {
            return trim($matches[1]);
        }
        return null;
    }

    private function setRequestContent(Request $request, $content)
    {
        $p = new \ReflectionProperty(Request::class, 'content');
        $p->setAccessible(true);
        $p->setValue($request, $content);
    }
}


1		<?php
2
3		namespace Goetas\MultipartUploadBundle\EventListener;
4
5		use Riverline\MultiPartParser\Converters\HttpFoundation;
6		use Symfony\Component\HttpFoundation\File\UploadedFile;
7		use Symfony\Component\HttpFoundation\Request;
8		use Symfony\Component\HttpFoundation\Response;
9		use Symfony\Component\HttpKernel\Event\GetResponseEvent;
10
11		class MultipartRequestListener
12		{
13		/**
14		* @var bool
15		*/
16		private $injectFirstPart;
17
18	13	public function __construct(bool $injectFirstPart = true)
19		{
20	13	$this->injectFirstPart = $injectFirstPart;
21	13	}
22
23	13	public function onKernelRequest(GetResponseEvent $event)
24		{
25		try {
26	13	$this->processRequest($event->getRequest());
27	4	} catch (\LogicException $e) {
28	4	$message = 'Bad Request';
29
30	4	if ($e->getMessage()) {
31	4	$message .= ': ' . $e->getMessage();
32		}
33
34	4	$response = new Response($message, 400);
35
36	4	$event->setResponse($response);
37		}
38	13	}
39
40	13	private function processRequest(Request $request)
41		{
42	13	$contentType = $request->headers->get('Content-Type');
43	13	if (0 === strpos($contentType, 'multipart/')) {
44
45	13	$streamedPart = HttpFoundation::convert($request);
46
47	9	if ($this->injectFirstPart === true) {
48	8	$request->headers->remove('Content-Type');
49	8	$request->headers->remove('Content-Length');
50		}
51	9	$attachments = [];
52	9	$relatedParts = $streamedPart->getParts();
53
54	9	foreach ($relatedParts as $k => $part) {
55
56	9	if ($this->injectFirstPart === true && 0 === $k) {
57	8	$request->headers->add($part->getHeaders());
58	8	if ('application/x-www-form-urlencoded' === $part->getHeader('Content-Type')) {
59		$output = [];
60		parse_str($part->getBody(), $output);
61		$request->request->add($output);
		0 ignored issues – show Bug introduced 2018-12-10 18:05 UTC by Report Bug Copy Issue Report It seems like `$output` can also be of type `null`; however, `Symfony\Component\HttpFo...ion\ParameterBag::add()` does only seem to accept `array`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
62		} else {
63	8	$this->setRequestContent($request, $part->getBody());
64		}
65	8	continue;
66		}
67
68	5	$contentDisposition = $part->getHeader('Content-Disposition');
69
70	5	if ($contentDisposition === null) {
71	2	continue;
72		}
73
74	3	$fileName = $part->getFileName();
75
76	3	if ($fileName!== null) {
77	2	$fp = tmpfile();
78	2	fwrite($fp, $part->getBody());
79	2	rewind($fp);
80
81	2	$tmpPath = stream_get_meta_data($fp)['uri'];
82
83	2	$ref = new \ReflectionClass('Symfony\Component\HttpFoundation\File\UploadedFile');
84	2	$params = $ref->getConstructor()->getParameters();
85	2	if ('error' === $params[3]->getName()) { // symfony 4
86	2	$file = new UploadedFile($tmpPath, urldecode($fileName), $part->getMimeType(), null, true);
87		} else { // symfony < 4
88		$file = new UploadedFile($tmpPath, urldecode($fileName), $part->getMimeType(), filesize($tmpPath), null, false);
89		}
90	2	@$file->ref = $fp;
		0 ignored issues – show Bug introduced 2019-01-05 22:42 UTC by Report Bug Copy Issue Report The property `ref` does not seem to exist in `Symfony\Component\HttpFoundation\File\UploadedFile`. An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history... Security Best Practice introduced 2019-01-05 22:42 UTC by Report Bug Copy Issue Report It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended. If you suppress an error, we recommend checking for the error condition explicitly: // For example instead of @mkdir($dir); // Better use if (@mkdir($dir) === false) { throw new \RuntimeException('The directory '.$dir.' could not be created.'); } Loading history...
91	2	$attachments[] = $file;
92		}
93
94	3	if (($formName = $this->isDispositionFormData($contentDisposition)) !== null) {
95	2	$formPath = $this->parseKey($formName);
96
97	2	if ($fileName !== null) {
98	1	$files = $request->files->all();
99	1	$files = $this->mergeFormArray($files, $formPath, $file);
		0 ignored issues – show Bug introduced 2019-01-05 22:42 UTC by Report Bug Copy Issue Report The variable `$file` does not seem to be defined for all execution paths leading up to this point. If you define a variable conditionally, it can happen that it is not defined for all execution paths. Let’s take a look at an example: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } // $x is potentially undefined here. echo $x; } In the above example, the variable `$x` is defined if you pass “foo” or “bar” as argument for `$a`. However, since the `switch` statement has no default case statement, if you pass any other value, the variable `$x` would be undefined. Available Fixes Check for existence of the variable explicitly: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } if (isset($x)) { // Make sure it's always set. echo $x; } } Define a default value for the variable: function myFunction($a) { $x = ''; // Set a default which gets overridden for certain paths. switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } echo $x; } Add a value for the missing path: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; // We add support for the missing case. default: $x = ''; break; } echo $x; } Loading history...
100	1	$request->files->replace($files);
101		} else {
102	1	$data = $request->request->all();
103	1	$data = $this->mergeFormArray($data, $formPath, $part->getBody());
104	3	$request->request->replace($data);
105		}
106		}
107		}
108
109	9	$request->attributes->set('attachments', $attachments);
110	9	$request->attributes->set('related-parts', $relatedParts);
111		}
112	9	}
113
114	2	protected function mergeFormArray($array, $path, $data)
115		{
116	2	if (count($path) > 0) {
117	2	$key = array_shift($path);
118
119	2	if (!is_array($array)) {
120		$array = [];
121		}
122
123	2	if (!empty($key)) {
124	2	$array[$key] = $this->mergeFormArray($array[$key] ?? [], $path, $data);
125		} else {
126	2	$array[] = $data;
127		}
128
129	2	return $array;
130		}
131
132		return $data;
133		}
134
135	2	private function parseKey($key)
136		{
137	2	return array_map(
138		function ($v) {
139	2	return trim($v, ']');
140	2	},
141	2	explode('[', $key)
142		);
143		}
144
145	3	private function isDispositionFormData($value)
146		{
147	3	if (preg_match('/(?:^\|form-data;\s*)name="?([^";]+)("\|;\|$)/', $value, $matches)) {
148	2	return trim($matches[1]);
149		}
150	1	return null;
151		}
152
153	8	private function setRequestContent(Request $request, $content)
154		{
155	8	$p = new \ReflectionProperty(Request::class, 'content');
156	8	$p->setAccessible(true);
157	8	$p->setValue($request, $content);
158	8	}
159		}
160

goetas / MultipartUploadBundle

Branch — master (95c7f4)

MultipartRequestListener::setRequestContent() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like