Merge pull request #18 from xp-framework/fix/octal-and-hex-ipv4

Fix IPv4 addresses using octal and hexadecimal notation

Author: thekid

src/main/php/peer/net/Inet4Address.class.php

@@ -1,5 +1,7 @@
 <?php namespace peer\net;
 
+use lang\FormatException;
+
 /**
  * IPv4 address
  *
@@ -9,30 +11,47 @@
 class Inet4Address implements InetAddress {
 
   /**
-   * Convert IPv4 address from dotted form into a long
+   * Convert IPv4 address from dotted form into a long. Supports hexadecimal and
+   * octal notations. Yes, 0177.0.0.1 and 0x7F.0.0.1 are both equivalent with
+   * 127.0.0.1 - localhost!
    *
-   * @param   string ip
-   * @return  int
+   * @param  string $ip
+   * @return int
+   * @throws lang.FormatException
    */
   protected static function ip2long($ip) {
     $i= 0; $addr= 0; $count= 0;
     foreach (explode('.', $ip) as $byte) {
-      if (++$count > 4)
-        throw new \lang\FormatException('Given IP string has more than 4 blocks: ['.$ip.']');
+      if (++$count > 4) {
+        throw new FormatException('Given IP string has more than 4 blocks: ['.$ip.']');
+      }
+
+      $l= strlen($byte);
+      $n= -1;
+      if ($l > 1 && '0' === $byte[0]) {
+        if (('x' === $byte[1] || 'X' === $byte[1]) && $l === strspn($byte, '0123456789aAbBcCdDeEfF', 2) + 2) {
+          $n= hexdec($byte);
+        } else if ($l === strspn($byte, '0123456789')) {
+          $n= octdec($byte);
+        }
+      } else if ($l > 0 && $l === strspn($byte, '0123456789')) {
+        $n= (int)$byte;
+      }
 
-      if (!is_numeric($byte) || $byte < 0 || $byte > 255)
-        throw new \lang\FormatException('Invalid format of ip address: ['.$ip.']');
+      if ($n < 0 || $n > 255) {
+        throw new FormatException('Invalid format of IP address: ['.$ip.']'); 
+      }
 
-      $addr|= ($byte << (8 * (3 - $i++)));
+      $addr|= ($n << (8 * (3 - $i++)));
     }
     return $addr;
   }
 
   /**
    * Constructor
    *
-   * @param   string address
-   * @throws  lang.FormatException in case address is illegal
+   * @param  string $address
+   * @throws lang.FormatException in case address is illegal
    */
   public function __construct($address) {
     $this->addr= self::ip2long($address);
@@ -71,7 +90,7 @@ public function asString() {
    * @return  bool
    */
   public function isLoopback() {
-    return $this->addr >> 8 == 0x7F0000;
+    return $this->addr >> 8 === 0x7F0000;
   }
 
   /**
@@ -86,18 +105,18 @@ public function inSubnet(Network $net) {
 
     $addrn= $net->getAddress()->addr;
     $mask= $net->getNetmask();
-    return $this->addr >> (32 - $mask) == $addrn >> (32 - $mask);
+    return $this->addr >> (32 - $mask) === $addrn >> (32 - $mask);
   }
 
   /**
    * Create a subnet of this address, with the specified size.
    *
    * @param   int subnetSize
-   * @return  Network
+   * @return  peer.net.Network
    * @throws  lang.IllegalArgumentException in case the subnetSize is not correct
    */
   public function createSubnet($subnetSize) {
-    $addr= $this->addr & (0xFFFFFFFF << (32-$subnetSize));
+    $addr= $this->addr & (0xFFFFFFFF << (32 - $subnetSize));
     return new Network(new Inet4Address(long2ip($addr)), $subnetSize);
   }
 

src/test/php/peer/unittest/net/Inet4AddressTest.class.php

@@ -2,20 +2,30 @@
 
 use lang\FormatException;
 use peer\net\{Inet4Address, Network};
-use unittest\{Expect, Test};
+use unittest\{Expect, Test, Values, TestCase};
 
-class Inet4AddressTest extends \unittest\TestCase {
+class Inet4AddressTest extends TestCase {
 
-  #[Test]
-  public function createAddress() {
-    $this->assertEquals('127.0.0.1', (new Inet4Address('127.0.0.1'))->asString());
+  /** @return iterable */
+  private function localhost() {
+    return [['127.0.0.1'], ['0177.0000.000.01'], ['0177.0.0.1'], ['0x7F.0.0.1'], ['0x7f.0.0.1'], ['0X7F.0.0.1']];
+  }
+
+  #[Test, Values('localhost')]
+  public function createAddress($addr) {
+    $this->assertEquals('127.0.0.1', (new Inet4Address($addr))->asString());
   }
 
   #[Test, Expect(FormatException::class)]
   public function createInvalidAddressRaisesException() {
     new Inet4Address('Who am I');
   }
 
+  #[Test, Expect(FormatException::class)]
+  public function emptySegmentRaisesException() {
+    new Inet4Address('127.0..1');
+  }
+
   #[Test, Expect(FormatException::class)]
   public function createInvalidAddressThatLooksLikeAddressRaisesException() {
     new Inet4Address('10.0.0.355');
@@ -26,9 +36,19 @@ public function createInvalidAddressWithTooManyBlocksRaisesException() {
     new Inet4Address('10.0.0.255.5');
   }
 
-  #[Test]
-  public function loopbackAddress() {
-    $this->assertTrue((new Inet4Address('127.0.0.1'))->isLoopback());
+  #[Test, Expect(FormatException::class)]
+  public function invalidHexRaisesException() {
+    new Inet4Address('0xZZ.0.0.1');
+  }
+
+  #[Test, Expect(FormatException::class)]
+  public function invalidOctalRaisesException() {
+    new Inet4Address('0ABC.0.0.1');
+  }
+
+  #[Test, Values('localhost')]
+  public function loopbackAddress($addr) {
+    $this->assertTrue((new Inet4Address($addr))->isLoopback());
   }
 
   #[Test]