v1.2: Adding support to export functions

Author: bryan-ente

README.md

@@ -29,6 +29,8 @@ Then: `require_once "/path/to/vendor/autoload.php";` & `use Technitium\DNSServer
 - `USE_POST`: Specify if you want to access the API via POST (`true`) instead of GET (`false`) in default.
 - `USE_HTTPS`: Enable (`true`) HTTPS for the API connection. If your server does not support HTTPS, the API will simply return `false` to all requests.
 
+When using `$api->admin()->logs()->export("2024-12-24")` you may need to adjust the `memory_limit` in your `php.ini` file or via `ini_set()`.
+
 ## General Usage
 
 ```php
@@ -125,6 +127,13 @@ DDNS(new API(__DIR__ . "/configurations", ".env-custom"), file_get_contents("/my
 
 ## Changes
 
+### v1.2: Adding support for export functions
+
+- Added support for export functions within API classes. When using export functions note that downloading log files may take quite a while. You may also need to adjust the `memory_limit`.
+
+<!-- Added function to support downloading files -->
+<!-- Fixed incorrect endpoint URL for "Log" endpoints -->
+
 ### v1.1.4: Type safety
 
 - Added type safety to the `DDNS.Helper.API.dnsserver.ente.php` class

src/API.dnsserver.ente.php

@@ -107,6 +107,55 @@ public function loader(): void{
         require_once __DIR__ . "/helper/Log.Helper.API.dnsserver.ente.php";
     }
 
+    public function downloadFile($endpoint, $bypass, $data): string {
+        $c = curl_init();
+        $endpoint = $this->prepareEndpoint($endpoint, $bypass);
+        $method = "POST";
+
+        curl_setopt($c, CURLOPT_URL, $endpoint . $this->appendAuth($method));
+        curl_setopt($c, CURLOPT_RETURNTRANSFER, true);
+        curl_setopt($c, CURLOPT_HEADER, true);
+    
+        if ($method === "POST") {
+            curl_setopt($c, CURLOPT_POST, true);
+            curl_setopt($c, CURLOPT_POSTFIELDS, $data);
+        }
+    
+        $response = curl_exec($c);
+    
+        if ($response === false) {
+            $error = curl_error($c);
+            curl_close($c);
+            throw new \Exception("cURL error: $error");
+        }
+    
+        $headerSize = curl_getinfo($c, CURLINFO_HEADER_SIZE);
+        $headers = substr($response, 0, $headerSize);
+        $body = substr($response, $headerSize);
+    
+        curl_close($c);
+    
+        if (strpos($headers, 'Content-Disposition: attachment') !== false) {
+            if (preg_match('/filename="(.+?)"/', $headers, $matches)) {
+                $fileName = $matches[1];
+            } else {
+                $fileName = bin2hex(random_bytes(16)) . ".txt";
+            }
+    
+            $path = __DIR__ . "/helper/data/downloads/" . $fileName;
+            if (file_put_contents($path, $body) === false) {
+                throw new \Exception("Failed to save the downloaded file.");
+            }
+            Log::error_rep("Downloaded file: " . $path . " from endpoint: " . $endpoint);
+            return $path;
+        } else {
+            Log::error_rep("Unexpected response format: " . $body);
+            throw new \Exception("API did not return a downloadable file.");
+        }
+    }
+    
+    
+
     /**
      * `sendCall()` - Send a request to the Technitium API.
      * @param array $data The data to send to the API

src/endpoints/admin/Logs.admin.php

@@ -47,12 +47,12 @@ public function query($data): array{
      * `download()` - Downloads a log file.
      * @param string $fileName The name of the file to download.
      * @param int $limit The number of mb to limit the download to.
-     * @return array|bool Returns the result array or `false` if the group was not found.
+     * @return string|bool Returns the file path or `false` if the file was not found.
      */
-    public function download(string $fileName, int $limit = 0): array|bool{
-        $response = $this->API->sendCall(["fileName" => $fileName, "limit" => $limit], "admin/logs/download");
-        if($response["status"] == "ok"){
-            return $response["response"];
+    public function download(string $fileName, int $limit = 0): string|bool{
+        $response = $this->API->downloadFile("logs/download", 0, ["fileName" => $fileName, "limit" => $limit]);
+        if(!empty($response)){
+            return $response;
         } else {
             return false;
         }

src/endpoints/allowed/Allowed.php

@@ -64,7 +64,17 @@ public function import(array $zones): bool{
 
     }
 
-    public function export(){
-        return $this->API->sendCall([], "allowed/export");
+    /**
+     * `export()` - Exports all allowed zones.
+     * @return string|bool Either the file path where the allowed zones were exported to or `false` if the export failed.
+     */
+    public function export(): string|bool{
+        $result = $this->API->downloadFile("allowed/export", false, []);
+        
+        if(!empty($result)){
+            return $result;
+        } else {
+            return false;
+        }
     }
 }

src/endpoints/blocked/Blocked.php

@@ -44,9 +44,18 @@ public function delete(string $domain): bool{
 
     }
 
-    
-    public function export($data){
-        return $this->sendCall($data, "blocked/export");
+    /**
+     * `export()` - Exports all blocked zones.
+     * @return string|bool Either the file path where the blocked zones were exported to or `false` if the export failed.
+     */
+    public function export(): string|bool{
+        $result = $this->API->downloadFile("blocked/export", false, []);
+
+        if(!empty($result)){
+            return $result;
+        } else {
+            return false;
+        }
     }
 
     /**

src/endpoints/zones/Zones.php

@@ -124,8 +124,19 @@ public function enable(string $zone){
         return $response["status"] == "ok";
     }
 
-    public function export($data){
-        return $this->sendCall($data, "zones/export");
+    /**
+     * `export()` - Export a zone.
+     * @param string $zone The name of the zone to export.
+     * @return srring|bool Returns the file path of the exported zone or `false` otherwise.
+     */
+    public function export(string $zone): string|bool{
+        $result = $this->API->downloadFile("zones/export", false, ["zone" => $zone]);
+
+        if(!empty($result)){
+            return $result;
+        } else {
+            return false;
+        }
     }
 
     /**

src/helper/data/downloads/.gitkeep

@@ -136,9 +136,9 @@
     "admin/permissions/get",
     "admin/permissions/set",
 
-    "admin/logs/list",
-    "admin/logs/download",
-    "admin/logs/delete",
-    "admin/logs/deleteAll",
-    "admin/logs/query"
+    "logs/list",
+    "logs/download",
+    "logs/delete",
+    "logs/deleteAll",
+    "logs/query"
 ]