v1.2.1: Fix and new endpoint logs/export support

Author: Ente

README.md

@@ -127,6 +127,11 @@ DDNS(new API(__DIR__ . "/configurations", ".env-custom"), file_get_contents("/my
 
 ## Changes
 
+### v1.2.1: Fixed and logs/export support
+
+- Added support for `logs/export` allowing you to export a DNS application log file
+- Fixed incorrect endpoint URL for some "Log" endpoints
+
 ### 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`.

composer.json

@@ -2,7 +2,7 @@
     "name": "ente/technitium-dnsserver-php-api",
     "type": "library",
     "license": "GPL-3.0-only",
-    "version": "1.2",
+    "version": "1.2.1",
     "description": "API client to interact with the Technitium DNS Server",
     "authors": [
         {

src/API.dnsserver.ente.php

@@ -107,7 +107,7 @@ public function loader(): void{
         require_once __DIR__ . "/helper/Log.Helper.API.dnsserver.ente.php";
     }
 
-    public function downloadFile($endpoint, $bypass, $data): string {
+    public function downloadFile($endpoint, $bypass, $data, $csv = false): string {
         $c = curl_init();
         $endpoint = $this->prepareEndpoint($endpoint, $bypass);
         $method = "POST";
@@ -141,6 +141,10 @@ public function downloadFile($endpoint, $bypass, $data): string {
             } else {
                 $fileName = bin2hex(random_bytes(16)) . ".txt";
             }
+
+            if($csv){
+                $fileName = $fileName . ".csv";
+            }
 
             $path = __DIR__ . "/helper/data/downloads/" . $fileName;
             if (file_put_contents($path, $body) === false) {

src/endpoints/admin/Logs.admin.php

@@ -40,7 +40,7 @@ public function list(): array|bool{
      * @return array Returns the result array or `false` if the group was not found.
      */
     public function query($data): array{
-        return $this->API->sendCall($data, "admin/logs/query");
+        return $this->API->sendCall($data, "logs/query");
     }
 
     /**
@@ -64,7 +64,7 @@ public function download(string $fileName, int $limit = 0): string|bool{
      * @return bool Returns `true` if the file was deleted or `false` if the file was not found.
      */
     public function delete(string $log): bool{
-        $response = $this->API->sendCall(["log" => $log], "admin/logs/delete");
+        $response = $this->API->sendCall(["log" => $log], "logs/delete");
         return $response["status"] == "ok";
     }
 
@@ -73,7 +73,27 @@ public function delete(string $log): bool{
      * @return bool Returns `true` if the files were deleted or `false` if the files were not found.
      */
     public function deleteAll(): bool{
-        $response = $this->API->sendCall([], "admin/logs/deleteAll");
+        $response = $this->API->sendCall([], "logs/deleteAll");
         return $response["status"] == "ok";
     }
+
+    public function exportAppLog($data): string|bool{
+        $response = $this->API->downloadFile("logs/export", 0, [
+            "classPath" => $data["classPath"],
+            "start" => $data["start"],
+            "end" => $data["end"],
+            "clientIpAddress" => $data["clientIpAddress"],
+            "protocol" => $data["protocol"],
+            "responseType" => $data["responseType"],
+            "rcode" => $data["rcode"],
+            "qname" => $data["qname"],
+            "qtype" => $data["qtype"],
+            "qclass" => $data["qclass"]
+        ]);
+        if(!empty($response)){
+            return $response;
+        } else {
+            return false;
+        }
+    }
 }

src/helper/endpoints.json

@@ -140,5 +140,6 @@
     "logs/download",
     "logs/delete",
     "logs/deleteAll",
-    "logs/query"
+    "logs/query",
+    "logs/export"
 ]