Use httplug

2025-08-01 17:38:38 +00:00 · 2017-10-24 22:55:40 +02:00 · 2017-10-24 22:55:40 +02:00 · bf9ace0643
commit bf9ace0643
parent 92a6683562
10 changed files with 329 additions and 373 deletions
--- a/src/Wallabag/CoreBundle/Helper/DownloadImages.php
+++ b/src/Wallabag/CoreBundle/Helper/DownloadImages.php
@ -2,8 +2,13 @@

 namespace Wallabag\CoreBundle\Helper;

-use GuzzleHttp\Client;
-use GuzzleHttp\Message\Response;
+use Http\Client\Common\HttpMethodsClient;
+use Http\Client\Common\Plugin\ErrorPlugin;
+use Http\Client\Common\PluginClient;
+use Http\Client\HttpClient;
+use Http\Discovery\MessageFactoryDiscovery;
+use Http\Message\MessageFactory;
+use Psr\Http\Message\ResponseInterface;
 use Psr\Log\LoggerInterface;
 use Symfony\Component\DomCrawler\Crawler;
 use Symfony\Component\Finder\Finder;
@ -19,9 +24,9 @@ class DownloadImages
    private $mimeGuesser;
    private $wallabagUrl;

-    public function __construct(Client $client, $baseFolder, $wallabagUrl, LoggerInterface $logger)
+    public function __construct(HttpClient $client, $baseFolder, $wallabagUrl, LoggerInterface $logger, MessageFactory $messageFactory = null)
    {
-        $this->client = $client;
+        $this->client = new HttpMethodsClient(new PluginClient($client, [new ErrorPlugin()]), $messageFactory ?: MessageFactoryDiscovery::find());
        $this->baseFolder = $baseFolder;
        $this->wallabagUrl = rtrim($wallabagUrl, '/');
        $this->logger = $logger;
@ -135,7 +140,7 @@ class DownloadImages
        $localPath = $folderPath . '/' . $hashImage . '.' . $ext;

        try {
-            $im = imagecreatefromstring($res->getBody());
+            $im = imagecreatefromstring((string) $res->getBody());
        } catch (\Exception $e) {
            $im = false;
        }
@ -306,14 +311,14 @@ class DownloadImages
    /**
     * Retrieve and validate the extension from the response of the url of the image.
     *
-     * @param Response $res       Guzzle Response
+     * @param ResponseInterface $res       Http Response
     * @param string   $imagePath Path from the src image from the content (used for log only)
     *
     * @return string|false Extension name or false if validation failed
     */
-    private function getExtensionFromResponse(Response $res, $imagePath)
+    private function getExtensionFromResponse(ResponseInterface $res, $imagePath)
    {
-        $ext = $this->mimeGuesser->guess($res->getHeader('content-type'));
+        $ext = $this->mimeGuesser->guess(current($res->getHeader('content-type')));
        $this->logger->debug('DownloadImages: Checking extension', ['ext' => $ext, 'header' => $res->getHeader('content-type')]);

        // ok header doesn't have the extension, try a different way
--- a/src/Wallabag/CoreBundle/Helper/HttpClientFactory.php
+++ b/src/Wallabag/CoreBundle/Helper/HttpClientFactory.php
@ -2,16 +2,18 @@

 namespace Wallabag\CoreBundle\Helper;

-use Graby\Ring\Client\SafeCurlHandler;
-use GuzzleHttp\Client;
+use GuzzleHttp\Client as GuzzleClient;
 use GuzzleHttp\Cookie\CookieJar;
 use GuzzleHttp\Event\SubscriberInterface;
+use Http\Adapter\Guzzle5\Client as GuzzleAdapter;
 use Psr\Log\LoggerInterface;
+use Http\Client\HttpClient;
+use Http\HttplugBundle\ClientFactory\ClientFactory;

 /**
- * Builds and configures the Guzzle HTTP client.
+ * Builds and configures the HTTP client.
 */
-class HttpClientFactory
+class HttpClientFactory implements ClientFactory
 {
    /** @var [\GuzzleHttp\Event\SubscriberInterface] */
    private $subscribers = [];
@ -36,29 +38,6 @@ class HttpClientFactory
        $this->logger = $logger;
    }

-    /**
-     * @return \GuzzleHttp\Client|null
-     */
-    public function buildHttpClient()
-    {
-        $this->logger->log('debug', 'Restricted access config enabled?', ['enabled' => (int) $this->restrictedAccess]);
-
-        if (0 === (int) $this->restrictedAccess) {
-            return;
-        }
-
-        // we clear the cookie to avoid websites who use cookies for analytics
-        $this->cookieJar->clear();
-        // need to set the (shared) cookie jar
-        $client = new Client(['handler' => new SafeCurlHandler(), 'defaults' => ['cookies' => $this->cookieJar]]);
-
-        foreach ($this->subscribers as $subscriber) {
-            $client->getEmitter()->attach($subscriber);
-        }
-
-        return $client;
-    }
-
    /**
     * Adds a subscriber to the HTTP client.
     *
@ -68,4 +47,30 @@ class HttpClientFactory
    {
        $this->subscribers[] = $subscriber;
    }
+
+    /**
+     * Input an array of configuration to be able to create a HttpClient.
+     *
+     * @param array $config
+     *
+     * @return HttpClient
+     */
+    public function createClient(array $config = [])
+    {
+        $this->logger->log('debug', 'Restricted access config enabled?', ['enabled' => (int) $this->restrictedAccess]);
+
+        if (0 === (int) $this->restrictedAccess) {
+            return new GuzzleAdapter(new GuzzleClient());
+        }
+
+        // we clear the cookie to avoid websites who use cookies for analytics
+        $this->cookieJar->clear();
+        // need to set the (shared) cookie jar
+        $guzzle = new GuzzleClient(['defaults' => ['cookies' => $this->cookieJar]]);
+        foreach ($this->subscribers as $subscriber) {
+            $guzzle->getEmitter()->attach($subscriber);
+        }
+
+        return new GuzzleAdapter($guzzle);
+    }
 }
--- a/src/Wallabag/CoreBundle/Resources/config/services.yml
+++ b/src/Wallabag/CoreBundle/Resources/config/services.yml
@ -42,7 +42,7 @@ services:
            -
                error_message: '%wallabag_core.fetching_error_message%'
                error_message_title: '%wallabag_core.fetching_error_message_title%'
-            - "@wallabag_core.guzzle.http_client"
+            - "@wallabag_core.http_client"
            - "@wallabag_core.graby.config_builder"
        calls:
            - [ setLogger, [ "@logger" ] ]
@ -55,9 +55,8 @@ services:
            - {}
            - "@logger"

-    wallabag_core.guzzle.http_client:
-        class: GuzzleHttp\ClientInterface
-        factory: ["@wallabag_core.guzzle.http_client_factory", buildHttpClient]
+    wallabag_core.http_client:
+        alias: 'httplug.client.wallabag_core'

    wallabag_core.guzzle_authenticator.config_builder:
        class: Wallabag\CoreBundle\GuzzleSiteAuthenticator\GrabySiteConfigBuilder
@ -73,7 +72,7 @@ services:
    bd_guzzle_site_authenticator.site_config_builder:
        alias: wallabag_core.guzzle_authenticator.config_builder

-    wallabag_core.guzzle.http_client_factory:
+    wallabag_core.http_client_factory:
        class: Wallabag\CoreBundle\Helper\HttpClientFactory
        arguments:
            - "@wallabag_core.guzzle.cookie_jar"
@ -212,7 +211,7 @@ services:
            - "@logger"

    wallabag_core.entry.download_images.client:
-        class: GuzzleHttp\Client
+        alias: 'httplug.client.wallabag_core.entry.download_images'

    wallabag_core.helper.crypto_proxy:
        class: Wallabag\CoreBundle\Helper\CryptoProxy
--- a/src/Wallabag/ImportBundle/Import/PocketImport.php
+++ b/src/Wallabag/ImportBundle/Import/PocketImport.php
@ -2,13 +2,22 @@

 namespace Wallabag\ImportBundle\Import;

-use GuzzleHttp\Client;
-use GuzzleHttp\Exception\RequestException;
+use Http\Client\Common\HttpMethodsClient;
+use Http\Client\Common\Plugin\ErrorPlugin;
+use Http\Client\Common\PluginClient;
+use Http\Client\HttpClient;
+use Http\Discovery\MessageFactoryDiscovery;
+use Http\Message\MessageFactory;
+use Http\Client\Exception\RequestException;
 use Wallabag\CoreBundle\Entity\Entry;
+use Psr\Http\Message\ResponseInterface;

 class PocketImport extends AbstractImport
 {
    const NB_ELEMENTS = 5000;
+    /**
+     * @var HttpMethodsClient
+     */
    private $client;
    private $accessToken;

@ -55,24 +64,18 @@ class PocketImport extends AbstractImport
     */
    public function getRequestToken($redirectUri)
    {
-        $request = $this->client->createRequest('POST', 'https://getpocket.com/v3/oauth/request',
-            [
-                'body' => json_encode([
-                    'consumer_key' => $this->user->getConfig()->getPocketConsumerKey(),
-                    'redirect_uri' => $redirectUri,
-                ]),
-            ]
-        );
-
        try {
-            $response = $this->client->send($request);
+            $response = $this->client->post('https://getpocket.com/v3/oauth/request', [], json_encode([
+                'consumer_key' => $this->user->getConfig()->getPocketConsumerKey(),
+                'redirect_uri' => $redirectUri,
+            ]));
        } catch (RequestException $e) {
            $this->logger->error(sprintf('PocketImport: Failed to request token: %s', $e->getMessage()), ['exception' => $e]);

            return false;
        }

-        return $response->json()['code'];
+        return $this->jsonDecode($response)['code'];
    }

    /**
@ -85,24 +88,19 @@ class PocketImport extends AbstractImport
     */
    public function authorize($code)
    {
-        $request = $this->client->createRequest('POST', 'https://getpocket.com/v3/oauth/authorize',
-            [
-                'body' => json_encode([
-                    'consumer_key' => $this->user->getConfig()->getPocketConsumerKey(),
-                    'code' => $code,
-                ]),
-            ]
-        );

        try {
-            $response = $this->client->send($request);
+            $response = $this->client->post('https://getpocket.com/v3/oauth/authorize', [], json_encode([
+                'consumer_key' => $this->user->getConfig()->getPocketConsumerKey(),
+                'code' => $code,
+            ]));
        } catch (RequestException $e) {
            $this->logger->error(sprintf('PocketImport: Failed to authorize client: %s', $e->getMessage()), ['exception' => $e]);

            return false;
        }

-        $this->accessToken = $response->json()['access_token'];
+        $this->accessToken = $this->jsonDecode($response)['access_token'];

        return true;
    }
@ -114,29 +112,23 @@ class PocketImport extends AbstractImport
    {
        static $run = 0;

-        $request = $this->client->createRequest('POST', 'https://getpocket.com/v3/get',
-            [
-                'body' => json_encode([
-                    'consumer_key' => $this->user->getConfig()->getPocketConsumerKey(),
-                    'access_token' => $this->accessToken,
-                    'detailType' => 'complete',
-                    'state' => 'all',
-                    'sort' => 'newest',
-                    'count' => self::NB_ELEMENTS,
-                    'offset' => $offset,
-                ]),
-            ]
-        );
-
        try {
-            $response = $this->client->send($request);
+            $response = $this->client->post('https://getpocket.com/v3/get', [], json_encode([
+                'consumer_key' => $this->user->getConfig()->getPocketConsumerKey(),
+                'access_token' => $this->accessToken,
+                'detailType' => 'complete',
+                'state' => 'all',
+                'sort' => 'newest',
+                'count' => self::NB_ELEMENTS,
+                'offset' => $offset,
+            ]));
        } catch (RequestException $e) {
            $this->logger->error(sprintf('PocketImport: Failed to import: %s', $e->getMessage()), ['exception' => $e]);

            return false;
        }

-        $entries = $response->json();
+        $entries = $this->jsonDecode($response);

        if ($this->producer) {
            $this->parseEntriesForProducer($entries['list']);
@ -159,13 +151,14 @@ class PocketImport extends AbstractImport
    }

    /**
-     * Set the Guzzle client.
+     * Set the Http client.
     *
-     * @param Client $client
+     * @param HttpClient $client
+     * @param MessageFactory|null $messageFactory
     */
-    public function setClient(Client $client)
+    public function setClient(HttpClient $client, MessageFactory $messageFactory = null)
    {
-        $this->client = $client;
+        $this->client = new HttpMethodsClient(new PluginClient($client, [new ErrorPlugin()]), $messageFactory ?: MessageFactoryDiscovery::find());
    }

    /**
@ -252,4 +245,15 @@ class PocketImport extends AbstractImport

        return $importedEntry;
    }
+
+    protected function jsonDecode(ResponseInterface $response)
+    {
+        $data = \json_decode((string) $response->getBody(), true);
+
+        if (JSON_ERROR_NONE !== json_last_error()) {
+            throw new \InvalidArgumentException('Unable to parse JSON data: ' . json_last_error_msg());
+        }
+
+        return $data;
+    }
 }
--- a/src/Wallabag/ImportBundle/Resources/config/services.yml
+++ b/src/Wallabag/ImportBundle/Resources/config/services.yml
@ -7,13 +7,7 @@ services:
        class: Wallabag\ImportBundle\Import\ImportChain

    wallabag_import.pocket.client:
-        class: GuzzleHttp\Client
-        arguments:
-            -
-                defaults:
-                    headers:
-                        content-type: "application/json"
-                        X-Accept: "application/json"
+        alias: 'httplug.client.wallabag_import.pocket.client'

    wallabag_import.pocket.import:
        class: Wallabag\ImportBundle\Import\PocketImport