first commit

Author: Athlon1600

.gitignore

@@ -0,0 +1,9 @@
+/vendor
+composer.phar
+composer.lock
+.DS_Store
+Thumbs.db
+/phpunit.xml
+/.idea
+/.vscode
+.phpunit.result.cache

README.md

@@ -1,2 +1,28 @@
-# php-curl-file-downloader
-Download large files using PHP and cURL
+# Download large files using PHP and cURL
+
+There's too many code snippets on the Internet on how to do this, but not enough libraries. So I made this.
+
+```php
+<?php
+
+use Curl\Client;
+use CurlDownloader\CurlDownloader;
+
+$browser = new Client();
+$downloader = new CurlDownloader($browser);
+
+$downloader->download("https://download.ccleaner.com/cctrialsetup.exe", function ($filename) {
+    return './2020-06-07-' . $filename;
+});
+```
+
+## Installation
+
+```bash
+composer require athlon1600/php-curl-file-downloader
+```
+
+### Links
+
+- https://demo.borland.com/testsite/download_testpage.php
+

composer.json

@@ -0,0 +1,19 @@
+{
+    "name": "athlon1600/php-curl-file-downloader",
+    "require": {
+        "athlon1600/php-curl-client": "^1.0"
+    },
+    "require-dev": {
+        "phpunit/phpunit": "^7.0"
+    },
+    "autoload": {
+        "psr-4": {
+            "CurlDownloader\\": "src/"
+        }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "CurlDownloader\\Tests\\": "tests"
+        }
+    }
+}

src/CurlDownloader.php

@@ -0,0 +1,68 @@
+<?php
+
+namespace CurlDownloader;
+
+use Curl\Client;
+
+class CurlDownloader
+{
+    /** @var Client */
+    private $client;
+
+    // Timeout after 10 minutes.
+    protected $max_timeout = 600;
+
+    public function __construct(Client $client)
+    {
+        $this->client = $client;
+    }
+
+    protected function createTempFile()
+    {
+        return tempnam(sys_get_temp_dir(), uniqid());
+    }
+
+    protected function getFilenameFromUrl($url)
+    {
+        $url_path = parse_url($url, PHP_URL_PATH);
+        return basename($url_path);
+    }
+
+    /**
+     * @param $url
+     * @param $destination
+     * @return \Curl\Response
+     */
+    public function download($url, $destination)
+    {
+        $handler = new HeaderHandler();
+
+        // Will download file to temp for now
+        $temp_filename = $this->createTempFile();
+
+        $handle = fopen($temp_filename, 'w+');
+
+        $response = $this->client->request('GET', $url, [], [], [
+            CURLOPT_FILE => $handle,
+            CURLOPT_HEADERFUNCTION => $handler->callback(),
+            CURLOPT_TIMEOUT => $this->max_timeout
+        ]);
+
+        if ($response->info->http_code === 200) {
+            $filename = $handler->getContentDispositionFilename();
+
+            if (empty($filename)) {
+                $filename = $this->getFilenameFromUrl($response->info->url);
+            }
+
+            $save_to = call_user_func($destination, $filename);
+
+            rename($temp_filename, $save_to);
+        }
+
+        @fclose($handle);
+        @unlink($temp_filename);
+
+        return $response;
+    }
+}

src/HeaderHandler.php

@@ -0,0 +1,80 @@
+<?php
+
+namespace CurlDownloader;
+
+class HeaderHandler
+{
+    protected $headers = array();
+
+    /** @var callable */
+    protected $callback;
+
+    // Thanks Drupal!
+    // const REQUEST_HEADER_FILENAME_REGEX = '@\\bfilename(?<star>\\*?)=\\"(?<filename>.+)\\"@';
+    const REQUEST_HEADER_FILENAME_REGEX = '/filename\s*=\s*["\']*(?<filename>[^"\']+)/';
+
+    public function callback()
+    {
+        $oThis = $this;
+
+        $headers = array();
+        $first_line_sent = false;
+
+        return function ($ch, $data) use ($oThis, &$first_line_sent, &$headers) {
+            $line = trim($data);
+
+            if ($first_line_sent == false) {
+                $first_line_sent = true;
+            } elseif ($line === '') {
+                $oThis->sendHeaders();
+            } else {
+
+                $parts = explode(':', $line, 2);
+
+                // Despite that headers may be retrieved case-insensitively, the original case MUST be preserved by the implementation
+                // Non-conforming HTTP applications may depend on a certain case,
+                // so it is useful for a user to be able to dictate the case of the HTTP headers when creating a request or response.
+
+                // TODO:
+                // Multiple message-header fields with the same field-name may be present in a message
+                // if and only if the entire field-value for that header field is defined as a comma-separated list
+                $oThis->headers[trim($parts[0])] = isset($parts[1]) ? trim($parts[1]) : null;
+            }
+
+            return strlen($data);
+        };
+    }
+
+    protected function sendHeaders()
+    {
+        if (is_callable($this->callback)) {
+            call_user_func($this->callback, $this);
+        }
+    }
+
+    /**
+     * @param callable $callback
+     */
+    public function onHeadersReceived($callback)
+    {
+        $this->callback = $callback;
+    }
+
+    // While header names are not case-sensitive, getHeaders() will preserve the exact case in which headers were originally specified.
+    public function getHeaders()
+    {
+        return $this->headers;
+    }
+
+    public function getContentDispositionFilename()
+    {
+        $normalized = array_change_key_case($this->headers, CASE_LOWER);
+        $header = isset($normalized['content-disposition']) ? $normalized['content-disposition'] : null;
+
+        if ($header && preg_match(static::REQUEST_HEADER_FILENAME_REGEX, $header, $matches)) {
+            return $matches['filename'];
+        }
+
+        return null;
+    }
+}

tests/DownloadTest.php

@@ -0,0 +1,62 @@
+<?php
+
+namespace CurlDownloader\Tests;
+
+use Curl\Client;
+use CurlDownloader\CurlDownloader;
+use PHPUnit\Framework\TestCase;
+
+class DownloadTest extends TestCase
+{
+    /** @var CurlDownloader */
+    protected $client;
+
+    protected function setUp()
+    {
+        $this->client = new CurlDownloader(new Client());
+    }
+
+    public function test_download_directly()
+    {
+        $this->client->download("https://demo.borland.com/testsite/downloads/Small.zip", function ($filename) {
+            return './' . $filename;
+        });
+
+        $this->assertTrue(file_exists('./Small.zip'));
+
+        unlink('./Small.zip');
+    }
+
+    public function test_download_content_disposition()
+    {
+        $this->client->download("https://demo.borland.com/testsite/downloads/downloadfile.php?file=Data1KB.dat&cd=attachment+filename", function ($filename) {
+            return './' . $filename;
+        });
+
+        $this->assertTrue(file_exists('./Data1KB.dat'));
+
+        unlink('./Data1KB.dat');
+    }
+
+    public function test_download_content_disposition_github()
+    {
+        $this->client->download("https://github.com/guzzle/guzzle/releases/download/6.5.4/guzzle.zip", function ($filename) {
+            return './' . $filename;
+        });
+
+        $this->assertTrue(file_exists('./guzzle.zip'));
+
+        unlink('./guzzle.zip');
+    }
+
+    public function test_download_content_disposition_custom_filename()
+    {
+        $this->client->download("https://demo.borland.com/testsite/downloads/downloadfile.php?file=Data1KB.dat&cd=attachment+filename", function ($filename) {
+            return './2020-06-07-' . $filename;
+        });
+
+        $this->assertTrue(file_exists('./2020-06-07-Data1KB.dat'));
+
+        unlink('./2020-06-07-Data1KB.dat');
+    }
+}