Merge pull request #55 from Soullivaneuh/img-blacklist

Images URLs blacklist

Author: oscarotero

README.md

@@ -74,6 +74,7 @@ The available options for the adapters are:
 
 * minImageWidth (int): Minimal image width used to choose the main image
 * minImageHeight (int): Minimal image height used to choose the main image
+* imagesBlacklist (array): Images that you don't want to be used. Could be plain text or [Url](https://github.com/oscarotero/Embed/blob/master/src/Url.php) match pattern.
 * getBiggerImage (bool): Choose the bigger image as the main image (instead the first found, that usually is the most relevant).
 * getBiggerIcon (bool): The same than getBiggerImage but used to choose the main icon
 * facebookKey (string): Used only in Facebook adapter, to get info from facebook pages when these pages are not public and a access token is required
@@ -87,6 +88,7 @@ $config = [
 		'config' => [
 			'minImageWidth' => 16,
             'minImageHeight' => 16,
+            'imagesBlacklist' => null,
             'getBiggerImage' => false,
             'getBiggerIcon' => false,
             'facebookKey' => null,
@@ -191,6 +193,11 @@ $config = [
 		'config' => [
 			'minImageWidth' => 16,
             'minImageHeight' => 16,
+            'imagesBlacklist' => [
+                'http://example.com/full/path/to/image.jpg',
+                'http?://test.*/*.png/',
+                '*/bad_image.gif'
+            ]
 		]
 	],
     'providers' => [

src/Adapters/Adapter.php

@@ -1,6 +1,7 @@
 <?php
 namespace Embed\Adapters;
 
+use Embed\Url;
 use Embed\Utils;
 use Embed\Request;
 use Embed\Providers\ProviderInterface;
@@ -43,6 +44,7 @@ abstract class Adapter
     protected $config = [
         'minImageWidth' => 16,
         'minImageHeight' => 16,
+        'imagesBlacklist' => null,
         'getBiggerImage' => false,
         'getBiggerIcon' => false,
         'facebookKey' => null,
@@ -302,7 +304,29 @@ public function getProviderUrl()
      */
     public function getImagesUrls()
     {
-        return Utils::getData($this->providers, 'imagesUrls', $this->request->url);
+        $imagesUrls = Utils::getData($this->providers, 'imagesUrls', $this->request->url);
+
+        $blacklist = $this->config['imagesBlacklist'];
+        $hasBlacklist = is_array($blacklist) && count($blacklist) > 0;
+
+        $imagesUrls = array_filter($imagesUrls, function($imageUrl) use ($blacklist, $hasBlacklist) {
+            // Clean empty urls
+            if (empty($imageUrl['value'])) {
+                return false;
+            }
+
+            // Remove image url if on blacklist
+            if ($hasBlacklist) {
+                $url = new Url($imageUrl['value']);
+
+                return !$url->match($blacklist) && !in_array($imageUrl['value'], $blacklist, true);
+            }
+
+            return true;
+        });
+
+        // Use array_values to reset keys after filter
+        return array_values($imagesUrls);
     }
 
     /**

tests/ImagesBlacklistTest.php

@@ -0,0 +1,63 @@
+<?php
+class ImagesBlacklistTest extends PHPUnit_Framework_TestCase
+{
+    public function testPlainText()
+    {
+        $info = Embed\Embed::create('http://www.lopinion.fr/24-mars-2015/cartes-chance-sont-epuisees-22609', [
+            'adapter'       => [
+                'config'        => [
+                    'imagesBlacklist' => [
+                        'http://www.lopinion.fr/sites/nb.com/files/2015/01/logo-o-default_0.png?p',
+                    ],
+                ]
+            ],
+            'providers'     => [
+                'html'          => [
+                    'maxImages' => 0
+                ]
+            ]
+        ]);
+
+        $this->assertNull($info->image);
+    }
+
+    public function testPlainUrlMatch()
+    {
+        $info = Embed\Embed::create('http://www.lopinion.fr/24-mars-2015/cartes-chance-sont-epuisees-22609', [
+            'adapter'       => [
+                'config'        => [
+                    'imagesBlacklist' => [
+                        '*/logo-o-default_0.png*',
+                    ],
+                ]
+            ],
+            'providers'     => [
+                'html'          => [
+                    'maxImages' => 0
+                ]
+            ]
+        ]);
+
+        $this->assertNull($info->image);
+    }
+
+    public function testAuthorizedImage()
+    {
+        $info = Embed\Embed::create('http://www.lopinion.fr/24-mars-2015/jeunes-restent-angle-mort-politiques-publiques-22607', [
+            'adapter'       => [
+                'config'        => [
+                    'imagesBlacklist' => [
+                        '*/logo-o-default_0.png*',
+                    ],
+                ]
+            ],
+            'providers'     => [
+                'html'          => [
+                    'maxImages' => 0
+                ]
+            ]
+        ]);
+
+        $this->assertNotNull($info->image);
+    }
+}