Initial commit

Author: clue

.gitignore

@@ -0,0 +1,2 @@
+/vendor
+/composer.lock

.travis.yml

@@ -0,0 +1,9 @@
+language: php
+php:
+  - 5.3
+  - 5.6
+  - hhvm
+install:
+  - composer install --prefer-source --no-interaction
+script:
+  - phpunit --coverage-text

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Christian Lück
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is furnished
+to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

README.md

@@ -0,0 +1,49 @@
+# clue/mdns-react [![Build Status](https://travis-ci.org/clue/php-mdns-react.svg?branch=master)](https://travis-ci.org/clue/php-mdns-react)
+
+Simple, async multicast DNS (mDNS) resolver library, built on top of [React PHP](http://reactphp.org/).
+
+[Multicast DNS](http://www.multicastdns.org/) name resolution is commonly used
+as part of [zeroconf networking](http://en.wikipedia.org/wiki/Zero-configuration_networking)
+ala Bonjour/Avahi.
+It is defined in [RFC 6762](http://tools.ietf.org/html/rfc6762), in particular
+this specification also highlights the
+[differences to normal DNS operation](http://tools.ietf.org/html/rfc6762#section-19). 
+
+The mDNS protocol is related to, but independent of, DNS-Based Service Discovery (DNS-SD)
+as defined in [RFC 6763](http://tools.ietf.org/html/rfc6763).
+
+> Note: This project is in early alpha stage! Feel free to report any issues you encounter.
+
+## Quickstart example
+
+Once [installed](#install), you can use the following code to look up the address of a local domain name:
+
+```php
+$loop = React\EventLoop\Factory::create();
+$factory = new Factory($loop);
+$resolver = $factory->createResolver();
+
+$resolver->lookup('hostname.local')->then(function ($ip) {
+   echo 'Found: ' . $ip . PHP_EOL;
+});
+
+$loop->run();
+```
+
+See also the [examples](examples).
+
+## Install
+
+The recommended way to install this library is [through composer](http://getcomposer.org). [New to composer?](http://getcomposer.org/doc/00-intro.md)
+
+```JSON
+{
+    "require": {
+        "clue/mdns-react": "dev-master"
+    }
+}
+```
+
+## License
+
+MIT

composer.json

@@ -0,0 +1,23 @@
+{
+    "name": "clue/mdns-react",
+    "description": "Multicast DNS (mDNS) resolver for zeroconf networking ala Bonjour/Avahi",
+    "keywords": ["Multicast DNS", "mDNS", "RFC 6762", "zeroconf", "Bonjour", "Avahi", "ReactPHP", "async"],
+    "homepage": "https://github.com/clue/php-mdns-react",
+    "license": "MIT",
+    "authors": [
+        {
+            "name": "Christian Lück",
+            "email": "[email protected]"
+        }
+    ],
+    "autoload": {
+        "psr-4": { "Clue\\React\\Mdns\\": "src/" }
+    },
+    "require": {
+        "php": ">=5.3",
+        "clue/multicast-react": "~0.2.0",
+        "react/event-loop": "~0.3.0|~0.4.0",
+        "react/dns": "~0.3.0|~0.4.0",
+        "react/promise": "~1.0|~2.0"
+    }
+}

examples/lookup.php

@@ -0,0 +1,17 @@
+<?php
+
+require __DIR__ . '/../vendor/autoload.php';
+
+$name = isset($argv[1]) ? $argv[1] : 'me.local';
+
+$loop = React\EventLoop\Factory::create();
+$factory = new Clue\React\Mdns\Factory($loop);
+$mdns = $factory->createResolver();
+
+$mdns->resolve($name)->then('e', 'e');
+
+function e($v) {
+    echo $v . PHP_EOL;
+}
+
+$loop->run();

phpunit.xml.dist

@@ -0,0 +1,19 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<phpunit bootstrap="tests/bootstrap.php"
+         colors="true"
+         convertErrorsToExceptions="true"
+         convertNoticesToExceptions="true"
+         convertWarningsToExceptions="true"
+>
+    <testsuites>
+        <testsuite name="mDNS React Test Suite">
+            <directory>./tests/</directory>
+        </testsuite>
+    </testsuites>
+    <filter>
+        <whitelist>
+            <directory>./src/</directory>
+        </whitelist>
+    </filter>
+</phpunit>

src/Factory.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace Clue\React\Mdns;
+
+use React\EventLoop\LoopInterface;
+use React\Dns\Query\ExecutorInterface;
+use React\Dns\Resolver\Resolver;
+
+class Factory
+{
+    const DNS = '224.0.0.251:5353';
+
+    private $loop;
+    private $executor;
+
+    public function __construct(LoopInterface $loop, ExecutorInterface $executor = null)
+    {
+        if ($executor === null) {
+            $executor = new MulticastExecutor($loop);
+        }
+
+        $this->loop = $loop;
+        $this->executor = $executor;
+    }
+
+    public function createResolver()
+    {
+        return new Resolver(self::DNS, $this->executor);
+    }
+}

src/MulticastExecutor.php

@@ -0,0 +1,115 @@
+<?php
+
+namespace Clue\React\Mdns;
+
+use React\Dns\BadServerException;
+use React\Dns\Model\Message;
+use React\Dns\Protocol\Parser;
+use React\Dns\Protocol\BinaryDumper;
+use React\EventLoop\LoopInterface;
+use React\Promise\Deferred;
+use Clue\React\Multicast\Factory as DatagramFactory;
+use React\Dns\Query\ExecutorInterface;
+use React\Dns\Query\Query;
+use React\Dns\Query\TimeoutException;
+
+/**
+ * DNS executor that uses multicast sockets
+ *
+ * Based on React\Dns\Query\Executor which should eventually be split into
+ * multiple smaller components..
+ */
+class MulticastExecutor implements ExecutorInterface
+{
+    private $loop;
+    private $parser;
+    private $dumper;
+    private $timeout;
+    private $factory;
+
+    public function __construct(LoopInterface $loop, Parser $parser = null, BinaryDumper $dumper = null, $timeout = 5, DatagramFactory $factory = null)
+    {
+        if ($parser === null) {
+            $parser = new Parser();
+        }
+        if ($dumper === null) {
+            $dumper = new BinaryDumper();
+        }
+        if ($factory === null) {
+            $factory = new DatagramFactory($loop);
+        }
+
+        $this->loop = $loop;
+        $this->parser = $parser;
+        $this->dumper = $dumper;
+        $this->timeout = $timeout;
+        $this->factory = $factory;
+    }
+
+    public function query($nameserver, Query $query)
+    {
+        $request = $this->prepareRequest($query);
+
+        $queryData = $this->dumper->toBinary($request);
+
+        return $this->doQuery($nameserver, $queryData, $query->name);
+    }
+
+    public function prepareRequest(Query $query)
+    {
+        $request = new Message();
+        $request->header->set('id', $this->generateId());
+        $request->header->set('rd', 1);
+        $request->questions[] = (array) $query;
+        $request->prepare();
+
+        return $request;
+    }
+
+    public function doQuery($nameserver, $queryData, $name)
+    {
+        $that = $this;
+        $parser = $this->parser;
+        $loop = $this->loop;
+
+        $deferred = new Deferred();
+
+        $timer = $this->loop->addTimer($this->timeout, function () use (&$conn, $name, $deferred) {
+            $conn->close();
+            $deferred->reject(new TimeoutException(sprintf("DNS query for %s timed out", $name)));
+        });
+
+        $conn = $this->factory->createSender();
+
+        $conn->on('message', function ($data) use ($conn, $parser, $deferred, $timer) {
+            $response = new Message();
+            $responseReady = $parser->parseChunk($data, $response);
+
+            $conn->close();
+            $timer->cancel();
+
+            if (!$responseReady) {
+                $deferred->reject(new BadServerException('Invalid response received'));
+
+                return;
+            }
+
+            if ($response->header->isTruncated()) {
+                $deferred->reject(new BadServerException('The server set the truncated bit although we issued a TCP request'));
+
+                return;
+            }
+
+            $deferred->resolve($response);
+        });
+
+        $conn->send($queryData, $nameserver);
+
+        return $deferred->promise();
+    }
+
+    protected function generateId()
+    {
+        return mt_rand(0, 0xffff);
+    }
+}

tests/FactoryTest.php

@@ -0,0 +1,16 @@
+<?php
+
+use Clue\React\Mdns\Factory;
+
+class FactoryTest extends TestCase
+{
+    public function testCreateResolver()
+    {
+        $loop = $this->getMock('React\EventLoop\LoopInterface');
+        $factory = new Factory($loop);
+
+        $resolver = $factory->createResolver();
+
+        $this->assertInstanceOf('React\Dns\Resolver\Resolver', $resolver);
+    }
+}