json: Split parsing into Header/Body and use a parent-class for header.

* ADD cSemanticVersion class for advanced version-comparisons, used when reading files.
* FIX to honour schema's AllowAdditionalProperties by using json-lib's "strange"name for that property.
* Intorduce schema-validation within loading/creating.
* FIX forgotten closing of Exe-filebrowser on app-shutdown.

CSE/CSE.vbproj

@@ -105,6 +105,7 @@
   <ItemGroup>
     <Compile Include="Classes\cGenShp.vb" />
     <Compile Include="Classes\cMSC.vb" />
+    <Compile Include="Classes\cJsonFile.vb" />
     <Compile Include="Classes\CResult.vb" />
     <Compile Include="Classes\cPreferences.vb" />
     <Compile Include="Classes\csKey.vb" />
@@ -112,6 +113,7 @@
     <Compile Include="Classes\cValidSec.vb" />
     <Compile Include="Classes\cVehicle.vb" />
     <Compile Include="Classes\cVirtMSC.vb" />
+    <Compile Include="Classes\SemanticVersion.vb" />
     <Compile Include="Export\Minor_routines_output.vb" />
     <Compile Include="Export\output.vb" />
     <Compile Include="Export\OutputTest.vb" />

CSE/Classes/cJsonFile.vb

+Option Strict Off
+
+Imports Newtonsoft.Json.Linq
+Imports Newtonsoft.Json.Schema
+
+''' <summary>The parent-class for Head/Body json files</summary>
+''' <remarks>The /Header/Strict boolean controles whether to allow additional-properties in Body, 
+''' so it can be used to debug bad input-files by manually setting it to 'true' with a text-editor.
+''' </remarks>
+Public MustInherit Class cJsonFile
+
+    ''' <summary>The json-content for a json-file structured in Header/Body</summary>
+    Protected Shared Function JsonStr_FileContents(ByVal version As String, ByVal body As String) As String
+        Return <json>{
+            "Header": {
+                "FileVersion":  "<%= version %>",
+                "Strict":       false,
+            },
+            "Body": <%= body %>
+        }</json>.Value
+    End Function
+
+    ''' <summary>The schema for a json-file structured in Header/Body</summary>
+    Protected Shared Function JSchemaStr_File() As String
+        Return <json>{
+            "title": "vecto header/body json-file",
+            "type": "object", "additionalProperties": false, 
+            "properties": {
+                "Header": { 
+                    "type": "object", "additionalProperties": true, 
+                    "required": true,
+                    "properties": {
+                        "FileVersion": {
+                            "type": "string",
+                            "required": true,
+                        },
+                        "Strict": {
+                            "type": "boolean",
+                            "required": true,
+                            "default": false,
+                        }
+                    }
+                },
+                "Body": {}
+            }
+        }</json>.Value
+    End Function
+
+    ''' <summary>When a new file is created, it gets it /Header/FileVersion from this method</summary>
+    Protected MustOverride ReadOnly Property CodeVersion() As String
+
+    ''' <summary>When a instance_with_defauls is created, it gets its /Body from this method</summary>
+    Protected MustOverride ReadOnly Property CodeBodyStr() As String
+
+    ''' <summary>The schema used to validate the /Body</summary>
+    ''' <remarks>To signify validation-failure it can throw an exception or add err-messages into the supplied list</remarks>
+    Protected MustOverride Sub ValidateVersionAndBody(ByVal fileVersion As String, ByVal body As JObject, ByVal allowsAdditionalProps As Boolean, ByVal validateMsgs As IList(Of String))
+
+
+    Protected Json_Contents As JObject
+
+    ''' <summary>Reads from a file (aka "Load") or creates an instance with defaults
+    ''' 
+    ''' When reading, it optionally checks version and validates its body with ValidateVersionAndBody().
+    ''' When defaulting, the resulted file-version is retrieved from 'CodeVersion' prop and the body from 'BodyStr' prop.
+    ''' </summary>
+    ''' <param name="inputFilePath">If unspecifed, create instance_with_defaults, otherwise read json-contents from file</param>
+    ''' <param name="skipValidation">When false (the default), validates json-contents in both cases (reading or creating-defaults)</param>
+    ''' <remarks></remarks>
+    Protected Sub New(Optional ByVal inputFilePath As String = Nothing, Optional ByVal skipValidation As Boolean = False)
+        If (inputFilePath Is Nothing) Then
+            Dim jstr = JsonStr_FileContents(Me.CodeVersion, Me.CodeBodyStr)
+            Me.Json_Contents = JObject.Parse(jstr)
+        Else
+            Me.Json_Contents = ReadJsonFile(inputFilePath)
+        End If
+
+        If Not skipValidation Then
+            Me.Validate()
+        End If
+    End Sub
+
+    ''' <summary>Validates and Writing to the config file</summary>
+    Sub Store(ByVal fpath As String)
+        Validate(Me.Strict)
+        WriteJsonFile(fpath, Json_Contents)
+    End Sub
+
+
+    ''' <exception cref="SystemException">includes all validation errors</exception>
+    ''' <param name="isStrict">when True, no additional json-properties allowed in the data, when nothing, use value from Header</param>
+    Friend Sub Validate(Optional ByVal isStrict As Boolean? = Nothing)
+        Dim allowsAdditionalProps As Boolean = Not IIf(isStrict Is Nothing, Me.Strict, isStrict)
+        Dim fileSchema = JsonSchema.Parse(JSchemaStr_File())        ' TODO: Lazily create schemas once
+
+        Dim validateMsgs As IList(Of String) = New List(Of String)
+        ValidateJson(Me.Json_Contents, fileSchema, validateMsgs)
+        If (validateMsgs.Any()) Then
+            Throw New SystemException(format("Invalid File-format due to: {0}", String.Join(vbCrLf, validateMsgs)))
+        End If
+
+        Me.ValidateVersionAndBody(Me.FileVersion, Me.Body, allowsAdditionalProps, validateMsgs)
+
+        If (validateMsgs.Any()) Then
+            Throw New SystemException(format("Invalid Body-format due to: {0}", String.Join(vbCrLf, validateMsgs)))
+        End If
+    End Sub
+
+
+
+    Public Overrides Function Equals(ByVal obj As Object) As Boolean
+        If obj Is Nothing OrElse Not Me.GetType().Equals(obj.GetType()) Then
+            Return False
+        Else
+            Return Me.Json_Contents.Equals(DirectCast(obj, cJsonFile).Json_Contents)
+        End If
+    End Function
+
+
+#Region "json props"
+    Protected ReadOnly Property Header() As JObject
+        Get
+            Return Me.Json_Contents("Header")
+        End Get
+    End Property
+    Protected ReadOnly Property Body() As JObject
+        Get
+            Return Me.Json_Contents("Body")
+        End Get
+    End Property
+    Public ReadOnly Property FileVersion As String
+        Get
+            Return Me.Header("FileVersion")
+        End Get
+    End Property
+    Public ReadOnly Property Strict As Boolean
+        Get
+            Return Me.Header("Strict")
+        End Get
+    End Property
+#End Region ' "json props"
+
+End Class

CSE/Classes/cPreferences.vb

@@ -4,79 +4,61 @@ Imports Newtonsoft.Json.Linq
 Imports Newtonsoft.Json.Schema
 
 Public Class cPreferences
-    Public Json_Contents As JObject
+    Inherits cJsonFile
+
+    Protected Overrides ReadOnly Property CodeVersion() As String
+        Get
+            Return "1.0.0"
+        End Get
+    End Property
 
     ' Default-prefs specified here.
-    Function JsonStr_Contents() As String
-        Return <json>{
-            "Header": {
-                "FileVersion":  "1.0",
-                "Strict":       false,
-            },
-            "Body": {
+    Protected Overrides ReadOnly Property CodeBodyStr() As String
+        Get
+            Return <json>{
                 "WorkingDir":   null,
                 "WriteLog":     true,
                 "LogSize":      2,
                 "LogLevel":     5,
                 "Editor":       "notepad.exe",
-            }
         }</json>.Value
-    End Function
+        End Get
+    End Property
 
-    ''' <param name="allowsAdditionalProps">when false, more strict validation</param>
-    Function JSchemaStr(ByVal allowsAdditionalProps As Boolean) As String
-        Dim allowsAdditionalProps_str As String = IIf(allowsAdditionalProps, "false", "true")
+    ''' <param name="allowAdditionalProps">when false, more strict validation</param>
+    Protected Function JSchemaStr(ByVal allowAdditionalProps As Boolean) As String
+        Dim allowAdditionalProps_str As String = IIf(allowAdditionalProps, "true", "false")
         Return <json>{
-            "title": "Vecto_cse-prefs.ver1.0",
-            "type": "object", "AllowAdditionalProperties": <%= allowsAdditionalProps_str %>, 
+            "title": "cse-prefs.ver1.0",
+            "type": "object", "additionalProperties": <%= allowAdditionalProps_str %>, 
+            "required": true,
             "properties": {
-                "Header": { 
-                    "type": "object", "AllowAdditionalProperties": <%= allowsAdditionalProps_str %>, 
+                "WorkingDir": {
+                    "type": ["string", "null"], 
+                    "required": false,
+                    "default": null,
+                    "description": "Last used Working Directory Path for input/output files, when null/empty,  uses app's dir (default: null)",
+                }, 
+                "WriteLog": {
+                    "type": "boolean",
+                    "required": true,
+                    "description": "Whether to write messages to log file (default: true)",
+                }, 
+                "LogSize": {
+                    "type": "integer",
+                    "required": true,
+                    "description": "Allowed Log-file size limit [MiB] (default: 2)",
+                }, 
+                "LogLevel": {
+                    "type": "integer",
                     "required": true,
-                    "properties": {
-                        "FileVersion": {
-                            "type": "string",
-                            "required": true,
-                        },
-                        "Strict": {
-                            "type": "boolean",
-                            "required": true,
-                            "default": false,
-                        }
-                    }
-                },
-                "Body": {
-                    "type": "object", "AllowAdditionalProperties": <%= allowsAdditionalProps_str %>, 
+                    "description": "Message Output Level (default: 5 - 'info')",
+                }, 
+                "Editor": {
+                    "type": "string",
                     "required": true,
-                    "properties": {
-                        "WorkingDir": {
-                            "type": ["string", "null"], 
-                            "required": false,
-                            "default": null,
-                            "description": "Last used Working Directory Path for input/output files, when null/empty,  uses app's dir (default: null)",
-                        }, 
-                        "WriteLog": {
-                            "type": "boolean",
-                            "required": true,
-                            "description": "Whether to write messages to log file (default: true)",
-                        }, 
-                        "LogSize": {
-                            "type": "integer",
-                            "required": true,
-                            "description": "Allowed Log-file size limit [MiB] (default: 2)",
-                        }, 
-                        "LogLevel": {
-                            "type": "integer",
-                            "required": true,
-                            "description": "Message Output Level (default: 5 - 'info')",
-                        }, 
-                        "Editor": {
-                            "type": "string",
-                            "required": true,
-                            "description": "Path (or filename if in PATH) of some (text or JSON) editor (default: 'notepad.exe')",
-                        }, 
-                    }
-                }
+                    "description": "Path (or filename if in PATH) of some (text or JSON) editor (default: 'notepad.exe')",
+                }, 
             }
         }</json>.Value
     End Function
@@ -84,34 +66,23 @@ Public Class cPreferences
 
     ''' <summary>Reads from file or creates defaults</summary>
     ''' <param name="inputFilePath">If unspecifed, default prefs used, otherwise data read from file</param>
-    ''' <remarks></remarks>
-    Sub New(Optional ByVal inputFilePath As String = Nothing)
-        If (inputFilePath Is Nothing) Then
-            Me.Json_Contents = JObject.Parse(JsonStr_Contents())
-        Else
-            Me.Json_Contents = ReadJsonFile(inputFilePath)
-        End If
-    End Sub
-
-
-    ''' <summary>Validates and Writing to the config file</summary>
-    Sub Store(ByVal prefs_fpath As String)
-        Validate(Me.Strict)
-        WriteJsonFile(prefs_fpath, Json_Contents)
+    ''' <remarks>See cJsonFile() constructor</remarks>
+    Sub New(Optional ByVal inputFilePath As String = Nothing, Optional ByVal skipValidation As Boolean = False)
+        MyBase.New(inputFilePath, skipValidation)
     End Sub
 
 
     ''' <exception cref="SystemException">includes all validation errors</exception>
-    ''' <param name="isStrict">when True, no additional json-properties allowed in the data, when nothing, use value from Header</param>
-    Friend Sub Validate(Optional ByVal isStrict As Boolean? = Nothing)
-        Dim allowsAdditionalProps As Boolean = IIf(isStrict Is Nothing, Me.Strict, Not isStrict)
-        Dim schema = JsonSchema.Parse(JSchemaStr(allowsAdditionalProps))
-        Dim validateMsgs As IList(Of String) = New List(Of String)
-
-        ValidateJson(Me.Json_Contents, schema, validateMsgs)
+    ''' <param name="allowAdditionalProps">when False, no additional json-properties allowed in the data, when nothing, use value from Header</param>
+    Protected Overrides Sub ValidateVersionAndBody(ByVal fileVersion As String, ByVal body As JObject, ByVal allowAdditionalProps As Boolean, ByVal validateMsgs As IList(Of String))
+        Dim fromVersion = "1.0.0"
+        Dim toVersion = "2.0.0"
+        If Not IsSemanticVersionsSupported(fileVersion, fromVersion, toVersion) Then
+            validateMsgs.Add(format("Unsupported FileVersion({0}, was not in between [{1}, )", fileVersion, fromVersion, toVersion))
+        Else
+            Dim schema = JsonSchema.Parse(JSchemaStr(allowAdditionalProps)) ' TODO: Lazily create schemas once
 
-        If (validateMsgs.Any()) Then
-            Throw New SystemException(format("Invalid Preferences due to: {0}", String.Join(vbCrLf, validateMsgs)))
+            ValidateJson(body, schema, validateMsgs)
         End If
     End Sub
 
@@ -127,22 +98,9 @@ Public Class cPreferences
 
 
 #Region "json props"
-    Public ReadOnly Property FileVersion As String
-        Get
-            Return Me.Json_Contents("Header")("FileVersion")
-        End Get
-    End Property
-
-    Public ReadOnly Property Strict As Boolean
-        Get
-            Return Me.Json_Contents("Header")("Strict")
-        End Get
-    End Property
-
-
     Public Property WorkingDir As String
         Get
-            Dim value As String = Me.Json_Contents("Body")("WorkingDir")
+            Dim value As String = Me.Body("WorkingDir")
             If value Is Nothing OrElse value.Trim().Length = 0 Then
                 Return MyPath
             ElseIf IO.Path.IsPathRooted(value) Then
@@ -185,51 +143,48 @@ Public Class cPreferences
                 End If
             End If
 
-            If value Is Nothing Then
-                Me.Json_Contents("Body")("WorkingDir") = Nothing
-            Else
-                Me.Json_Contents("Body")("WorkingDir") = value
-            End If
+            Dim var As Object = value ' NOTE: Avoid early-binding so that Nulls do not end-up with String as schema-type.
+            Me.Body("WorkingDir") = var
         End Set
     End Property
 
     Public Property WriteLog As Boolean
         Get
-            Return Me.Json_Contents("Body")("WriteLog")
+            Return Me.Body("WriteLog")
         End Get
         Set(ByVal value As Boolean)
-            Me.Json_Contents("Body")("WriteLog") = value
+            Me.Body("WriteLog") = value
         End Set
     End Property
 
     Public Property LogSize As Integer
         Get
-            Return Me.Json_Contents("Body")("LogSize")
+            Return Me.Body("LogSize")
         End Get
         Set(ByVal value As Integer)
-            Me.Json_Contents("Body")("LogSize") = value
+            Me.Body("LogSize") = value
         End Set
     End Property
 
     Public Property LogLevel As Integer
         Get
-            Return Me.Json_Contents("Body")("LogLevel")
+            Return Me.Body("LogLevel")
         End Get
         Set(ByVal value As Integer)
-            Me.Json_Contents("Body")("LogLevel") = value
+            Me.Body("LogLevel") = value
         End Set
     End Property
 
     Public Property Editor As String
         Get
-            Return Me.Json_Contents("Body")("Editor")
+            Return Me.Body("Editor")
         End Get
         Set(ByVal value As String)
             If value Is Nothing OrElse value.Trim().Length = 0 Then
                 value = "notepad.exe"
             End If
 
-            Me.Json_Contents("Body")("Editor") = value
+            Me.Body("Editor") = value
         End Set
     End Property
 #End Region ' "json props"

CSE/GUI/F_Main.vb

@@ -28,9 +28,7 @@ Public Class F_Main
         ' Load the config file
         '
         Try
-            Dim fileprefs As New cPreferences(PreferencesPath)
-            fileprefs.Validate()
-            AppPreferences = fileprefs
+            AppPreferences = New cPreferences(PreferencesPath)
         Catch ex As Exception
             fInfWarErr(9, False, format("Failed loading Preferences({0}) due to: {1}", PreferencesPath, ex.Message))
             configL = False
@@ -61,7 +59,7 @@ Public Class F_Main
         If Not configL Then
             Try
                 AppPreferences.Store(PreferencesPath)
-                fInfWarErr(7, False, format("Created Preferences({0}).", PreferencesPath))
+                fInfWarErr(7, False, format("Stored new Preferences({0}).", PreferencesPath))
             Catch ex As Exception
                 fInfWarErr(9, False, format("Failed storing Preferences({0}) due to: {1}", PreferencesPath, ex.Message))
             End Try

CSE/GUI/F_Preferences.vb

@@ -20,7 +20,6 @@ Public Class F_Preferences
 
     Private Function prefs_PopulateTo() As cPreferences
         Dim value = New cPreferences()
-        value.Validate()
 
         value.WorkingDir = Me.TextBoxWorDir.Text
         value.Editor = Me.TextBoxNotepad.Text

CSE/Tools/ApplicationEvents.vb

@@ -7,6 +7,7 @@
 
             ' Close the open Filebrowser (Save the History)
             fbTXT.Close()
+            fbExe.Close()
             fbVECTO.Close()
             fbCSV.Close()
             fbDir.Close()
@@ -40,8 +41,7 @@
             ' compile date
             AppDate = fiAss.LastWriteTime.Date
 
-            AppPreferences = New cPreferences()
-            ''AppPreferences.Validate() !!!Skip schema-validation here, or else app hangs as zombie! (do it instead when creating new for Dialog)
+            AppPreferences = New cPreferences(, True) ' !!!Skip schema-validation here, or else app hangs as zombie! (do it instead when creating new for Dialog)
 
             ' Licencemodul
             Lic.FilePath = joinPaths(MyPath, "License.dat")

CSE/Tools/Minor_routines.vb

@@ -5,9 +5,24 @@ Imports System.Text.RegularExpressions
 
 Module Minor_routines
 
-    ' Functions for the identification from the fileend, -name and for the path identification
+    Function IsSemanticVersionsSupported(ByVal checkVersion As String, ByVal fromVersion As String, Optional ByVal toVersion As String = Nothing) As Boolean
+
+        Dim cver As New cSemanticVersion(checkVersion)
+        Dim fver As New cSemanticVersion(fromVersion)
+
+        If toVersion Is Nothing Then
+            Return fver <= cver
+        Else
+            Dim tver As New cSemanticVersion(toVersion)
+            Return fver <= cver AndAlso cver < tver
+        End If
+
+    End Function
+
+
+
+#Region "File paths" ' Functions for the identification from the fileend, -name and for the path identification
 
-#Region "File paths"
     ' Identification from the filename
     Public Function fName(ByVal Pfad As String, ByVal MitEndung As Boolean) As String
         Dim x As Int16
@@ -392,5 +407,4 @@ Module Minor_routines
 
 #End Region ' Strings
 
-
 End Module
\ No newline at end of file