Merge pull request #65 from clue-labs/remote-address

Return full remote address instead of only IP

Author: clue

README.md

@@ -309,17 +309,27 @@ For more details, see the
 
 #### getRemoteAddress()
 
-The `getRemoteAddress(): ?string` method returns the remote address
-(client IP) where this connection has been established from.
+The `getRemoteAddress(): ?string` method returns the full remote address
+(client IP and port) where this connection has been established from.
 
 ```php
-$ip = $connection->getRemoteAddress();
+$address = $connection->getRemoteAddress();
+echo 'Connection from ' . $address . PHP_EOL;
 ```
 
-It will return the remote address as a string value.
 If the remote address can not be determined or is unknown at this time (such as
 after the connection has been closed), it MAY return a `NULL` value instead.
 
+Otherwise, it will return the full remote address as a string value.
+If this is a TCP/IP based connection and you only want the remote IP, you may
+use something like this:
+
+```php
+$address = $connection->getRemoteAddress();
+$ip = trim(parse_url('tcp://' . $address, PHP_URL_HOST), '[]');
+echo 'Connection from ' . $ip . PHP_EOL;
+```
+
 ## Install
 
 The recommended way to install this library is [through Composer](http://getcomposer.org).

src/Connection.php

@@ -35,6 +35,13 @@ private function parseAddress($address)
             return null;
         }
 
-        return trim(substr($address, 0, strrpos($address, ':')), '[]');
+        // check if this is an IPv6 address which includes multiple colons but no square brackets
+        $pos = strrpos($address, ':');
+        if ($pos !== false && strpos($address, ':') < $pos && substr($address, 0, 1) !== '[') {
+            $port = substr($address, $pos + 1);
+            $address = '[' . substr($address, 0, $pos) . ']:' . $port;
+        }
+
+        return $address;
     }
 }

src/ConnectionInterface.php

@@ -27,9 +27,27 @@
 interface ConnectionInterface extends DuplexStreamInterface
 {
     /**
-     * Returns the remote address (client IP) where this connection has been established from
+     * Returns the remote address (client IP and port) where this connection has been established from
      *
-     * @return string|null remote address (client IP) or null if unknown
+     * ```php
+     * $address = $connection->getRemoteAddress();
+     * echo 'Connection from ' . $address . PHP_EOL;
+     * ```
+     *
+     * If the remote address can not be determined or is unknown at this time (such as
+     * after the connection has been closed), it MAY return a `NULL` value instead.
+     *
+     * Otherwise, it will return the full remote address as a string value.
+     * If this is a TCP/IP based connection and you only want the remote IP, you may
+     * use something like this:
+     *
+     * ```php
+     * $address = $connection->getRemoteAddress();
+     * $ip = trim(parse_url('tcp://' . $address, PHP_URL_HOST), '[]');
+     * echo 'Connection from ' . $ip . PHP_EOL;
+     * ```
+     *
+     * @return string|null remote address (client IP and port) or null if unknown
      */
     public function getRemoteAddress();
 }

tests/ConnectionTest.php

@@ -47,7 +47,7 @@ public function testEmitsConnectionWithRemoteIp()
 
         Block\sleep(0.1, $loop);
 
-        $this->assertEquals('127.0.0.1', $peer);
+        $this->assertContains('127.0.0.1:', $peer);
     }
 
     public function testEmitsConnectionWithRemoteIpAfterConnectionIsClosedByPeer()
@@ -72,7 +72,7 @@ public function testEmitsConnectionWithRemoteIpAfterConnectionIsClosedByPeer()
 
         Block\sleep(0.1, $loop);
 
-        $this->assertEquals('127.0.0.1', $peer);
+        $this->assertContains('127.0.0.1:', $peer);
     }
 
     public function testEmitsConnectionWithRemoteNullAddressAfterConnectionIsClosedLocally()
@@ -160,7 +160,7 @@ public function testEmitsConnectionWithRemoteIpv6()
 
         Block\sleep(0.1, $loop);
 
-        $this->assertEquals('::1', $peer);
+        $this->assertContains('[::1]:', $peer);
     }
 
     public function testAppliesContextOptionsToSocketStreamResource()