BrowserKit::send() - Code Metrics - Inspection of "Handle file uploads correct" - Behatch/contexts - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#275)

unknown

created 2019-03-26 22:06 UTC

BrowserKit::send() B

↳ Parent: BrowserKit

Complexity

Conditions	6
Paths	4

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	27
rs	8.8657
c	0
b	0
f	0
cc	6
nc	4
nop	6

<?php

namespace Behatch\HttpCall\Request;

use Behat\Mink\Driver\Goutte\Client as GoutteClient;
use Behat\Mink\Mink;
use Symfony\Component\BrowserKit\Client as BrowserKitClient;
use Symfony\Component\HttpFoundation\File\UploadedFile;

class BrowserKit
{
    protected $mink;

    public function __construct(Mink $mink)
    {
        $this->mink = $mink;
    }

    public function getMethod()
    {
        return $this->getRequest()
            ->getMethod();
    }

    public function getUri()
    {
        return $this->getRequest()
            ->getUri();
    }

    public function getServer()
    {
        return $this->getRequest()
            ->getServer();
    }

    public function getParameters()
    {
        return $this->getRequest()
            ->getParameters();
    }

    protected function getRequest()
    {
        $client = $this->mink->getSession()->getDriver()->getClient();
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
        // BC layer for BrowserKit 2.2.x and older
        if (method_exists($client, 'getInternalRequest')) {
            $request = $client->getInternalRequest();
        } else {
            $request = $client->getRequest();
        }
        return $request;
    }

    public function getContent()
    {
        return $this->mink->getSession()->getPage()->getContent();
    }

    public function send($method, $url, $parameters = [], $files = [], $content = null, $headers = [])
    {
        $client = $this->mink->getSession()->getDriver()->getClient();
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}

        $tmpFiles = [];
        if (true || !$client instanceof GoutteClient) {
            foreach ($files as &$file) {
                if (is_string($file)) {
                    $tmpName = tempnam(sys_get_temp_dir(), 'upload');
                    copy($file, $tmpName);
                    $tmpFiles[] = $tmpName;
                    $file = new UploadedFile($tmpName, $file, null, null, true);
                }
            }
        }

        $client->followRedirects(false);
        $client->request($method, $url, $parameters, $files, $headers, $content);
        $client->followRedirects(true);
        $this->resetHttpHeaders();

        foreach ($tmpFiles as $tmpName) {
            @unlink($tmpName);
// For example instead of
@mkdir($dir);

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

        return $this->mink->getSession()->getPage();
    }

    public function setHttpHeader($name, $value)
    {
        $client = $this->mink->getSession()->getDriver()->getClient();
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
        // Goutte\Client
        if (method_exists($client, 'setHeader')) {
            $client->setHeader($name, $value);
        } else {
            // Symfony\Component\BrowserKit\Client

            /* taken from Behat\Mink\Driver\BrowserKitDriver::setRequestHeader */
            $contentHeaders = ['CONTENT_LENGTH' => true, 'CONTENT_MD5' => true, 'CONTENT_TYPE' => true];
            $name = str_replace('-', '_', strtoupper($name));

            // CONTENT_* are not prefixed with HTTP_ in PHP when building $_SERVER
            if (!isset($contentHeaders[$name])) {
                $name = 'HTTP_' . $name;
            }
            /* taken from Behat\Mink\Driver\BrowserKitDriver::setRequestHeader */

            $client->setServerParameter($name, $value);
        }
    }

    public function getHttpHeaders()
    {
        return array_change_key_case(
            $this->mink->getSession()->getResponseHeaders(),
            CASE_LOWER
        );
    }

    public function getHttpHeader($name)
    {
        $values = $this->getHttpRawHeader($name);

        return implode(', ', $values);
    }

    public function getHttpRawHeader($name)
    {
        $name = strtolower($name);
        $headers = $this->getHttpHeaders();

        if (isset($headers[$name])) {
            $value = $headers[$name];
            if (!is_array($headers[$name])) {
                $value = [$headers[$name]];
            }
        } else {
            throw new \OutOfBoundsException(
                "The header '$name' doesn't exist"
            );
        }
        return $value;
    }

    protected function resetHttpHeaders()
    {
        /** @var GoutteClient|BrowserKitClient $client */
        $client = $this->mink->getSession()->getDriver()->getClient();
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}

        $client->setServerParameters([]);
        if ($client instanceof GoutteClient) {
            $client->restart();
        }
    }
}


1			<?php
2
3			namespace Behatch\HttpCall\Request;
4
5			use Behat\Mink\Driver\Goutte\Client as GoutteClient;
6			use Behat\Mink\Mink;
7			use Symfony\Component\BrowserKit\Client as BrowserKitClient;
8			use Symfony\Component\HttpFoundation\File\UploadedFile;
9
10			class BrowserKit
11			{
12			protected $mink;
13
14			public function __construct(Mink $mink)
15			{
16			$this->mink = $mink;
17			}
18
19			public function getMethod()
20			{
21			return $this->getRequest()
22			->getMethod();
23			}
24
25			public function getUri()
26			{
27			return $this->getRequest()
28			->getUri();
29			}
30
31			public function getServer()
32			{
33			return $this->getRequest()
34			->getServer();
35			}
36
37			public function getParameters()
38			{
39			return $this->getRequest()
40			->getParameters();
41			}
42
43			protected function getRequest()
44			{
45			$client = $this->mink->getSession()->getDriver()->getClient();
			0 ignored issues – show Bug introduced 2016-11-14 10:13 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Behat\Mink\Driver\DriverInterface` as the method `getClient()` does only exist in the following implementations of said interface: `Behat\Mink\Driver\BrowserKitDriver`, `Behat\Mink\Driver\GoutteDriver`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
46			// BC layer for BrowserKit 2.2.x and older
47			if (method_exists($client, 'getInternalRequest')) {
48			$request = $client->getInternalRequest();
49			} else {
50			$request = $client->getRequest();
51			}
52			return $request;
53			}
54
55			public function getContent()
56			{
57			return $this->mink->getSession()->getPage()->getContent();
58			}
59
60			public function send($method, $url, $parameters = [], $files = [], $content = null, $headers = [])
61			{
62			$client = $this->mink->getSession()->getDriver()->getClient();
			0 ignored issues – show Bug introduced 2016-04-04 16:18 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Behat\Mink\Driver\DriverInterface` as the method `getClient()` does only exist in the following implementations of said interface: `Behat\Mink\Driver\BrowserKitDriver`, `Behat\Mink\Driver\GoutteDriver`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
63
64			$tmpFiles = [];
65			if (true \|\| !$client instanceof GoutteClient) {
66			foreach ($files as &$file) {
67			if (is_string($file)) {
68			$tmpName = tempnam(sys_get_temp_dir(), 'upload');
69			copy($file, $tmpName);
70			$tmpFiles[] = $tmpName;
71			$file = new UploadedFile($tmpName, $file, null, null, true);
72			}
73			}
74			}
75
76			$client->followRedirects(false);
77			$client->request($method, $url, $parameters, $files, $headers, $content);
78			$client->followRedirects(true);
79			$this->resetHttpHeaders();
80
81			foreach ($tmpFiles as $tmpName) {
82			@unlink($tmpName);
			0 ignored issues – show Security Best Practice introduced 2019-03-26 13:29 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...
83			}
84
85			return $this->mink->getSession()->getPage();
86			}
87
88			public function setHttpHeader($name, $value)
89			{
90			$client = $this->mink->getSession()->getDriver()->getClient();
			0 ignored issues – show Bug introduced 2017-04-03 08:21 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Behat\Mink\Driver\DriverInterface` as the method `getClient()` does only exist in the following implementations of said interface: `Behat\Mink\Driver\BrowserKitDriver`, `Behat\Mink\Driver\GoutteDriver`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
91			// Goutte\Client
92			if (method_exists($client, 'setHeader')) {
93			$client->setHeader($name, $value);
94			} else {
95			// Symfony\Component\BrowserKit\Client
96
97			/* taken from Behat\Mink\Driver\BrowserKitDriver::setRequestHeader */
98			$contentHeaders = ['CONTENT_LENGTH' => true, 'CONTENT_MD5' => true, 'CONTENT_TYPE' => true];
99			$name = str_replace('-', '_', strtoupper($name));
100
101			// CONTENT_* are not prefixed with HTTP_ in PHP when building $_SERVER
102			if (!isset($contentHeaders[$name])) {
103			$name = 'HTTP_' . $name;
104			}
105			/* taken from Behat\Mink\Driver\BrowserKitDriver::setRequestHeader */
106
107			$client->setServerParameter($name, $value);
108			}
109			}
110
111			public function getHttpHeaders()
112			{
113			return array_change_key_case(
114			$this->mink->getSession()->getResponseHeaders(),
115			CASE_LOWER
116			);
117			}
118
119			public function getHttpHeader($name)
120			{
121			$values = $this->getHttpRawHeader($name);
122
123			return implode(', ', $values);
124			}
125
126			public function getHttpRawHeader($name)
127			{
128			$name = strtolower($name);
129			$headers = $this->getHttpHeaders();
130
131			if (isset($headers[$name])) {
132			$value = $headers[$name];
133			if (!is_array($headers[$name])) {
134			$value = [$headers[$name]];
135			}
136			} else {
137			throw new \OutOfBoundsException(
138			"The header '$name' doesn't exist"
139			);
140			}
141			return $value;
142			}
143
144			protected function resetHttpHeaders()
145			{
146			/** @var GoutteClient\|BrowserKitClient $client */
147			$client = $this->mink->getSession()->getDriver()->getClient();
			0 ignored issues – show Bug introduced 2017-04-03 08:21 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Behat\Mink\Driver\DriverInterface` as the method `getClient()` does only exist in the following implementations of said interface: `Behat\Mink\Driver\BrowserKitDriver`, `Behat\Mink\Driver\GoutteDriver`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
148
149			$client->setServerParameters([]);
150			if ($client instanceof GoutteClient) {
151			$client->restart();
152			}
153			}
154			}
155

Behatch / contexts

Pull Request — master (#275)

BrowserKit::send() B

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like