Message filtering support

README.md

@@ -40,6 +40,10 @@ return array(
 
             'shortenTimeout' => 15 // If after this amount of seconds no url shortener has come up with a short URL the normal URL will be used. (Not in effect when there are no shorteners listening.)
 
+            // or
+
+            'filter' => null // Any valid filter implementing Phergie\Irc\Plugin\React\EventFilter\FilterInterface to filter which messages should be handled 
+
         )),
 
     )

composer.json

@@ -11,7 +11,8 @@
     "phergie/phergie-irc-bot-react": "~1.0",
     "nojimage/twitter-text-php": "1.1.1",
     "phergie/phergie-irc-plugin-http": "^3.0.0-alpha1",
-    "react/promise": "~1.0|~2.0"
+    "react/promise": "~1.0|~2.0",
+    "phergie/phergie-irc-plugin-react-eventfilter": "^1.0||^2.0"
   },
   "require-dev": {
     "phergie/phergie-irc-bot-react-development": "^1.0.2|^1.1"

src/Plugin.php

@@ -16,6 +16,7 @@
 use Phergie\Irc\Bot\React\EventQueue;
 use Phergie\Irc\Client\React\LoopAwareInterface;
 use Phergie\Irc\Event\UserEvent;
+use Phergie\Irc\Plugin\React\EventFilter\FilterInterface;
 use React\Promise\Deferred;
 use Phergie\Plugin\Http\Request;
 
@@ -27,7 +28,8 @@
  */
 class Plugin extends AbstractPlugin implements LoopAwareInterface
 {
-    const URL_HANDLER_INTERFACE = 'Phergie\Irc\Plugin\React\Url\UrlHandlerInterface';
+    const URL_HANDLER_INTERFACE  = 'Phergie\Irc\Plugin\React\Url\UrlHandlerInterface';
+    const EVENT_FILTER_INTERFACE = 'Phergie\Irc\Plugin\React\EventFilter\FilterInterface';
 
     /**
      * @var UrlHandlerInterface
@@ -42,6 +44,11 @@ class Plugin extends AbstractPlugin implements LoopAwareInterface
      */
     protected $hostUrlEmitsOnly = false;
 
+    /**
+     * @var FilterInterface
+     */
+    protected $filter = null;
+
     /**
      * @var LoopInterface
      */
@@ -73,6 +80,12 @@ public function __construct(array $config = [])
         if (isset($config['hostUrlEmitsOnly'])) {
             $this->hostUrlEmitsOnly = boolval($config['hostUrlEmitsOnly']);
         }
+        if (
+            isset($config['filter']) &&
+            in_array(static::EVENT_FILTER_INTERFACE, class_implements($config['filter']))
+        ) {
+            $this->filter = $config['filter'];
+        }
     }
 
     /**
@@ -113,6 +126,12 @@ public function logDebug($message)
 
     public function handleIrcReceived(UserEvent $event, EventQueue $queue)
     {
+        if (
+            $this->filter !== null &&
+            $this->filter->filter($event) !== false
+        ) {
+            return;
+        }
         $params = $event->getParams();
         $extractor = new \Twitter_Extractor($params['text']);
         $urls = $extractor->extractURLs();

tests/PluginTest.php

@@ -12,6 +12,7 @@
 
 use GuzzleHttp\Message\Response;
 use Phake;
+use Phergie\Irc\Plugin\React\EventFilter\NotFilter;
 use Phergie\Irc\Plugin\React\Url\Plugin;
 use React\Promise\FulfilledPromise;
 
@@ -351,4 +352,38 @@ public function testHandleUrlRequest() {
             ))
         );
     }
+
+    public function testFiltered()
+    {
+        $event = Phake::mock('Phergie\Irc\Event\UserEvent');
+        Phake::when($event)->getParams()->thenReturn([
+            'text' => '',
+        ]);
+        $queue = Phake::mock('Phergie\Irc\Bot\React\EventQueue');
+        $filter = Phake::mock('Phergie\Irc\Plugin\React\EventFilter\FilterInterface');
+        Phake::when($filter)->filter($this->isInstanceOf('Phergie\Irc\Event\EventInterface'))->thenReturn(false);
+
+        (new Plugin([
+            'filter' => new NotFilter($filter),
+        ]))->handleIrcReceived($event, $queue);
+
+        Phake::verify($event, Phake::never())->getParams();
+    }
+
+    public function testNotFiltered()
+    {
+        $event = Phake::mock('Phergie\Irc\Event\UserEvent');
+        Phake::when($event)->getParams()->thenReturn([
+            'text' => '',
+        ]);
+        $queue = Phake::mock('Phergie\Irc\Bot\React\EventQueue');
+        $filter = Phake::mock('Phergie\Irc\Plugin\React\EventFilter\FilterInterface');
+        Phake::when($filter)->filter($this->isInstanceOf('Phergie\Irc\Event\EventInterface'))->thenReturn(true);
+
+        (new Plugin([
+            'filter' => new NotFilter($filter),
+        ]))->handleIrcReceived($event, $queue);
+
+        Phake::verify($event)->getParams();
+    }
 }