Merge pull request #14 from phergie/feature-11

Message filtering support

Author: WyriHaximus

.dunitconfig

@@ -1,8 +1,8 @@
 // the list of docker images to run against
 images="
-    vectorface/php5.4
     vectorface/php5.5
     vectorface/php5.6
+    vectorface/php-nightly
     vectorface/hhvm";
 
 

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 
+
         )),
 
     )
@@ -87,6 +91,19 @@ Selection of response headers from: [en.wikipedia.org/wiki/List_of_HTTP_header_f
 * `%header-server%`
 * `%header-x-powered-by%`
 
+## UrlSectionFilter
+
+This plugin comes with the `UrlSectionFilter` that lets you filter on the different key value pairs coming out of [`parse_url`](http://php.net/parse_url). The following example filter allows `www.phergie.org`, `www2.phergie.org`, and `phergie.org`:
+
+```php
+new OrFilter([
+    new UrlSectionFilter('host', '*.phergie.org'),
+    new UrlSectionFilter('host', 'phergie.org'),
+])
+```
+
+The filter comes with a third `strict` parameter where instead of declaring out of scope on missing an URL part it return `false`.
+
 ## Tests
 
 To run the unit test suite:

composer.json

@@ -16,8 +16,9 @@
     "php": "^5.5|^7.0",
     "phergie/phergie-irc-bot-react": "~2",
     "nojimage/twitter-text-php": "1.1.1",
-    "phergie/phergie-irc-plugin-http": "^4",
-    "react/promise": "~1.0|~2.0"
+    "phergie/phergie-irc-plugin-http": "^4.0",
+    "react/promise": "~1.0|~2.0",
+    "phergie/phergie-irc-plugin-react-eventfilter": "^1.0||^2.0"
   },
   "require-dev": {
     "phake/phake": "dev-VerifierResultConstraint-issue",

composer.lock

@@ -0,0 +1,85 @@
+<?php
+
+namespace Phergie\Irc\Plugin\React\Url\Filter;
+
+use Phergie\Irc\ConnectionInterface;
+use Phergie\Irc\Event\EventInterface;
+
+class UrlEvent implements EventInterface
+{
+    /**
+     * @var string
+     */
+    protected $url;
+
+    /**
+     * @var array|mixed|false
+     */
+    protected $parsedUrl;
+
+    /**
+     * @var EventInterface
+     */
+    protected $event;
+
+    /**
+     * UrlEvent constructor.
+     * @param string $url
+     * @param EventInterface $event
+     */
+    public function __construct($url, EventInterface $event)
+    {
+        $this->url = $url;
+        $this->parsedUrl = parse_url($url);
+        $this->event = $event;
+    }
+    
+    public function setMessage($message)
+    {
+        return $this->event->setMessage($message);
+    }
+
+    public function getMessage()
+    {
+        return $this->event->getMessage();
+    }
+
+    public function setConnection(ConnectionInterface $connection)
+    {
+        return $this->event->setConnection($connection);
+    }
+
+    public function getConnection()
+    {
+        return $this->event->getConnection();
+    }
+
+    public function setParams(array $params)
+    {
+        return $this->event->setParams($params);
+    }
+
+    public function getParams()
+    {
+        return $this->event->getParams();
+    }
+
+    public function setCommand($command)
+    {
+        return $this->event->setCommand($command);
+    }
+
+    public function getCommand()
+    {
+        return $this->event->getCommand();
+    }
+
+    public function getUrlSection($section)
+    {
+        if (isset($this->parsedUrl[$section])) {
+            return $this->parsedUrl[$section];
+        }
+
+        return null;
+    }
+}

src/Filter/UrlEvent.php

@@ -0,0 +1,61 @@
+<?php
+
+namespace Phergie\Irc\Plugin\React\Url\Filter;
+
+use Phergie\Irc\Event\EventInterface;
+use Phergie\Irc\Plugin\React\EventFilter\FilterInterface;
+
+class UrlSectionFilter implements FilterInterface
+{
+    /**
+     * @var string
+     */
+    protected $value;
+
+    /**
+     * @var string
+     */
+    protected $section;
+
+    /**
+     * @var null|false
+     */
+    protected $strictResponse = null;
+
+    /**
+     *
+     * @param string $section
+     * @param string $value
+     */
+    public function __construct($section, $value, $strict = false)
+    {
+        $this->section = $section;
+        $this->value = $value;
+        if ($strict === true) {
+            $this->strictResponse = false;
+        }
+    }
+
+    /**
+     * @param EventInterface $event
+     * @return bool|null
+     */
+    public function filter(EventInterface $event)
+    {
+        if (!($event instanceof UrlEvent)) {
+            return null;
+        }
+
+        $section = $event->getUrlSection($this->section);
+        if ($section === null) {
+            return $this->strictResponse;
+        }
+
+        $pattern = '/^' . str_replace('*', '.*', $this->value) . '$/';
+        if (preg_match($pattern, $section)) {
+            return true;
+        }
+
+        return false;
+    }
+}