CurlRemoteFilesystem::__construct() - Code Metrics - Inspection of "(WIP)Improve scrutinizer score" - hirak/prestissimo - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#44)

by Hiraku

created 2016-02-07 02:16 UTC

CurlRemoteFilesystem::__construct() A

↳ Parent: CurlRemoteFilesystem

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	5
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

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

<?php
/*
 * hirak/prestissimo
 * @author Hiraku NAKANO
 * @license MIT https://github.com/hirak/prestissimo
 */
namespace Hirak\Prestissimo;

use Composer\Config as CConfig;
use Composer\IO;
use Composer\Downloader;
use Composer\Util;

/**
 * yet another implementation about Composer\Util\RemoteFilesystem
 * non thread safe
 */
class CurlRemoteFilesystem extends Util\RemoteFilesystem
{
    protected $io;
    protected $config;
    protected $options;

    protected $retryAuthFailure = true;

    protected $pluginConfig;

    private $_lastHeaders = array();

    // global flags
    private $_retry = false;

    /** @var Aspects\JoinPoint */
    public $onPreDownload;

    /** @var Aspects\JoinPoint */
    public $onPostDownload;

    /**
     * @param IO\IOInterface $io
     * @param CConfig $config
     * @param array $options
     */
    public function __construct(IO\IOInterface $io, CConfig $config, array $options = array())
    {
        $this->io = $io;
        $this->config = $config;
        $this->options = $options;
    }

    public function setPluginConfig(array $pluginConfig)
    {
        $this->pluginConfig = $pluginConfig;
    }

    /**
     * Copy the remote file in local.
     *
     * @param string $origin    host/domain text
     * @param string $fileUrl   targeturl
     * @param string $fileName  the local filename
     * @param bool   $progress  Display the progression
     * @param array  $options   Additional context options
     *
     * @return bool true
     */
    public function copy($origin, $fileUrl, $fileName, $progress = true, $options = array())
    {
        $that = $this; // for PHP5.3

        return $this->fetch($origin, $fileUrl, $progress, $options, function($ch, $request) use ($that, $fileName) {
            $outputFile = new OutputFile($fileName);
            curl_setopt($ch, CURLOPT_RETURNTRANSFER, false);
            curl_setopt($ch, CURLOPT_FILE, $outputFile->getPointer());

            list(, $response) = $result = $that->exec($ch, $request);

            curl_setopt($ch, CURLOPT_FILE, STDOUT);

            if (200 === $response->info['http_code']) {
                $outputFile->setSuccess();
            }

            return $result;
        });
    }

    /**
     * Get the content.
     *
     * @param string $origin The origin URL
     * @param string $fileUrl   The file URL
     * @param bool   $progress  Display the progression
     * @param array  $options   Additional context options
     *
     * @return bool|string The content
     */
    public function getContents($origin, $fileUrl, $progress = true, $options = array())
    {
        $that = $this; // for PHP5.3

        return $this->fetch($origin, $fileUrl, $progress, $options, function($ch, $request) use ($that) {
            // This order is important.
            curl_setopt($ch, CURLOPT_FILE, STDOUT);
            curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

            return $that->exec($ch, $request);
        });
    }

    /**
     * @param string $origin
     * @param string $fileUrl
     * @param boolean $progress
     * @param \Closure $exec
     */
    protected function fetch($origin, $fileUrl, $progress, $options, $exec)
    {
        do {
            $this->_retry = false;

            $request = Factory::getHttpGetRequest($origin, $fileUrl, $this->io, $this->config, $this->pluginConfig);
            $this->onPreDownload = Factory::getPreEvent($request);
            $this->onPostDownload = Factory::getPostEvent($request);

            $options += $this->options;
            $request->processRFSOption($options);

            if ($this->io->isDebug()) {
                $this->io->write('Downloading ' . $fileUrl);
            }

            if ($progress) {
                $this->io->write("    Downloading: <comment>Connecting...</comment>", false);
                $request->curlOpts[CURLOPT_NOPROGRESS] = false;
                $request->curlOpts[CURLOPT_PROGRESSFUNCTION] = array($this, 'progress');
            } else {
                $request->curlOpts[CURLOPT_NOPROGRESS] = true;
                $request->curlOpts[CURLOPT_PROGRESSFUNCTION] = null;
            }

            $this->onPreDownload->notify();

            $opts = $request->getCurlOpts();
            $ch = Factory::getConnection($origin, isset($opts[CURLOPT_USERPWD]));

            curl_setopt_array($ch, $opts);

            list($execStatus,) = $exec($ch, $request);
        } while ($this->_retry);

        if ($progress) {
            $this->io->overwrite("    Downloading: <comment>100%</comment>");
        }

        return $execStatus;
    }

    /**
     * Retrieve the options set in the constructor
     *
     * @return array Options
     */
    public function getOptions()
    {
        return $this->options;
    }

    /**
     * Returns the headers of the last request
     *
     * @return array
     */
    public function getLastHeaders()
    {
        return $this->_lastHeaders;
    }

    /**
     * @internal
     * @param resource $ch
     * @param Aspects\HttpGetRequest $request
     * @return array {int, Aspects\HttpGetResponse}
     */
    public function exec($ch, Aspects\HttpGetRequest $request)
    {
        $this->_lastHeaders = array();
        curl_setopt($ch, CURLOPT_HEADERFUNCTION, array($this, 'processHeader'));
        $execStatus = curl_exec($ch);

        $response = new Aspects\HttpGetResponse(
            curl_errno($ch),
            curl_error($ch),
            curl_getinfo($ch)
        );
        $this->onPostDownload->setResponse($response);
        $this->onPostDownload->notify();

        if ($response->needAuth()) {
            $this->promptAuth($request, $response);
        }

        return array($execStatus, $response);
    }

    /**
     * @internal
     */
    public function progress()
    {
        // @codeCoverageIgnoreStart
        if (PHP_VERSION_ID >= 50500) {
            list(, $downBytesMax, $downBytes,,) = func_get_args();
        } else {
            list($downBytesMax, $downBytes,,) = func_get_args();
        }
        // @codeCoverageIgnoreEnd

        if ($downBytesMax <= 0 || $downBytesMax < $downBytes) {
            return 0;
        }

        $progression = intval($downBytes / $downBytesMax * 100);
        $this->io->overwrite("    Downloading: <comment>$progression%</comment>", false);
        return 0;
    }

    /**
     * @internal
     * @param resource $ch
     * @param string $header
     * @return int
     */
    public function processHeader($ch, $header)
    {
        $this->_lastHeaders[] = trim($header);
        return strlen($header);
    }

    protected function promptAuth(Aspects\HttpGetRequest $req, Aspects\HttpGetResponse $res)
    {
        $this->_retry = $req->promptAuth($res, $this->config, $this->io);
    }
}


1		<?php
2		/*
3		* hirak/prestissimo
4		* @author Hiraku NAKANO
5		* @license MIT https://github.com/hirak/prestissimo
6		*/
7		namespace Hirak\Prestissimo;
8
9		use Composer\Config as CConfig;
10		use Composer\IO;
11		use Composer\Downloader;
12		use Composer\Util;
13
14		/**
15		* yet another implementation about Composer\Util\RemoteFilesystem
16		* non thread safe
17		*/
18		class CurlRemoteFilesystem extends Util\RemoteFilesystem
19		{
20		protected $io;
21		protected $config;
22		protected $options;
23
24		protected $retryAuthFailure = true;
25
26		protected $pluginConfig;
27
28		private $_lastHeaders = array();
29
30		// global flags
31		private $_retry = false;
32
33		/** @var Aspects\JoinPoint */
34		public $onPreDownload;
35
36		/** @var Aspects\JoinPoint */
37		public $onPostDownload;
38
39		/**
40		* @param IO\IOInterface $io
41		* @param CConfig $config
42		* @param array $options
43		*/
44	8	public function __construct(IO\IOInterface $io, CConfig $config, array $options = array())
45		{
46	8	$this->io = $io;
47	8	$this->config = $config;
48	8	$this->options = $options;
49	8	}
50
51	8	public function setPluginConfig(array $pluginConfig)
52		{
53	8	$this->pluginConfig = $pluginConfig;
54	8	}
55
56		/**
57		* Copy the remote file in local.
58		*
59		* @param string $origin host/domain text
60		* @param string $fileUrl targeturl
61		* @param string $fileName the local filename
62		* @param bool $progress Display the progression
63		* @param array $options Additional context options
64		*
65		* @return bool true
66		*/
67	4	public function copy($origin, $fileUrl, $fileName, $progress = true, $options = array())
68		{
69	4	$that = $this; // for PHP5.3
70
71		return $this->fetch($origin, $fileUrl, $progress, $options, function($ch, $request) use ($that, $fileName) {
72	4	$outputFile = new OutputFile($fileName);
73	4	curl_setopt($ch, CURLOPT_RETURNTRANSFER, false);
74	4	curl_setopt($ch, CURLOPT_FILE, $outputFile->getPointer());
75
76	4	list(, $response) = $result = $that->exec($ch, $request);
77
78	2	curl_setopt($ch, CURLOPT_FILE, STDOUT);
79
80	2	if (200 === $response->info['http_code']) {
81	1	$outputFile->setSuccess();
82	1	}
83
84	2	return $result;
85	4	});
86		}
87
88		/**
89		* Get the content.
90		*
91		* @param string $origin The origin URL
92		* @param string $fileUrl The file URL
93		* @param bool $progress Display the progression
94		* @param array $options Additional context options
95		*
96		* @return bool\|string The content
97		*/
98	1	public function getContents($origin, $fileUrl, $progress = true, $options = array())
99		{
100	1	$that = $this; // for PHP5.3
101
102	1	return $this->fetch($origin, $fileUrl, $progress, $options, function($ch, $request) use ($that) {
103		// This order is important.
104	1	curl_setopt($ch, CURLOPT_FILE, STDOUT);
105	1	curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
106
107	1	return $that->exec($ch, $request);
108	1	});
109		}
110
111		/**
112		* @param string $origin
113		* @param string $fileUrl
114		* @param boolean $progress
115		* @param \Closure $exec
116		*/
117	5	protected function fetch($origin, $fileUrl, $progress, $options, $exec)
118		{
119		do {
120	5	$this->_retry = false;
121
122	5	$request = Factory::getHttpGetRequest($origin, $fileUrl, $this->io, $this->config, $this->pluginConfig);
123	5	$this->onPreDownload = Factory::getPreEvent($request);
124	5	$this->onPostDownload = Factory::getPostEvent($request);
125
126	5	$options += $this->options;
127	5	$request->processRFSOption($options);
128
129	5	if ($this->io->isDebug()) {
130		$this->io->write('Downloading ' . $fileUrl);
131		}
132
133	5	if ($progress) {
134	4	$this->io->write(" Downloading: <comment>Connecting...</comment>", false);
135	4	$request->curlOpts[CURLOPT_NOPROGRESS] = false;
136	4	$request->curlOpts[CURLOPT_PROGRESSFUNCTION] = array($this, 'progress');
137	4	} else {
138	1	$request->curlOpts[CURLOPT_NOPROGRESS] = true;
139	1	$request->curlOpts[CURLOPT_PROGRESSFUNCTION] = null;
140		}
141
142	5	$this->onPreDownload->notify();
143
144	5	$opts = $request->getCurlOpts();
145	5	$ch = Factory::getConnection($origin, isset($opts[CURLOPT_USERPWD]));
146
147	5	curl_setopt_array($ch, $opts);
148
149	5	list($execStatus,) = $exec($ch, $request);
150	3	} while ($this->_retry);
151
152	3	if ($progress) {
153	2	$this->io->overwrite(" Downloading: <comment>100%</comment>");
154	2	}
155
156	3	return $execStatus;
157		}
158
159		/**
160		* Retrieve the options set in the constructor
161		*
162		* @return array Options
163		*/
164	1	public function getOptions()
165		{
166	1	return $this->options;
167		}
168
169		/**
170		* Returns the headers of the last request
171		*
172		* @return array
173		*/
174	1	public function getLastHeaders()
175		{
176	1	return $this->_lastHeaders;
177		}
178
179		/**
180		* @internal
181		* @param resource $ch
182		* @param Aspects\HttpGetRequest $request
183		* @return array {int, Aspects\HttpGetResponse}
184		*/
185	5	public function exec($ch, Aspects\HttpGetRequest $request)
186		{
187	5	$this->_lastHeaders = array();
188	5	curl_setopt($ch, CURLOPT_HEADERFUNCTION, array($this, 'processHeader'));
189	5	$execStatus = curl_exec($ch);
190
191	5	$response = new Aspects\HttpGetResponse(
192	5	curl_errno($ch),
193	5	curl_error($ch),
194	5	curl_getinfo($ch)
195	5	);
196	5	$this->onPostDownload->setResponse($response);
197	5	$this->onPostDownload->notify();
198
199	5	if ($response->needAuth()) {
200	3	$this->promptAuth($request, $response);
201	1	}
202
203	3	return array($execStatus, $response);
204		}
205
206		/**
207		* @internal
208		*/
209	4	public function progress()
210		{
211		// @codeCoverageIgnoreStart
212		if (PHP_VERSION_ID >= 50500) {
213		list(, $downBytesMax, $downBytes,,) = func_get_args();
214		} else {
215		list($downBytesMax, $downBytes,,) = func_get_args();
216		}
217		// @codeCoverageIgnoreEnd
218
219	4	if ($downBytesMax <= 0 \|\| $downBytesMax < $downBytes) {
220	1	return 0;
221		}
222
223	4	$progression = intval($downBytes / $downBytesMax * 100);
224	4	$this->io->overwrite(" Downloading: <comment>$progression%</comment>", false);
225	4	return 0;
226		}
227
228		/**
229		* @internal
230		* @param resource $ch
231		* @param string $header
232		* @return int
233		*/
234	5	public function processHeader($ch, $header)
235		{
236	5	$this->_lastHeaders[] = trim($header);
237	5	return strlen($header);
238		}
239
240	3	protected function promptAuth(Aspects\HttpGetRequest $req, Aspects\HttpGetResponse $res)
241		{
242	3	$this->_retry = $req->promptAuth($res, $this->config, $this->io);
243	1	}
244		}
245

hirak / prestissimo

Pull Request — master (#44)

CurlRemoteFilesystem::__construct() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like