Merge pull request #62 from QPhuGit/fix-idn-domain

Handle IDN Cloudflare zones without PHP intl by resolving zone ID from hostname

Author: mrikirill

cloudflare.php

@@ -131,6 +131,14 @@ public function getZones()
         return $this->call("GET", "client/v4/zones?per_page=" . self::ZONES_PER_PAGE . "&status=active");
     }
 
+    public function getZoneByName($zoneName)
+{
+    return $this->call(
+        "GET",
+        "client/v4/zones?name=" . rawurlencode($zoneName) . "&status=active"
+    );
+}
+
     /**
      * @link https://developers.cloudflare.com/api/operations/dns-records-for-a-zone-list-dns-records
      * @throws Exception
@@ -341,44 +349,66 @@ function updateDnsRecords()
     private function matchHostnameWithZone($hostnameList = [])
     {
         try {
-            $zoneList = $this->cloudflareAPI->getZones();
-            $zoneList = $zoneList['result'];
-            foreach ($zoneList as $zone) {
-                $zoneId = $zone['id'];
-                $zoneName = $zone['name'];
-                foreach ($hostnameList as $hostname) {
-                    // Check if the hostname ends with the zone name
-                    if ($hostname === $zoneName || substr($hostname, -strlen('.' . $zoneName)) === '.' . $zoneName) {
-                        // Add an IPv4 DNS record for each hostname that matches a zone
-                        $this->dnsRecordList[] = new DnsRecordEntity(
-                            '',
-                            'A',
-                            $hostname,
-                            $this->ipv4,
-                            $zoneId,
-                            '',
-                            ''
-                        );
-                        if (isset($this->ipv6)) {
-                            // Add an IPv6 DNS record if an IPv6 address is available
-                            $this->dnsRecordList[] = new DnsRecordEntity(
-                                '',
-                                'AAAA',
-                                $hostname,
-                                $this->ipv6,
-                                $zoneId,
-                                '',
-                                ''
-                            );
-                        }
-                    }
+            foreach ($hostnameList as $hostname) {
+                $zoneId = $this->findZoneIdByHostname($hostname);
+
+                if (!$zoneId) {
+                    continue;
                 }
+
+                $this->dnsRecordList[] = new DnsRecordEntity(
+                    '',
+                    'A',
+                    $hostname,
+                    $this->ipv4,
+                    $zoneId,
+                    '',
+                    ''
+                );
+
+                if (isset($this->ipv6)) {
+                    $this->dnsRecordList[] = new DnsRecordEntity(
+                        '',
+                        'AAAA',
+                        $hostname,
+                        $this->ipv6,
+                        $zoneId,
+                        '',
+                        ''
+                    );
+                }
+            }
+
+            if (empty($this->dnsRecordList)) {
+                $this->exitWithSynologyMsg(SynologyOutput::NO_HOSTNAME);
             }
         } catch (Exception $e) {
             $this->exitWithSynologyMsg(SynologyOutput::NO_HOSTNAME);
         }
     }
 
+    /**
+     * Summary of findZoneIdByHostname
+     * @param mixed $hostname
+     */
+    private function findZoneIdByHostname($hostname)
+    {
+        $hostname = strtolower(rtrim(trim($hostname), '.'));
+        $labels = explode('.', $hostname);
+        $count = count($labels);
+
+        for ($i = 0; $i <= $count - 2; $i++) {
+            $candidateZone = implode('.', array_slice($labels, $i));
+            $zone = $this->cloudflareAPI->getZoneByName($candidateZone);
+
+            if (!empty($zone['result']) && !empty($zone['result'][0]['id'])) {
+                return $zone['result'][0]['id'];
+            }
+        }
+
+        return null;
+    }
+
     /**
      * Extracts valid hostnames from a given string of hostnames separated by pipes (|).
      *

tests/SynologyCloudflareDDNSAgentTest.php

@@ -15,11 +15,12 @@ protected function exitWithSynologyMsg($msg = '')
         $this->exitMsg = $msg;
         throw new ExitException("Exit called with message: $msg");
     }
-    
+
     public function callPrivateMethod($methodName, $args = [])
     {
         $reflection = new ReflectionClass($this);
         $method = $reflection->getMethod($methodName);
+        $method->setAccessible(true);
         return $method->invokeArgs($this, $args);
     }
 }
@@ -30,13 +31,27 @@ public function testIsValidHostname()
     {
         $mockApi = $this->createMock(CloudflareAPI::class);
         $mockIpify = $this->createMock(Ipify::class);
-        
+
         $mockApi->method('verifyToken')->willReturn(['success' => true]);
-        
-        $mockApi->method('getZones')->willReturn(['result' => []]);
+
+        $mockApi->method('getZoneByName')
+            ->willReturnCallback(function ($zoneName) {
+                if ($zoneName === 'example.com') {
+                    return [
+                        'result' => [
+                            [
+                                'id' => 'test-zone-id',
+                                'name' => 'example.com',
+                            ]
+                        ]
+                    ];
+                }
+
+                return ['result' => []];
+            });
 
         $agent = new TestableSynologyCloudflareDDNSAgent('apikey', 'example.com', '1.2.3.4', $mockApi, $mockIpify);
-        
+
         $this->assertTrue($agent->callPrivateMethod('isValidHostname', ['example.com']));
         $this->assertTrue($agent->callPrivateMethod('isValidHostname', ['sub.example.com']));
         $this->assertFalse($agent->callPrivateMethod('isValidHostname', ['-example.com']));
@@ -47,27 +62,43 @@ public function testExtractHostnames()
     {
         $mockApi = $this->createMock(CloudflareAPI::class);
         $mockIpify = $this->createMock(Ipify::class);
+
         $mockApi->method('verifyToken')->willReturn(['success' => true]);
-        $mockApi->method('getZones')->willReturn(['result' => []]);
+
+        $mockApi->method('getZoneByName')
+            ->willReturnCallback(function ($zoneName) {
+                if ($zoneName === 'example.com') {
+                    return [
+                        'result' => [
+                            [
+                                'id' => 'test-zone-id',
+                                'name' => 'example.com',
+                            ]
+                        ]
+                    ];
+                }
+
+                return ['result' => []];
+            });
 
         $agent = new TestableSynologyCloudflareDDNSAgent('apikey', 'example.com', '1.2.3.4', $mockApi, $mockIpify);
 
         $input = "example.com|sub.example.com|invalid-";
         $expected = ['example.com', 'sub.example.com'];
-        
+
         $this->assertEquals($expected, $agent->callPrivateMethod('extractHostnames', [$input]));
     }
-    
+
     public function testConstructorAuthFailure()
     {
         $mockApi = $this->createMock(CloudflareAPI::class);
         $mockIpify = $this->createMock(Ipify::class);
-        
+
         $mockApi->method('verifyToken')->willReturn(['success' => false]);
 
         $this->expectException(ExitException::class);
         $this->expectExceptionMessage("Exit called with message: " . SynologyOutput::AUTH_FAILED);
 
         new TestableSynologyCloudflareDDNSAgent('apikey', 'example.com', '1.2.3.4', $mockApi, $mockIpify);
     }
-}
+}