Merge pull request #101 from clue-labs/socket

clue · web-flow · commit 04ed77d360be · 2021-08-05T13:33:30.000+02:00
Simplify usage by supporting new Socket API without nullable loop
diff --git a/README.md b/README.md
@@ -105,7 +105,7 @@ proxy server listening for connections on `localhost:1080`:
 $server = new Clue\React\Socks\Server();
 
 // listen on localhost:1080
-$socket = new React\Socket\Server('127.0.0.1:1080');
+$socket = new React\Socket\SocketServer('127.0.0.1:1080');
 $server->listen($socket);
 ```
 
@@ -134,7 +134,7 @@ proxy servers etc.), you can explicitly pass a custom instance of the
 [`ConnectorInterface`](https://github.com/reactphp/socket#connectorinterface):
 
 ```php
-$connector = new React\Socket\Connector(null, array(
+$connector = new React\Socket\Connector(array(
     'dns' => '127.0.0.1',
     'tcp' => array(
         'bindto' => '192.168.10.1:0'
@@ -192,7 +192,7 @@ in ReactPHP's [`Connector`](https://github.com/reactphp/socket#connector):
 ```php
 $proxy = new Clue\React\Socks\Client('127.0.0.1:1080');
 
-$connector = new React\Socket\Connector(null, array(
+$connector = new React\Socket\Connector(array(
     'tcp' => $proxy,
     'dns' => false
 ));
@@ -234,7 +234,7 @@ ReactPHP's [`Connector`](https://github.com/reactphp/socket#connector):
 ```php
 $proxy = new Clue\React\Socks\Client('127.0.0.1:1080');
 
-$connector = new React\Socket\Connector(null, array(
+$connector = new React\Socket\Connector(array(
     'tcp' => $proxy,
     'dns' => false
 ));
@@ -264,7 +264,7 @@ You can optionally pass additional
 to the constructor like this:
 
 ```php
-$connector = new React\Socket\Connector(null, array(
+$connector = new React\Socket\Connector(array(
     'tcp' => $proxy,
     'tls' => array(
         'verify_peer' => false,
@@ -286,12 +286,12 @@ This allows you to send both plain HTTP and TLS-encrypted HTTPS requests like th
 ```php
 $proxy = new Clue\React\Socks\Client('127.0.0.1:1080');
 
-$connector = new React\Socket\Connector(null, array(
+$connector = new React\Socket\Connector(array(
     'tcp' => $proxy,
     'dns' => false
 ));
 
-$browser = new React\Http\Browser(null, $connector);
+$browser = new React\Http\Browser($connector);
 
 $browser->get('https://example.com/')->then(function (Psr\Http\Message\ResponseInterface $response) {
     var_dump($response->getHeaders(), (string) $response->getBody());
@@ -422,7 +422,7 @@ other examples explicitly disable DNS resolution like this:
 ```php
 $proxy = new Clue\React\Socks\Client('127.0.0.1:1080');
 
-$connector = new React\Socket\Connector(null, array(
+$connector = new React\Socket\Connector(array(
     'tcp' => $proxy,
     'dns' => false
 ));
@@ -435,7 +435,7 @@ using SOCKS4), you can use the following code:
 $proxy = new Clue\React\Socks\Client('127.0.0.1:1080');
 
 // set up Connector which uses Google's public DNS (8.8.8.8)
-$connector = new React\Socket\Connector(null, array(
+$connector = new React\Socket\Connector(array(
     'tcp' => $proxy,
     'dns' => '8.8.8.8'
 ));
@@ -527,7 +527,7 @@ SOCKS connector from another SOCKS client like this:
 $middle = new Clue\React\Socks\Client('127.0.0.1:1080');
 $target = new Clue\React\Socks\Client('example.com:1080', $middle);
 
-$connector = new React\Socket\Connector(null, array(
+$connector = new React\Socket\Connector(array(
     'tcp' => $target,
     'dns' => false
 ));
@@ -573,7 +573,7 @@ underlying connection attempt if it takes too long:
 ```php
 $proxy = new Clue\React\Socks\Client('127.0.0.1:1080');
 
-$connector = new React\Socket\Connector(null, array(
+$connector = new React\Socket\Connector(array(
     'tcp' => $proxy,
     'dns' => false,
     'timeout' => 3.0
@@ -692,8 +692,8 @@ You can start listening on an underlying TCP/IP socket server like this:
 ```php
 $server = new Clue\React\Socks\Server();
 
-// listen on localhost:$port
-$socket = new React\Socket\Server($port);
+// listen on localhost:1080
+$socket = new React\Socket\SocketServer('127.0.0.1:1080');
 $server->listen($socket);
 ```
 
@@ -718,7 +718,7 @@ proxy servers etc.), you can explicitly pass a custom instance of the
 [`ConnectorInterface`](https://github.com/reactphp/socket#connectorinterface):
 
 ```php
-$connector = new React\Socket\Connector(null, array(
+$connector = new React\Socket\Connector(array(
     'dns' => '127.0.0.1',
     'tcp' => array(
         'bindto' => '192.168.10.1:0'
@@ -835,7 +835,7 @@ $proxy = new Clue\React\Socks\Client('user:pass@example.com:1080');
 $server = new Clue\React\Socks\Server(null, $proxy);
 
 // listen on localhost:1080
-$socket = new React\Socket\Server('127.0.0.1:1080');
+$socket = new React\Socket\SocketServer('127.0.0.1:1080');
 $server->listen($socket);
 ```
 
@@ -880,7 +880,7 @@ You can simply start your listening socket on the `tls://` URI scheme like this:
 $server = new Clue\React\Socks\Server();
 
 // listen on tls://127.0.0.1:1080 with the given server certificate
-$socket = new React\Socket\Server('tls://127.0.0.1:1080', null, array(
+$socket = new React\Socket\SocketServer('tls://127.0.0.1:1080', array(
     'tls' => array(
         'local_cert' => __DIR__ . '/localhost.pem',
     )
@@ -915,7 +915,7 @@ You can simply start your listening socket on the `unix://` URI scheme like this
 $server = new Clue\React\Socks\Server();
 
 // listen on /tmp/proxy.sock
-$socket = new React\Socket\Server('unix:///tmp/proxy.sock');
+$socket = new React\Socket\SocketServer('unix:///tmp/proxy.sock');
 $server->listen($socket);
 ```
 
diff --git a/composer.json b/composer.json
@@ -13,14 +13,14 @@
     "require": {
         "php": ">=5.3",
         "react/promise": "^2.1 || ^1.2",
-        "react/socket": "^1.8"
+        "react/socket": "^1.9"
     },
     "require-dev": {
         "clue/block-react": "^1.1",
         "clue/connection-manager-extra": "^1.0 || ^0.7",
         "phpunit/phpunit": "^9.3 || ^5.7 || ^4.8.35",
         "react/event-loop": "^1.2",
-        "react/http": "^1.4"
+        "react/http": "^1.5"
     },
     "autoload": {
         "psr-4": { "Clue\\React\\Socks\\": "src/" }
diff --git a/examples/01-https-request.php b/examples/01-https-request.php
@@ -23,13 +23,13 @@
 
 $proxy = new Clue\React\Socks\Client($url);
 
-$connector = new React\Socket\Connector(null, array(
+$connector = new React\Socket\Connector(array(
     'tcp' => $proxy,
     'timeout' => 3.0,
     'dns' => false
 ));
 
-$browser = new React\Http\Browser(null, $connector);
+$browser = new React\Http\Browser($connector);
 
 $browser->get('https://example.com/')->then(function (Psr\Http\Message\ResponseInterface $response) {
     var_dump($response->getHeaders(), (string) $response->getBody());
diff --git a/examples/02-optional-proxy-https-request.php b/examples/02-optional-proxy-https-request.php
@@ -20,14 +20,14 @@
 if ($url !== false) {
     $proxy = new Clue\React\Socks\Client($url);
 
-    $connector = new React\Socket\Connector(null, array(
+    $connector = new React\Socket\Connector(array(
         'tcp' => $proxy,
         'timeout' => 3.0,
         'dns' => false
     ));
 }
 
-$browser = new React\Http\Browser(null, $connector);
+$browser = new React\Http\Browser($connector);
 
 $browser->get('https://example.com/')->then(function (Psr\Http\Message\ResponseInterface $response) {
     var_dump($response->getHeaders(), (string) $response->getBody());
diff --git a/examples/11-proxy-raw-http-protocol.php b/examples/11-proxy-raw-http-protocol.php
@@ -26,7 +26,7 @@
 
 $proxy = new Clue\React\Socks\Client($url);
 
-$connector = new React\Socket\Connector(null, array(
+$connector = new React\Socket\Connector(array(
     'tcp' => $proxy,
     'timeout' => 3.0,
     'dns' => false
diff --git a/examples/12-optional-proxy-raw-http-protocol.php b/examples/12-optional-proxy-raw-http-protocol.php
@@ -26,7 +26,7 @@
 if ($url !== false) {
     $proxy = new Clue\React\Socks\Client($url);
 
-    $connector = new React\Socket\Connector(null, array(
+    $connector = new React\Socket\Connector(array(
         'tcp' => $proxy,
         'timeout' => 3.0,
         'dns' => false
diff --git a/examples/13-proxy-raw-https-protocol.php b/examples/13-proxy-raw-https-protocol.php
@@ -26,7 +26,7 @@
 
 $proxy = new Clue\React\Socks\Client($url);
 
-$connector = new React\Socket\Connector(null, array(
+$connector = new React\Socket\Connector(array(
     'tcp' => $proxy,
     'timeout' => 3.0,
     'dns' => false
diff --git a/examples/14-optional-proxy-raw-https-protocol.php b/examples/14-optional-proxy-raw-https-protocol.php
@@ -26,7 +26,7 @@
 if ($url !== false) {
     $proxy = new Clue\React\Socks\Client($url);
 
-    $connector = new React\Socket\Connector(null, array(
+    $connector = new React\Socket\Connector(array(
         'tcp' => $proxy,
         'timeout' => 3.0,
         'dns' => false
diff --git a/examples/15-proxy-chaining.php b/examples/15-proxy-chaining.php
@@ -30,7 +30,7 @@
 
 // please note how the client uses p3 (not p1!), which in turn then uses the complete chain
 // this creates a TCP/IP connection to p1, which then connects to p2, then to p3, which then connects to the target
-$connector = new React\Socket\Connector(null, array(
+$connector = new React\Socket\Connector(array(
     'tcp' => $connector,
     'timeout' => 3.0,
     'dns' => false
diff --git a/examples/16-local-dns.php b/examples/16-local-dns.php
@@ -16,7 +16,7 @@
 $proxy = new Clue\React\Socks\Client($url);
 
 // set up DNS server to use (Google's public DNS)
-$connector = new React\Socket\Connector(null, array(
+$connector = new React\Socket\Connector(array(
     'tcp' => $proxy,
     'timeout' => 3.0,
     'dns' => '8.8.8.8'
diff --git a/examples/21-server.php b/examples/21-server.php
@@ -11,7 +11,7 @@
 $server = new Clue\React\Socks\Server();
 
 // listen on 127.0.0.1:1080 or first argument
-$socket = new React\Socket\Server(isset($argv[1]) ? $argv[1] : '127.0.0.1:1080');
+$socket = new React\Socket\SocketServer(isset($argv[1]) ? $argv[1] : '127.0.0.1:1080');
 $server->listen($socket);
 
 echo 'SOCKS server listening on ' . $socket->getAddress() . PHP_EOL;
diff --git a/examples/22-server-with-password.php b/examples/22-server-with-password.php
@@ -21,7 +21,7 @@
 ));
 
 // listen on 127.0.0.1:1080 or first argument
-$socket = new React\Socket\Server(isset($argv[1]) ? $argv[1] : '127.0.0.1:1080');
+$socket = new React\Socket\SocketServer(isset($argv[1]) ? $argv[1] : '127.0.0.1:1080');
 $server->listen($socket);
 
 echo 'SOCKS5 server requiring authentication listening on ' . $socket->getAddress() . PHP_EOL;
diff --git a/examples/23-server-blacklist.php b/examples/23-server-blacklist.php
@@ -29,7 +29,7 @@
 $server = new Clue\React\Socks\Server(null, $connector);
 
 // listen on 127.0.0.1:1080 or first argument
-$socket = new React\Socket\Server(isset($argv[1]) ? $argv[1] : '127.0.0.1:1080');
+$socket = new React\Socket\SocketServer(isset($argv[1]) ? $argv[1] : '127.0.0.1:1080');
 $server->listen($socket);
 
 echo 'SOCKS server listening on ' . $socket->getAddress() . PHP_EOL;
diff --git a/examples/31-server-proxy-chaining.php b/examples/31-server-proxy-chaining.php
@@ -32,7 +32,7 @@
 $server = new Clue\React\Socks\Server(null, $connector);
 
 // listen on 127.0.0.1:1080 or first argument
-$socket = new React\Socket\Server($listen);
+$socket = new React\Socket\SocketServer($listen);
 $server->listen($socket);
 
 echo 'SOCKS server listening on ' . $socket->getAddress() . PHP_EOL;
diff --git a/examples/32-server-proxy-chaining-from-random-pool.php b/examples/32-server-proxy-chaining-from-random-pool.php
@@ -35,7 +35,7 @@
 $server = new Clue\React\Socks\Server(null, $connector);
 
 // listen on 127.0.0.1:1080 or first argument
-$socket = new React\Socket\Server($listen);
+$socket = new React\Socket\SocketServer($listen);
 $server->listen($socket);
 
 echo 'SOCKS server listening on ' . $socket->getAddress() . PHP_EOL;
diff --git a/examples/41-server-secure.php b/examples/41-server-secure.php
@@ -11,10 +11,12 @@
 $server = new Clue\React\Socks\Server();
 
 // listen on tls://127.0.0.1:1080 or first argument
-$listen = isset($argv[1]) ? $argv[1] : '127.0.0.1:1080';
-$socket = new React\Socket\Server('tls://' . $listen, null, array('tls' => array(
-    'local_cert' => __DIR__ . '/localhost.pem',
-)));
+$uri = 'tls://' . (isset($argv[1]) ? $argv[1] : '127.0.0.1:1080');
+$socket = new React\Socket\SocketServer($uri, array(
+    'tls' => array(
+        'local_cert' => __DIR__ . '/localhost.pem',
+    )
+));
 $server->listen($socket);
 
 echo 'SOCKS over TLS server listening on ' . str_replace('tls:', 'sockss:', $socket->getAddress()) . PHP_EOL;
diff --git a/examples/42-http-secure.php b/examples/42-http-secure.php
@@ -10,22 +10,24 @@
 
 require __DIR__ . '/../vendor/autoload.php';
 
-$url = isset($argv[1]) ? $argv[1] : '127.0.0.1:1080';
+$url = isset($argv[1]) ? $argv[1] : 'sockss://127.0.0.1:1080';
 
-$connector = new React\Socket\Connector(null, array('tls' => array(
-    'verify_peer' => false,
-    'verify_peer_name' => false
-)));
+$connector = new React\Socket\Connector(array(
+    'tls' => array(
+        'verify_peer' => false,
+        'verify_peer_name' => false
+    )
+));
 
 $proxy = new Clue\React\Socks\Client($url, $connector);
 
-$connector = new React\Socket\Connector(null, array(
+$connector = new React\Socket\Connector(array(
     'tcp' => $proxy,
     'timeout' => 3.0,
     'dns' => false
 ));
 
-echo 'Demo SOCKS over TLS client connecting to secure SOCKS server ' . $proxy . PHP_EOL;
+echo 'Demo SOCKS over TLS client connecting to secure SOCKS server ' . $url . PHP_EOL;
 
 $connector->connect('tcp://www.google.com:80')->then(function (React\Socket\ConnectionInterface $connection) {
     echo 'connected' . PHP_EOL;
diff --git a/src/Server.php b/src/Server.php
@@ -78,7 +78,7 @@ public function __construct(LoopInterface $loop = null, ConnectorInterface $conn
         }
 
         $this->loop = $loop ?: Loop::get();
-        $this->connector = $connector ?: new Connector($this->loop);
+        $this->connector = $connector ?: new Connector(array(), $this->loop);
     }
 
     /**
diff --git a/tests/ClientTest.php b/tests/ClientTest.php
@@ -3,14 +3,12 @@
 namespace Clue\Tests\React\Socks;
 
 use Clue\React\Socks\Client;
-use React\Promise\Promise;
 use Clue\React\Socks\Server;
 use React\Promise\Deferred;
+use React\Promise\Promise;
 
 class ClientTest extends TestCase
 {
-    private $loop;
-
     private $connector;
 
     /** @var  Client */
@@ -21,7 +19,6 @@ class ClientTest extends TestCase
      */
     public function setUpMocks()
     {
-        $this->loop = \React\EventLoop\Factory::create();
         $this->connector = $this->getMockBuilder('React\Socket\ConnectorInterface')->getMock();
         $this->client = new Client('127.0.0.1:1080', $this->connector);
     }
diff --git a/tests/FunctionalTest.php b/tests/FunctionalTest.php
diff --git a/tests/TestCase.php b/tests/TestCase.php
