Added validation of configuration file

horstoeko · Sep 30, 2024 · 394d1e5 · 394d1e5
1 parent 4d4c540
commit 394d1e5
Show file tree

Hide file tree

Showing 4 changed files with 181 additions and 8 deletions.
diff --git a/.gitignore b/.gitignore
@@ -82,4 +82,5 @@ _backup*
 /composer.lock
 
 /examples/Example1.php
-!/src/bin
+/examples/config.json
+!/src/bin
diff --git a/composer.json b/composer.json
@@ -31,6 +31,7 @@
         "php": "^7.3|^7.4|^8",
         "horstoeko/zugferd": "^1",
         "horstoeko/zugferdublbridge": "^1",
+        "swaggest/json-schema": "^0.12.42",
         "symfony/console": "^5|^6|^7",
         "webklex/php-imap": "^4|^5"
     },

diff --git a/src/config/ZugferdMailConfig.php b/src/config/ZugferdMailConfig.php
@@ -9,9 +9,12 @@
 
 namespace horstoeko\zugferdmail\config;
 
-use stdClass;
-use RuntimeException;
 use InvalidArgumentException;
+use ReflectionException;
+use RuntimeException;
+use stdClass;
+use Swaggest\JsonSchema\Schema;
+use Throwable;
 use Webklex\PHPIMAP\ClientManager;
 
 /**
@@ -221,11 +224,13 @@ public function makeClientManager(): ClientManager
     }
 
     /**
-     * Loads a configuration from a file.
-     * The file must exist.
+     * Loads a configuration from a file. The file must exist.
      *
-     * @param  string $filename
+     * @param string $filename
      * @return ZugferdMailConfig
+     * @throws InvalidArgumentException
+     * @throws RuntimeException
+     * @throws ReflectionException
      */
     public static function loadFromFile(string $filename): ZugferdMailConfig
     {
@@ -236,11 +241,19 @@ public static function loadFromFile(string $filename): ZugferdMailConfig
         $jsonString = file_get_contents($filename);
 
         if ($jsonString === false) {
-            throw new RuntimeException(sprintf("Cannot read the file %s.", $filename));
+            throw new RuntimeException(sprintf("Cannot read the configuration file %s.", $filename));
         }
 
         $jsonObject = json_decode($jsonString);
 
+        if (is_null($jsonObject)) {
+            throw new RuntimeException(sprintf("The file %s does not seem to be a valid json.", $filename));
+        }
+
+        if (!static::validateConfig($jsonObject)) {
+            throw new RuntimeException(sprintf("The file %s does not seem to be a valid json.", $filename));
+        }
+
         $config = new ZugferdMailConfig;
         $config->setDateFormat($jsonObject->dateFormat);
         $config->setUblSupportEnabled($jsonObject->ublSupportEnabled);
@@ -274,8 +287,9 @@ public static function loadFromFile(string $filename): ZugferdMailConfig
     /**
      * Save the configuration to a file
      *
-     * @param  string $filename
+     * @param string $filename
      * @return ZugferdMailConfig
+     * @throws RuntimeException
      */
     public function saveToFile(string $filename): ZugferdMailConfig
     {
@@ -327,10 +341,39 @@ public function saveToFile(string $filename): ZugferdMailConfig
             $jsonObject->accounts[] = $jsonAccountObject;
         }
 
+        if (!static::validateConfig($jsonObject)) {
+            throw new RuntimeException(sprintf("The content of file %s is not valid.", $filename));
+        }
+
         if (file_put_contents($filename, json_encode($jsonObject, JSON_PRETTY_PRINT)) === false) {
             throw new RuntimeException(sprintf("Cannot save to file %s.", $filename));
         }
 
         return $this;
     }
+
+    /**
+     * Validates a config file
+     *
+     * @param object $jsonObject
+     * @return bool
+     */
+    protected static function validateConfig($jsonObject): bool
+    {
+        $result = true;
+
+        $schemaJson = file_get_contents(dirname(__FILE__) . "/schema.json");
+
+        try {
+            Schema::import(
+                json_decode($schemaJson),
+            )->in(
+                $jsonObject,
+            );
+        } catch (Throwable $e) {
+            $result = false;
+        }
+
+        return $result;
+    }
 }
diff --git a/src/config/schema.json b/src/config/schema.json
@@ -0,0 +1,128 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "type": "object",
+    "required": [
+        "dateFormat",
+        "ublSupportEnabled",
+        "accounts"
+    ],
+    "properties": {
+        "dateFormat": {
+            "type": "string"
+        },
+        "ublSupportEnabled": {
+            "type": "boolean"
+        },
+        "accounts": {
+            "type": "array",
+            "items": {
+                "type": "object",
+                "properties": {
+                    "identifier": {
+                        "type": "string"
+                    },
+                    "host": {
+                        "type": "string"
+                    },
+                    "port": {
+                        "type": "integer",
+                        "minimum": 0,
+                        "maximu,": 65535
+                    },
+                    "protocol": {
+                        "type": "string",
+                        "oneOf": [
+                            {
+                                "const": "imap"
+                            },
+                            {
+                                "const": "legacy-imap"
+                            },
+                            {
+                                "const": "pop3"
+                            },
+                            {
+                                "const": "nntp"
+                            }
+                        ]
+                    },
+                    "encryption": {
+                        "type": [
+                            "string",
+                            "boolean"
+                        ],
+                        "oneOf": [
+                            {
+                                "const": false
+                            },
+                            {
+                                "const": "ssl"
+                            },
+                            {
+                                "const": "tls"
+                            },
+                            {
+                                "const": "starttls"
+                            },
+                            {
+                                "const": "notls"
+                            }
+                        ]
+                    },
+                    "validateCert": {
+                        "type": "boolean"
+                    },
+                    "username": {
+                        "type": "string"
+                    },
+                    "password": {
+                        "type": "string"
+                    },
+                    "authentication": {
+                        "type": [
+                            "string",
+                            "null"
+                        ],
+                        "oneOf": [
+                            {
+                                "const": null
+                            },
+                            {
+                                "const": "oauth"
+                            }
+                        ]
+                    },
+                    "timeout": {
+                        "type": "integer"
+                    },
+                    "foldersToWatch": {
+                        "type": "array",
+                        "items": {
+                            "type": "string"
+                        }
+                    },
+                    "mimeTypesToWatch": {
+                        "type": "array",
+                        "items": {
+                            "type": "string"
+                        }
+                    },
+                    "handlers": {
+                        "type": "array",
+                        "items": {
+                            "type": "object",
+                            "properties": {
+                                "classname": {
+                                    "type": "string"
+                                },
+                                "properties": {
+                                    "type": "object"
+                                }
+                            }
+                        }
+                    }
+                }
+            }
+        }
+    }
+}