Merge pull request #9882 from nanaya/separate-ip-lookup

Separate ipv4 and ipv6 lookup

.gitignore

···
 /storage/htmlpurifier/
 /storage/paypal_auth.cache
 
-/database/ip2asn.idx
-/database/ip2asn.tsv
+/database/ip2asn/*.idx
+/database/ip2asn/*.tsv

app/Libraries/Ip.php

···
+<?php
+
+// Copyright (c) ppy Pty Ltd <[e-mail]>. Licensed under the GNU Affero General Public License v3.0.
+// See the LICENCE file in the repository root for full licence text.
+
+declare(strict_types=1);
+
+namespace App\Libraries;
+
+enum Ip: string
+{
+    case V4 = 'v4';
+    case V6 = 'v6';
+}

app/Libraries/Ip2Asn.php

···
 namespace App\Libraries;
 
 use Exception;
+use WeakMap;
 
 class Ip2Asn
 {
-    private $dbFh;
-    private string $index;
-    private int $count;
+    private WeakMap $count;
+    private WeakMap $dbFh;
+    private WeakMap $index;
 
     public function __construct()
     {
-        $this->dbFh = fopen(Ip2AsnUpdater::getDbPath(), 'r');
-        $index = file_get_contents(Ip2AsnUpdater::getIndexPath());
-        if ($this->dbFh === false || $index === false) {
-            throw new Exception('failed opening ip2asn database or index');
+        $this->count = new WeakMap();
+        $this->dbFh = new WeakMap();
+        $this->index = new WeakMap();
+
+        foreach (Ip::cases() as $version) {
+            $this->dbFh[$version] = fopen(Ip2AsnUpdater::getDbPath($version), 'r');
+            $index = file_get_contents(Ip2AsnUpdater::getIndexPath($version));
+            if ($this->dbFh[$version] === false || $index === false) {
+                throw new Exception("failed opening ip2asn {$version} database or index");
+            }
+            $this->index[$version] = $index;
+
+            // 4 bytes per entry (int32)
+            $this->count[$version] = strlen($this->index[$version]) / 4;
+        }
+    }
+
+    public function lookup(string $ip): string
+    {
+        switch (true) {
+            case filter_var($ip, FILTER_VALIDATE_IP, FILTER_FLAG_IPV4) !== false:
+                return $this->lookupByVersion(Ip::V4, $ip);
+            case filter_var($ip, FILTER_VALIDATE_IP, FILTER_FLAG_IPV6) !== false:
+                return $this->lookupByVersion(Ip::V6, $ip);
         }
-        $this->index = $index;
 
-        // 4 bytes per entry (int32)
-        $this->count = strlen($this->index) / 4;
+        return '0';
     }
 
-    public function lookup(string $ip): string
+    private function lookupByVersion(Ip $version, string $ip): string
     {
+        $dbFh = $this->dbFh[$version];
+        $index = $this->index[$version];
         $start = 0;
-        $end = $this->count - 1;
-        $search = inet_pton($this->prefixIPv4($ip));
-
-        if ($search === false) {
-            return '0';
-        }
+        $end = $this->count[$version] - 1;
+        $search = inet_pton($ip);
 
         while ($start <= $end) {
             $current = (int) (($start + $end) / 2);
-            $loc = unpack('l', substr($this->index, $current * 4, 4))[1];
-            fseek($this->dbFh, $loc);
-            $row = fgets($this->dbFh);
+            $loc = unpack('l', substr($index, $current * 4, 4))[1];
+            fseek($dbFh, $loc);
+            $row = fgets($dbFh);
             $data = explode("\t", $row, 4);
-            $compare = inet_pton($this->prefixIPv4($data[1]));
+            $compare = inet_pton($data[1]);
             $asn = $data[2];
             if ($compare === $search) {
                 return $asn;
···
         }
 
         return $lastInnerSearchAsn ?? $asn;
-    }
-
-    /**
-     * Prefix IPv4 so it's sortable as IPv6
-     */
-    private function prefixIPv4(string $ip): string
-    {
-        return strpos($ip, ':') === false
-            ? "::{$ip}"
-            : $ip;
     }
 }

app/Libraries/Ip2AsnUpdater.php

···
 
 class Ip2AsnUpdater
 {
-    public static function getDbPath()
+    public static function getDbPath(Ip $version): string
     {
-        return database_path('ip2asn.tsv');
+        return database_path("ip2asn/{$version->value}.tsv");
     }
 
-    public static function getIndexPath()
+    public static function getIndexPath(Ip $version): string
     {
-        return database_path('ip2asn.idx');
+        return database_path("ip2asn/{$version->value}.idx");
     }
 
     public function run(?callable $logger = null): void
     {
-        $logger ??= function (string $message) {
-            Log::info("ip2asn: {$message}");
-        };
+        foreach (Ip::cases() as $version) {
+            $prefixedLogger = function (string $message) use ($logger, $version): void {
+                $prefixedMessage = "[{$version->value}] $message";
+
+                if (isset($logger)) {
+                    $logger($prefixedMessage);
+                } else {
+                    Log::info("ip2asn: {$prefixedMessage}");
+                }
+            };
 
+            $this->update($version, $prefixedLogger);
+        }
+    }
+
+    private function update(Ip $version, callable $logger): void
+    {
         $logger('Checking db for updates');
 
-        $dbPath = static::getDbPath();
-        $indexPath = static::getIndexPath();
+        $dbPath = static::getDbPath($version);
+        $indexPath = static::getIndexPath($version);
 
         $dbExists = file_exists($dbPath);
 
···
 
         if ($newDb) {
             $logger('Db file is outdated. Downloading');
-            $tsv = gzdecode(file_get_contents('https://iptoasn.com/data/ip2asn-combined.tsv.gz'));
+            $tsv = gzdecode(file_get_contents("https://iptoasn.com/data/ip2asn-{$version->value}.tsv.gz"));
         } else {
             $tsv = file_get_contents($dbPath);
         }

docker/development/prepare.sh

···
     cp .docker/.my.cnf.example .docker/.my.cnf
 fi
 
-if [ ! -f database/ip2asn.tsv ]; then
+if [ ! -f database/ip2asn/v6.tsv ]; then
     _run artisan ip2asn:update
 fi