HttpClient::getStreamContext() - Code Metrics - Inspection of "Function file_get_contents has been replaced with..." - puli/installer - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions

Pull Request — master (#8)

by Mateusz

created 2015-12-10 21:04 UTC

HttpClient::getStreamContext() A

↳ Parent: Project

Complexity

Conditions	3
Paths	3

Size

Total Lines	14
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	9
CRAP Score	3

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
c	1
b	0
f	1
dl	0
loc	14
ccs	9
cts	9
cp	1
rs	9.4286
cc	3
eloc	7
nc	3
nop	1
crap	3

<?php

/*
 * This file is part of the puli/installer package.
 *
 * (c) Bernhard Schussek <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Puli\Installer;

use RuntimeException;

/**
 * Downloads files.
 *
 * This file was adapted from the installer file bundled with Composer. For the
 * original file, authors and copyright information see
 *
 * https://github.com/composer/getcomposer.org/blob/master/web/installer
 *
 * @author Nils Adermann <[email protected]>
 * @author Jordi Boggiano <[email protected]>
 * @author Thomas Rudolph <[email protected]>
 * @author Bernhard Schussek <[email protected]>
 */
class HttpClient
{
    /**
     * @var array
     */
    private $headers = array(
        "Connection: close\r\n",
        "User-Agent: Puli Installer\r\n",
    );

    /**
     * @var bool
     */
    private $tls = false;

    /**
     * Creates the HTTP client.
     *
     * @param bool $disableTls Whether to disable TLS.
     */
    public function __construct($disableTls = false)
    {
        $this->tls = !$disableTls;

        if (extension_loaded('zlib')) {
            $this->headers[] = "Accept-Encoding: gzip\r\n";
        }
    }

    /**
     * Downloads a file.
     *
     * @param string $url The URL of the file to download.
     *
     * @return string The downloaded file body.
     */
    public function download($url)
    {
        if ($this->tls) {
            humbug_set_headers($this->headers);
            $result = humbug_get_contents($url);
        } else {
            $context = $this->getNonSslStreamContext($url);
            $result = file_get_contents($url, null, $context);
        }

        if ($result && extension_loaded('zlib')) {
            $decode = false;
            $responseHeaders = $this->tls ? humbug_get_headers() : $http_response_header;
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

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

    // $x is potentially undefined here.
    echo $x;
}

            foreach ($responseHeaders as $header) {
                if (preg_match('{^content-encoding: *gzip *$}i', $header)) {
                    $decode = true;
                    continue;
                } elseif (preg_match('{^HTTP/}i', $header)) {
                    $decode = false;
                }
            }

            if ($decode) {
                $result = version_compare(PHP_VERSION, '5.4.0', '>=')
                    ? zlib_decode($result)
                    // work around issue with gzuncompress & co that do not work with all gzip checksums
                    : file_get_contents('compress.zlib://data:application/octet-stream;base64,'.base64_encode($result));

                if (!$result) {
                    throw new RuntimeException('Failed to decode zlib stream');
                }
            }
        }

        return $result;
    }

    private function getNonSslStreamContext($url)
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

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

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        // Handle system proxy
        if (!empty($_SERVER['HTTP_PROXY']) || !empty($_SERVER['http_proxy'])) {
            // Some systems seem to rely on a lowercased version instead...
            $proxy = parse_url(!empty($_SERVER['http_proxy']) ? $_SERVER['http_proxy'] : $_SERVER['HTTP_PROXY']);
        }

        if (!empty($proxy)) {
            $proxyURL = isset($proxy['scheme']) ? $proxy['scheme'].'://' : '';
            $proxyURL .= isset($proxy['host']) ? $proxy['host'] : '';

            if (isset($proxy['port'])) {
                $proxyURL .= ':'.$proxy['port'];
            } elseif ('http://' === substr($proxyURL, 0, 7)) {
                $proxyURL .= ':80';
            } elseif ('https://' === substr($proxyURL, 0, 8)) {
                $proxyURL .= ':443';
            }

            // http(s):// is not supported in proxy

            $proxyURL = str_replace(array('http://', 'https://'), array('tcp://', 'ssl://'), $proxyURL);

            if (0 === strpos($proxyURL, 'ssl:') && !extension_loaded('openssl')) {
                throw new RuntimeException('You must enable the openssl extension to use a proxy over https');
            }

            $options['http'] = array(
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
                'proxy' => $proxyURL,
            );

            // enabled request_fulluri unless it is explicitly disabled
            switch (parse_url($url, PHP_URL_SCHEME)) {
                case 'http': // default request_fulluri to true

                    $reqFullUriEnv = getenv('HTTP_PROXY_REQUEST_FULLURI');
                    if ($reqFullUriEnv === false || $reqFullUriEnv === '' || (strtolower($reqFullUriEnv) !== 'false' && (bool) $reqFullUriEnv)) {
                        $options['http']['request_fulluri'] = true;
                    }
                    break;
                case 'https': // default request_fulluri to true

                    $reqFullUriEnv = getenv('HTTPS_PROXY_REQUEST_FULLURI');
                    if ($reqFullUriEnv === false || $reqFullUriEnv === '' || (strtolower($reqFullUriEnv) !== 'false' && (bool) $reqFullUriEnv)) {
                        $options['http']['request_fulluri'] = true;
                    }
                    break;
            }

            if (isset($proxy['user'])) {
                $auth = urldecode($proxy['user']);
                if (isset($proxy['pass'])) {
                    $auth .= ':'.urldecode($proxy['pass']);
                }
                $auth = base64_encode($auth);

                $options['http']['header'] = "Proxy-Authorization: Basic {$auth}\r\n";
// Instead of
$x = "foo $bar $baz";

// Better use either
$x = "foo " . $bar . " " . $baz;
$x = sprintf("foo %s %s", $bar, $baz);
            }
        }

        if (isset($options['http']['header'])) {
            $options['http']['header'] .= implode('', $this->headers);
        } else {
            $options['http']['header'] = implode('', $this->headers);
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

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

    // $x is potentially undefined here.
    echo $x;
}
        }

        $options['http']['protocol_version'] = 1.1;

        return stream_context_create($options);
    }
}


1			<?php
2
3			/*
4			* This file is part of the puli/installer package.
5			*
6			* (c) Bernhard Schussek <[email protected]>
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 Puli\Installer;
13
14			use RuntimeException;
15
16			/**
17			* Downloads files.
18			*
19			* This file was adapted from the installer file bundled with Composer. For the
20			* original file, authors and copyright information see
21			*
22			* https://github.com/composer/getcomposer.org/blob/master/web/installer
23			*
24			* @author Nils Adermann <[email protected]>
25			* @author Jordi Boggiano <[email protected]>
26			* @author Thomas Rudolph <[email protected]>
27			* @author Bernhard Schussek <[email protected]>
28			*/
29			class HttpClient
30			{
31			/**
32			* @var array
33			*/
34			private $headers = array(
35			"Connection: close\r\n",
36			"User-Agent: Puli Installer\r\n",
37			);
38
39			/**
40			* @var bool
41			*/
42			private $tls = false;
43
44			/**
45			* Creates the HTTP client.
46			*
47			* @param bool $disableTls Whether to disable TLS.
48			*/
49	5		public function __construct($disableTls = false)
50			{
51	5		$this->tls = !$disableTls;
52
53	5		if (extension_loaded('zlib')) {
54	5		$this->headers[] = "Accept-Encoding: gzip\r\n";
55	5		}
56	5		}
57
58			/**
59			* Downloads a file.
60			*
61			* @param string $url The URL of the file to download.
62			*
63			* @return string The downloaded file body.
64			*/
65	5		public function download($url)
66			{
67	5		if ($this->tls) {
68	5		humbug_set_headers($this->headers);
69	5		$result = humbug_get_contents($url);
70	5		} else {
71			$context = $this->getNonSslStreamContext($url);
72			$result = file_get_contents($url, null, $context);
73			}
74
75	5		if ($result && extension_loaded('zlib')) {
76	5		$decode = false;
77	5		$responseHeaders = $this->tls ? humbug_get_headers() : $http_response_header;
			0 ignored issues – show Bug introduced 2015-12-09 23:38 UTC by Report Bug Copy Issue Report The variable `$http_response_header` 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...
78
79	5		foreach ($responseHeaders as $header) {
80	5		if (preg_match('{^content-encoding: gzip $}i', $header)) {
81			$decode = true;
82			continue;
83	5		} elseif (preg_match('{^HTTP/}i', $header)) {
84	5		$decode = false;
85	5		}
86	5		}
87
88	5		if ($decode) {
89			$result = version_compare(PHP_VERSION, '5.4.0', '>=')
90			? zlib_decode($result)
91			// work around issue with gzuncompress & co that do not work with all gzip checksums
92			: file_get_contents('compress.zlib://data:application/octet-stream;base64,'.base64_encode($result));
93
94			if (!$result) {
95			throw new RuntimeException('Failed to decode zlib stream');
96			}
97			}
98	5		}
99
100	5		return $result;
101			}
102
103			private function getNonSslStreamContext($url)
			0 ignored issues – show Coding Style introduced 2015-12-09 23:38 UTC by Report Bug Copy Issue Report `getNonSslStreamContext` uses the super-global variable `$_SERVER` which is generally not recommended. Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable: // Bad class Router { public function generate($path) { return $_SERVER['HOST'].$path; } } // Better class Router { private $host; public function __construct($host) { $this->host = $host; } public function generate($path) { return $this->host.$path; } } class Controller { public function myAction(Request $request) { // Instead of $page = isset($_GET['page']) ? intval($_GET['page']) : 1; // Better (assuming you use the Symfony2 request) $page = $request->query->get('page', 1); } } Loading history...
104			{
105			// Handle system proxy
106			if (!empty($_SERVER['HTTP_PROXY']) \|\| !empty($_SERVER['http_proxy'])) {
107			// Some systems seem to rely on a lowercased version instead...
108			$proxy = parse_url(!empty($_SERVER['http_proxy']) ? $_SERVER['http_proxy'] : $_SERVER['HTTP_PROXY']);
109			}
110
111			if (!empty($proxy)) {
112			$proxyURL = isset($proxy['scheme']) ? $proxy['scheme'].'://' : '';
113			$proxyURL .= isset($proxy['host']) ? $proxy['host'] : '';
114
115			if (isset($proxy['port'])) {
116			$proxyURL .= ':'.$proxy['port'];
117			} elseif ('http://' === substr($proxyURL, 0, 7)) {
118			$proxyURL .= ':80';
119			} elseif ('https://' === substr($proxyURL, 0, 8)) {
120			$proxyURL .= ':443';
121			}
122
123			// http(s):// is not supported in proxy
			0 ignored issues – show Unused Code Comprehensibility introduced 2015-12-06 22:15 UTC by Report Bug Copy Issue Report `67%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
124			$proxyURL = str_replace(array('http://', 'https://'), array('tcp://', 'ssl://'), $proxyURL);
125
126			if (0 === strpos($proxyURL, 'ssl:') && !extension_loaded('openssl')) {
127			throw new RuntimeException('You must enable the openssl extension to use a proxy over https');
128			}
129
130			$options['http'] = array(
			0 ignored issues – show Coding Style Comprehensibility introduced 2015-12-09 23:38 UTC by Report Bug Copy Issue Report `$options` was never initialized. Although not strictly required by PHP, it is generally a good practice to add `$options = array();` before regardless. Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code. Let’s take a look at an example: foreach ($collection as $item) { $myArray['foo'] = $item->getFoo(); if ($item->hasBar()) { $myArray['bar'] = $item->getBar(); } // do something with $myArray } As you can see in this example, the array `$myArray` is initialized the first time when the foreach loop is entered. You can also see that the value of the `bar` key is only written conditionally; thus, its value might result from a previous iteration. This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization `$myArray = array()` either outside or inside the foreach loop. Loading history...
131			'proxy' => $proxyURL,
132			);
133
134			// enabled request_fulluri unless it is explicitly disabled
135			switch (parse_url($url, PHP_URL_SCHEME)) {
136		View Code Duplication	case 'http': // default request_fulluri to true
			0 ignored issues – show Duplication introduced 2015-12-06 22:15 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...
137			$reqFullUriEnv = getenv('HTTP_PROXY_REQUEST_FULLURI');
138			if ($reqFullUriEnv === false \|\| $reqFullUriEnv === '' \|\| (strtolower($reqFullUriEnv) !== 'false' && (bool) $reqFullUriEnv)) {
139			$options['http']['request_fulluri'] = true;
140			}
141			break;
142		View Code Duplication	case 'https': // default request_fulluri to true
			0 ignored issues – show Duplication introduced 2015-12-06 22:15 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...
143			$reqFullUriEnv = getenv('HTTPS_PROXY_REQUEST_FULLURI');
144			if ($reqFullUriEnv === false \|\| $reqFullUriEnv === '' \|\| (strtolower($reqFullUriEnv) !== 'false' && (bool) $reqFullUriEnv)) {
145			$options['http']['request_fulluri'] = true;
146			}
147			break;
148			}
149
150			if (isset($proxy['user'])) {
151			$auth = urldecode($proxy['user']);
152			if (isset($proxy['pass'])) {
153			$auth .= ':'.urldecode($proxy['pass']);
154			}
155			$auth = base64_encode($auth);
156
157			$options['http']['header'] = "Proxy-Authorization: Basic {$auth}\r\n";
			0 ignored issues – show Coding Style Best Practice introduced 2015-12-06 22:15 UTC by Report Bug Copy Issue Report As per coding-style, please use concatenation or `sprintf` for the variable `$auth` instead of interpolation. It is generally a best practice as it is often more readable to use concatenation instead of interpolation for variables inside strings. // Instead of $x = "foo $bar $baz"; // Better use either $x = "foo " . $bar . " " . $baz; $x = sprintf("foo %s %s", $bar, $baz); Loading history...
158			}
159			}
160
161			if (isset($options['http']['header'])) {
162			$options['http']['header'] .= implode('', $this->headers);
163			} else {
164			$options['http']['header'] = implode('', $this->headers);
			0 ignored issues – show Bug introduced 2015-12-09 23:38 UTC by Report Bug Copy Issue Report The variable `$options` 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...
165			}
166
167			$options['http']['protocol_version'] = 1.1;
168
169			return stream_context_create($options);
170			}
171			}
172

puli / installer

Pull Request — master (#8)

HttpClient::getStreamContext() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like