Added path checks to the schema validations

karel26 · karel26 · commit b6df4fb1da42 · 2025-02-09T22:24:32.000+01:00
diff --git a/core/utils/validators.py b/core/utils/validators.py
@@ -1,8 +1,11 @@
+import logging
 import os
 
+from core import DEFAULT_TAG, COMMAND_LINE_ARGS
 from pykwalify.errors import SchemaError
 
-from core import DEFAULT_TAG, COMMAND_LINE_ARGS
+logger = logging.getLogger(__name__)
+
 
 def file_exists(value, rule_obj, path):
     if path and path.split("/")[1] in [DEFAULT_TAG, COMMAND_LINE_ARGS.node]:
diff --git a/extensions/realweather/schemas/realweather_schema.yaml b/extensions/realweather/schemas/realweather_schema.yaml
@@ -224,7 +224,7 @@ schema;instance_realweather_schema:
                   nullable: false
                   allowempty: true
                   mapping:
-                    default: {type: str, nullable: false, range: {min: 1}}
+                    default: {type: str, nullable: false}
                     disallowed:
                       type: seq
                       nullable: false
diff --git a/plugins/admin/schemas/admin_schema.yaml b/plugins/admin/schemas/admin_schema.yaml
@@ -8,7 +8,7 @@ schema;master_schema:
         - type: map
           mapping:
             label: {type: str, required: true, nullable: false, range: {min: 1}}
-            directory: {type: str, nullable: false, range: {min: 1}, func: file_exists}
+            directory: {type: str, nullable: false, range: {min: 1}}
             pattern: {type: str, nullable: false, range: {min: 1}}
             target: {type: str, nullable: false, range: {min: 1}}
             discord:
@@ -28,6 +28,9 @@ schema;master_schema:
           nullable: false
           sequence:
             - type: text
+    # Allow deep nesting for Node/Instance declaration
+    regex;(.+):
+      include: 'master_schema'
 
 type: map
 nullable: false
@@ -38,5 +41,3 @@ mapping:
     include: 'commands_schema'
   regex;(.+):
     include: 'master_schema'
-    regex;(.+):
-      include: 'master_schema'
diff --git a/plugins/creditsystem/schemas/creditsystem_schema.yaml b/plugins/creditsystem/schemas/creditsystem_schema.yaml
@@ -33,6 +33,15 @@ schema;master_schema:
             playtime: {type: int, range: {min: 0}, nullable: false}
             combined: {type: bool, nullable: false}
             role: {type: text, nullable: false}
+    leaderboard:
+      type: map
+      nullable: false
+      mapping:
+        channel: {type: int, nullable: false, required: true}
+        limit: {type: int, nullable: false}
+    # Allow deep nesting for Node/Instance declaration
+    regex;(.+):
+      include: 'master_schema'
 
 type: map
 nullable: false
@@ -43,5 +52,3 @@ mapping:
     include: 'commands_schema'
   regex;(.+):
     include: 'master_schema'
-    regex;(.+):
-      include: 'master_schema'
diff --git a/plugins/funkman/schemas/funkman_schema.yaml b/plugins/funkman/schemas/funkman_schema.yaml
@@ -1,7 +1,6 @@
 schema;master_schema:
   type: map
   nullable: false
-  required: true
   mapping:
     install: {type: str, nullable: false, range: {min: 1}, func: file_exists}
     CHANNELID_MAIN: {type: text, nullable: false}    # TODO: change this to int some day
@@ -12,6 +11,9 @@ schema;master_schema:
     strafe_channel: {type: int, nullable: false}
     bomb_board: {type: bool, nullable: false}
     bomb_channel: {type: int, nullable: false}
+    # Allow deep nesting for Node/Instance declaration
+    regex;(.+):
+      include: 'master_schema'
 
 type: map
 nullable: false
@@ -20,5 +22,3 @@ mapping:
     include: 'master_schema'
   regex;(.+):
     include: 'master_schema'
-    regex;(.+):
-      include: 'master_schema'
diff --git a/plugins/greenieboard/schemas/greenieboard_schema.yaml b/plugins/greenieboard/schemas/greenieboard_schema.yaml
@@ -59,6 +59,8 @@ schema;instance_schema:
         basedir: {type: str, nullable: false, range: {min: 1}}
         grades: {type: str, nullable: false, range: {min: 1}}
         trapsheets: {type: str, nullable: false, range: {min: 1}}
+    regex;(.+):
+      include: 'instance_schema'
 
 type: map
 nullable: false
@@ -69,5 +71,3 @@ mapping:
     include: 'commands_schema'
   regex;(.+):
     include: 'instance_schema'
-    regex;(.+):
-      include: 'instance_schema'
diff --git a/plugins/lotatc/schemas/lotatc_schema.yaml b/plugins/lotatc/schemas/lotatc_schema.yaml
@@ -20,6 +20,9 @@ schema;master_schema:
           sequence:
             - type: text
               nullable: false
+    # Allow deep nesting for Node/Instance declaration
+    regex;(.+):
+      include: 'master_schema'
 
 type: map
 nullable: false
@@ -30,5 +33,3 @@ mapping:
     include: 'commands_schema'
   regex;(.+):
     include: 'master_schema'
-    regex;(.+):
-      include: 'master_schema'
diff --git a/plugins/mission/schemas/mission_schema.yaml b/plugins/mission/schemas/mission_schema.yaml
@@ -12,6 +12,9 @@ schema;master_schema:
           sequence:
             - type: text
               nullable: false
+    # Allow deep nesting for Node/Instance declaration
+    regex;(.+):
+      include: 'master_schema'
 
 type: map
 nullable: false
@@ -22,6 +25,4 @@ mapping:
     include: 'commands_schema'
   regex;(.+):
     include: 'master_schema'
-    regex;(.+):
-      include: 'master_schema'
 
diff --git a/plugins/missionstats/schemas/missionstats_schema.yaml b/plugins/missionstats/schemas/missionstats_schema.yaml
@@ -13,6 +13,9 @@ schema;master_schema:
         persistent: {type: bool, nullable: false}
         channel: {type: int, nullable: false}
         title: {type: str, nullable: false, range: {min: 1}}
+    # Allow deep nesting for Node/Instance declaration
+    regex;(.+):
+      include: 'master_schema'
 
 type: map
 nullable: false
@@ -23,5 +26,3 @@ mapping:
     include: 'commands_schema'
   regex;(.+):
     include: 'master_schema'
-    regex;(.+):
-      include: 'master_schema'
diff --git a/plugins/motd/schemas/motd_schema.yaml b/plugins/motd/schemas/motd_schema.yaml
@@ -75,6 +75,9 @@ schema;master_schema:
 #          type: seq
 #          sequence:
 #            - include: 'nudge'
+    # Allow deep nesting for Node/Instance declaration
+    regex;(.+):
+      include: 'master_schema'
 
 type: map
 nullable: false
@@ -85,5 +88,3 @@ mapping:
     include: 'commands_schema'
   regex;(.+):
     include: 'master_schema'
-    regex;(.+):
-      include: 'master_schema'
diff --git a/plugins/pretense/schemas/pretense_schema.yaml b/plugins/pretense/schemas/pretense_schema.yaml
@@ -5,6 +5,9 @@ schema;master_schema:
     update_interval: {type: int, range: {min: 60}, nullable: false}
     json_file_path: {type: str, nullable: false, range: {min: 1}, func: file_exists}
     channel: {type: int, nullable: false}
+    # Allow deep nesting for Node/Instance declaration
+    regex;(.+):
+      include: 'master_schema'
 
 type: map
 nullable: false
@@ -15,5 +18,3 @@ mapping:
     include: 'commands_schema'
   regex;(.+):
     include: 'master_schema'
-    regex;(.+):
-      include: 'master_schema'
diff --git a/plugins/punishment/schemas/punishment_schema.yaml b/plugins/punishment/schemas/punishment_schema.yaml
@@ -63,6 +63,9 @@ schema;master_schema:
           sequence:
             - type: text
               nullable: false
+    # Allow deep nesting for Node/Instance declaration
+    regex;(.+):
+      include: 'master_schema'
 
 type: map
 nullable: false
@@ -73,5 +76,3 @@ mapping:
     include: 'commands_schema'
   regex;(.+):
     include: 'master_schema'
-    regex;(.+):
-      include: 'master_schema'
diff --git a/plugins/scheduler/README.md b/plugins/scheduler/README.md
@@ -102,11 +102,12 @@ Here you can provide a mission_id to be started on server startup.
 
 ### on-commands
 
-| Parameter      | Description                                                                                  |
-|----------------|----------------------------------------------------------------------------------------------|
-| onMissionStart | Called at the start of a mission (onSimulationStart).                                        |
-| onMissionEnd   | Called, when the Scheduler (!) ends a mission. Not if the mission is ended in any other way. |
-| onShutdown     | Called, when the DCS server is being shut down.                                              |
+| Parameter         | Description                                                           |
+|-------------------|-----------------------------------------------------------------------|
+| onSimulationStart | Called at the start of a mission.                                     |
+| onSimulationEnd   | Called, when the server stops.                                        |
+| onMissionEnd      | Called, when the mission has ended with a win for either blue or red. |
+| onShutdown        | Called, when the DCS server is being shut down.                       |
 
 Commands can be executed in different ways:
 
diff --git a/plugins/serverstats/schemas/serverstats_schema.yaml b/plugins/serverstats/schemas/serverstats_schema.yaml
@@ -6,6 +6,9 @@ schema;master_schema:
     period: {type: int, range: {min: 3}, nullable: false}
     mentioning: {type: bool, nullable: false}
     message: {type: str, nullable: false, range: {min: 1}}
+    # Allow deep nesting for Node/Instance declaration
+    regex;(.+):
+      include: 'master_schema'
 
 type: map
 nullable: false
@@ -16,5 +19,3 @@ mapping:
     include: 'commands_schema'
   regex;(.+):
     include: 'master_schema'
-    regex;(.+):
-      include: 'master_schema'
diff --git a/plugins/slotblocking/schemas/slotblocking_schema.yaml b/plugins/slotblocking/schemas/slotblocking_schema.yaml
@@ -29,6 +29,23 @@ schema;master_schema:
             VIP: {type: bool, nullable: false}
             side: {type: int, nullable: false, enum: [0, 1, 2]}
     payback: {type: bool, nullable: false}
+    balancing:
+      type: map
+      nullable: false
+      mapping:
+        blue_vs_red: {type: float, nullable: false, required: true}
+        threshold: {type: float, nullable: false, required: true}
+        activation_threshold: {type: int, nullable: false}
+        message: {type: str, nullable: false, range: {min: 1}}
+    messages:
+      type: map
+      nullable: false
+      mapping:
+        credits_taken: {type: str, nullable: false, range: {min: 1}}
+        payback: {type: str, nullable: false, range: {min: 1}}
+    # Allow deep nesting for Node/Instance declaration
+    regex;(.+):
+      include: 'master_schema'
 
 type: map
 nullable: false
@@ -39,5 +56,3 @@ mapping:
     include: 'commands_schema'
   regex;(.+):
     include: 'master_schema'
-    regex;(.+):
-      include: 'master_schema'
diff --git a/plugins/srs/schemas/srs_schema.yaml b/plugins/srs/schemas/srs_schema.yaml
@@ -5,6 +5,9 @@ schema;master_schema:
     message_no_srs: {type: str, nullable: false, range: {min: 1}}
     enforce_srs: {type: bool, nullable: false}
     move_to_spec: {type: bool, nullable: false}
+    # Allow deep nesting for Node/Instance declaration
+    regex;(.+):
+      include: 'master_schema'
 
 type: map
 nullable: false
@@ -15,5 +18,3 @@ mapping:
     include: 'commands_schema'
   regex;(.+):
     include: 'master_schema'
-    regex;(.+):
-      include: 'master_schema'
diff --git a/plugins/userstats/schemas/userstats_schema.yaml b/plugins/userstats/schemas/userstats_schema.yaml
@@ -20,6 +20,9 @@ schema;master_schema:
               mapping:
                 limit: {type: int, nullable: false, range: {min: 3, max: 20}}
     highscore: {type: any, nullable: false} # todo
+    # Allow deep nesting for Node/Instance declaration
+    regex;(.+):
+      include: 'master_schema'
 
 type: map
 nullable: false
@@ -30,5 +33,3 @@ mapping:
     include: 'commands_schema'
   regex;(.+):
     include: 'master_schema'
-    regex;(.+):
-      include: 'master_schema'
diff --git a/plugins/voting/schemas/voting_schema.yaml b/plugins/voting/schemas/voting_schema.yaml
@@ -32,6 +32,9 @@ schema;master_schema:
     voting_rule: {type: str, enum: ['majority', 'supermajority', 'unanimous', 'absolute'], nullable: false}
     welcome_message: {type: str, nullable: false, range: {min: 1}}
     credits: {type: int, nullable: false}
+    # Allow deep nesting for Node/Instance declaration
+    regex;(.+):
+      include: 'master_schema'
 
 type: map
 nullable: false
@@ -42,5 +45,3 @@ mapping:
     include: 'commands_schema'
   regex;(.+):
     include: 'master_schema'
-    regex;(.+):
-      include: 'master_schema'
diff --git a/services/cleanup/schemas/cleanup_schema.yaml b/services/cleanup/schemas/cleanup_schema.yaml
@@ -2,21 +2,22 @@ schema;master_schema:
   type: map
   nullable: false
   mapping:
+    directory: {type: str, nullable: false, range: {min: 1}}
+    pattern: {type: any, nullable: false}
+    recursive: {type: bool, nullable: false}
+    delete_after: {type: int, range: {min: 1}, nullable: false}
+    # Allow deep nesting for Node/Instance declaration
     regex;(.+):
-      type: map
-      nullable: false
-      mapping:
-        directory: {type: str, nullable: false, range: {min: 1}, func: file_exists}
-        pattern: {type: any, nullable: false}
-        recursive: {type: bool, nullable: false}
-        delete_after: {type: int, range: {min: 1}, nullable: false}
+      include: 'master_schema'
 
 type: map
 nullable: false
 mapping:
   DEFAULT:
     include: 'master_schema'
   regex;(.+):
-    include: 'master_schema'
-    regex;(.+):
-      include: 'master_schema'
+    type: map
+    nullable: false
+    mapping:
+      regex;(.+):
+        include: 'master_schema'
diff --git a/services/cron/schemas/cron_schema.yaml b/services/cron/schemas/cron_schema.yaml
@@ -19,12 +19,13 @@ schema;master_schema:
                 params:
                   nullable: false
                   type: any
+    # Allow deep nesting for Node/Instance declaration
+    regex;(.+):
+      include: 'master_schema'
 
 type: map
 mapping:
   DEFAULT:
     include: 'master_schema'
   regex;(.+):
     include: 'master_schema'
-    regex;(.+):
-      include: 'master_schema'
diff --git a/services/modmanager/schemas/modmanager_schema.yaml b/services/modmanager/schemas/modmanager_schema.yaml
@@ -1,3 +1,10 @@
+schema;default_schema:
+  type: map
+  nullable: false
+  mapping:
+    SavedGames: {type: str, required: true, nullable: false, range: {min: 1}, func: file_exists}
+    RootFolder: {type: str, required: true, nullable: false, range: {min: 1}, func: file_exists}
+
 schema;master_schema:
   type: map
   nullable: false
@@ -13,13 +20,9 @@ schema;master_schema:
             version: {type: text, required: true, nullable: false}
             source: {type: str, enum: ['SavedGames', 'RootFolder'], required: true, nullable: false}
             repo: {type: url, nullable: false}
-
-schema;default_schema:
-  type: map
-  nullable: false
-  mapping:
-    SavedGames: {type: str, required: true, nullable: false, range: {min: 1}, func: file_exists}
-    RootFolder: {type: str, required: true, nullable: false, range: {min: 1}, func: file_exists}
+    # Allow deep nesting for Node/Instance declaration
+    regex;(.+):
+      include: 'master_schema'
 
 type: map
 nullable: false
@@ -28,5 +31,3 @@ mapping:
     include: 'default_schema'
   regex;(.+):
     include: 'master_schema'
-    regex;(.+):
-      include: 'master_schema'
diff --git a/services/music/schemas/music_schema.yaml b/services/music/schemas/music_schema.yaml
