PierInfor\GeoLite\Downloader

Complexity

Total Complexity

20

Size/Duplication

Total Lines	176
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	2
Bugs	0	Features	0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	download()	0	11	3
A	contentsDownload()	0	14	3
A	displayProgress()	0	4	1
A	setAdapter()	0	7	2
A	__construct()	0	4	1
A	getProgress()	0	3	1
A	downloadProgress()	0	7	3
B	curlDownload()	0	35	6

<?php

namespace PierInfor\GeoLite;

/**
 * Downloader class let download files
 */
class Downloader implements Interfaces\DownloaderInterface
{

    /**
     * factory adapter
     *
     * @var String
     */
    private $adapter;

    /**
     * Download progress percent
     *
     * @var Integer
     */
    private $progress;

    /**
     * Download progress percent
     *
     * @var Boolean
     */
    private $showProgress;

    /**
     * Instanciate
     */
    public function __construct()
    {
        $this->showProgress = false;
        $this->setAdapter();
    }

    /**
     * set adapter for download factory
     *
     * @param string $adapter
     * @return Downloader
     */
    public function setAdapter(string $adapter = self::ADAPTER_CURL): Downloader
    {
        if (!in_array($adapter, self::ADAPTERS)) {
            throw new \Exception('Downloader - bad adapter');
        }
        $this->adapter = $adapter;
        return $this;
    }

    /**
     * download factory
     *
     * @param string $url
     * @param string $toFilename
     * @return Downloader
     */
    public function download(string $url, string $toFilename): Downloader
    {
        switch ($this->adapter) {
            case self::ADAPTER_CONTENTS:
                $this->contentsDownload($url, $toFilename);
                break;
            case self::ADAPTER_CURL:
                $this->curlDownload($url, $toFilename);
                break;
        }
        return $this;
    }

    /**
     * download a file using file_get_content
     *
     * @param string $url
     * @param string $toFilename
     * @return Downloader
     */
    public function contentsDownload(string $url, string $toFilename): Downloader
    {
        $headers = get_headers($url);
        $statusCode = 0;
        if (isset($headers[0])) {
            $header = $headers[0];
            preg_match("/^HTTP.+\s(\d\d\d)\s/", $header, $m);
            $statusCode = $m[1];
        }
        if ($statusCode != 200) {
            throw new \Exception('Bad http code : ' . $statusCode);
        }
        file_put_contents($toFilename, file_get_contents($url));
        return $this;
    }

    /**
     * enable progress output when using curlDownload
     *
     * @param boolean $show
     * @return Downloader
     */
    public function displayProgress(bool $show = false): Downloader
    {
        $this->showProgress = $show;
        return $this;
    }

    /**
     * download a file using curl
     *
     * @param string $url
     * @param string $toFilename
     * @return Downloader
     */
    public function curlDownload(string $url, string $toFilename): Downloader
    {
        touch($toFilename, 0777);
        $handle = fopen($toFilename, 'wba+');
        $handleOk = false !== $handle;
        $cha = curl_init();
        if (false !== $cha && $handleOk) {
            curl_setopt($cha, CURLOPT_VERBOSE, false);
            curl_setopt($cha, CURLOPT_URL, $url);
            curl_setopt($cha, CURLOPT_POST, 0);
            curl_setopt($cha, CURLOPT_TIMEOUT, 300);
            curl_setopt($cha, CURLOPT_HEADER, false);
            curl_setopt($cha, CURLOPT_USERAGENT, self::USER_AGENT);
            curl_setopt($cha, CURLOPT_BUFFERSIZE, self::BUFFER_SIZE);
            curl_setopt($cha, CURLOPT_RETURNTRANSFER, 1);
            curl_setopt($cha, CURLOPT_FILE, $handle);
            curl_setopt($cha, CURLOPT_FOLLOWLOCATION, true);
            curl_setopt($cha, CURLOPT_BINARYTRANSFER, true);
            curl_setopt($cha, CURLOPT_FOLLOWLOCATION, true);
            curl_setopt($cha, CURLOPT_NOPROGRESS, false);
            curl_setopt($cha, CURLOPT_PROGRESSFUNCTION, [$this, self::DOWNLOAD_CALLBACK]);
            curl_setopt($cha, CURLOPT_AUTOREFERER, true);
            curl_exec($cha);
            if (!curl_errno($cha)) {
                $statusCode = curl_getinfo($cha, CURLINFO_HTTP_CODE);
                if ($statusCode != 200) {
                    throw new \Exception('Bad http code : ' . $statusCode);
                }
            }
            curl_close($cha);
        }
        if (is_resource($handle)) {
            fclose($handle);
        }
        return $this;
    }

    /**
     * download progress callback
     *
     * @param mixed $resource
     * @param integer $download_size
     * @param integer $downloaded
     * @param integer $upload_size
     * @param integer $uploaded
     * @return void
     */
    protected function downloadProgress($resource, int $download_size, int $downloaded, int $upload_size, int $uploaded)
    {
        if ($download_size > 0) {
            $this->progress = ($downloaded / $download_size) * 100;
            if ($this->showProgress === true) {
                echo self::WHEELS[$this->progress % 4]
                    . ' ' . $this->getProgress() . "%\r";
            }
        }
    }

    /**
     * returns progress value
     *
     * @return integer
     */
    protected function getProgress(): int
    {
        return $this->progress;
    }
}