ENHANCEMENTS:

- Scheduler can now handle presets on startup and action

CHANGES:
- Scheduler: local_times and utc_times migrated to times (auto-migration)
- MizEdit: can work with timezones now

Author: karel26

core/data/impl/serverimpl.py

@@ -7,7 +7,6 @@
 import os
 import psutil
 import shutil
-import socket
 import subprocess
 import sys
 import tempfile
@@ -412,7 +411,7 @@ async def _ensure_transport(self):
         loop = asyncio.get_running_loop()
         self.transport, _ = await loop.create_datagram_endpoint(
             lambda: asyncio.DatagramProtocol(),
-            remote_addr=("127.0.0.1", self.port),
+            remote_addr=("127.0.0.1", int(self.port)),
             local_addr=("0.0.0.0", 0),
         )
 
@@ -655,8 +654,6 @@ async def startup(self, modify_mission: bool | None = True, use_orig: bool | Non
                 raise Exception("Your DCS installation is not desanitized properly to be used with DCSServerBot!")
             else:
                 utils.desanitize(self)
-        else:
-            self.log.debug("MissionScripting.lua is already desanitized.")
         self.status = Status.LOADING
         await self.init_extensions()
         await self.prepare_extensions()
@@ -879,7 +876,8 @@ async def modifyMission(self, filename: str, preset: list | dict, use_orig: bool
             shutil.copy2(orig_filename, new_filename)
         elif new_filename != filename:
             shutil.copy2(filename, new_filename)
-        await MizEdit.apply_presets(self, new_filename, preset)
+        if preset:
+            await MizEdit.apply_presets(self, new_filename, preset)
         return new_filename
 
     @override

core/utils/helper.py

@@ -387,7 +387,7 @@ def get_presets(node: Node) -> Iterable[str]:
     return presets
 
 
-def get_preset(node: Node, name: str, filename: str | None = None) -> dict | None:
+def get_preset(node: Node, name: str, filename: str | list[str] | None = None) -> dict | None:
     """
     :param node: The node where the configuration is stored.
     :param name: The name of the preset to retrieve.
@@ -405,13 +405,17 @@ def _read_presets_from_file(filename: Path, name: str) -> dict | list | None:
             return [_read_presets_from_file(filename, x) for x in preset]
         return preset
 
-    if filename:
-        return _read_presets_from_file(Path(filename), name)
+    if isinstance(filename, str):
+        preset_files = [filename]
+    elif isinstance(filename, list):
+        preset_files = filename
     else:
-        for file in Path(node.config_dir).glob('presets*.yaml'):
-            preset = _read_presets_from_file(file, name)
-            if preset:
-                return preset
+        preset_files = Path(node.config_dir).glob('presets*.yaml')
+
+    for file in preset_files:
+        preset = _read_presets_from_file(Path(file), name)
+        if preset:
+            return preset
     return None
 
 

core/utils/validators.py

@@ -143,7 +143,14 @@ def dir_exists(value, _, path):
             raise SchemaError(msg=f'Directory "{value}" does not exist or is no directory', path=path)
     return True
 
-def obsolete(value, rule, path):
+def deprecated(value, rule_obj, path):
+    message = f'Parameter "{os.path.basename(path)}" is deprecated.'
+    enum = rule_obj.schema_str.get('enum', [])
+    if enum:
+        message += ' ' + enum[0]
+    raise SchemaError(msg=message, path=path)
+
+def obsolete(value, rule_obj, path):
     if _is_valid(path):
         logger.warning(f'"{os.path.basename(path)}" is obsolete and will be set by the bot: Path "{path}"')
     return True

extensions/mizedit/README.md

@@ -1,36 +1,38 @@
 # Extension "MizEdit"
 
-One of the main concepts of DCSServerBot is to have you use any standard mission that you built or got from the
-community and do whatever you like with it, without the need of you changing anything in the mission itself.
-This works well for SlotBlocking already or the CreditSystem, but you can even go further and really amend the mission
-without touching it.
+One of the primary features of DCSServerBot is its ability to allow users to use any standard missions, 
+either self-created or obtained from the community, while having complete control over them without modifying the 
+mission itself. 
+This flexibility applies to SlotBlocking and CreditSystem configurations, but users can also make more extensive 
+modifications to the missions itself as desired without having to open the MissionEditor at all.
 
 Sounds like magic? Well, it kinda is.
 
 ## Concept
-The whole concept behind MizEdit is, that your mission consists out of several files that are bundled together in a 
-zipped file that ED decided to give the ".miz" extension. One of these files, the `mission`-file is a large lua table
-that holds the main information about your mission, like the theatre, the date and time, the weather, all units, 
-triggers, the majority of settings and whatnot. Another one is `options`, which holds parts of the configuration of
-your mission and last but not least there is `warehouses`, that holds information about the dedicated airports and their
-warehouses.<br>
-The Mission Editor writes and changes these files to represent any change that you made to your mission.
-So - why not do that on our own, without the need of the editor?
+DCS World organizes a mission as multiple files within a zipped archive with the ".miz" extension, one of which is the 
+**mission** file - a large Lua table containing essential information about the mission such as the theater, date and time, 
+weather, units, triggers, settings, and more. 
+The **options** file stores parts of the mission configuration, while the **warehouses** file contains details about 
+the dedicated airports and their warehouses. 
+By using the Mission Editor to write and modify these files, any changes made to the mission are accurately represented. 
+However, the question is: why not accomplish this directly, without relying on the editor?
 
 ## Presets
-Each mission change is represented in a small data-structure in yaml. I've called these "presets", as they usually will
-work as a fixed setting for any mission you have, like any weather preset you know already from the recent DCS versions.
+Each modification made to a mission is stored in a compact YAML data structure that I've named "presets". 
+These presets typically function as consistent settings that can be applied to any mission, similar to weather presets 
+familiar from recent DCS World versions.
 
 > [!NOTE]
-> If you want to look up the presets used in DCS, you can take a look at 
+> If you want to look up the weather-presets used in DCS World, you can take a look at 
 > `C:\Program Files\Eagle Dynamics\DCS World\Config\Effects\clouds.lua`.
 
 ### config/presets.yaml
-As you usually want to re-use your presets, they are bundled together in a larger configuration file. Each preset has
-a name. Presets can be chained to create a combination of presets as a separate preset.
+Since presets are meant for frequent use, they are organized within a larger configuration file. 
+Each preset can be given a unique name, and multiple presets can be combined to create new presets by linking them 
+together.
 
 > [!TIP]
-> You can create any other file named presets*.yaml to better structure your presets.
+> You can create any other file named "presets*.yaml" to better structure your presets.
 > If you want to use presets from another yaml file, you can specify that in your MizEdit-Extension.
 > You can mix several presets files by specifying them as a list (see example below).
 
@@ -84,7 +86,8 @@ With this method, you can change the following values in your mission (to be ext
 * miscellaneous (set any miscellaneous option)
 * difficulty (set any difficulty option)
 
-I highly recommend looking at a mission or options file inside your miz-file to see the structure of these settings.
+> [!NOTE]
+> I highly recommend looking at a mission or options file inside your miz-file to see the structure of these settings.
 
 date has different options:
 * date: '2022-05-31' # normal date
@@ -97,13 +100,13 @@ start_time has different options:
 * start_time: 'morning +02:00' # relative time to one of the above-mentioned moments
 
 > [!NOTE]
-> The moments are calculated based on the current theatre and date. If you change the date through MizEdit, you need to
-> set that prior to the start_time!
+> The moments are calculated based on the current theater and date. 
+> If you change the date through MizEdit, you need to set that prior to the start_time!
 > 
 > Thanks, @davidp57 for contributing the moments-part!
 
 #### b) Attaching Files
-If you want to attach files to your mission (e.g. sounds but others like scripts, etc.), you can do it like this:
+If you want to attach files to your mission (e.g. sounds or others like scripts, etc.), you can do it like this:
 ```yaml
 Sounds:
   files:
@@ -124,8 +127,8 @@ AddFiles:
 ```
 
 #### c) Fog
-With DCS 2.9.10, Eagle Dynamics added a new fog system, which allows fog animations, based on time. You can use this 
-new feature set with the bot like so:
+Starting with DCS 2.9.10, Eagle Dynamics added a new fog system, which allows fog animations, based on time. 
+You can use this new feature with the bot like so:
 ```yaml
 auto_fog:   # let DCS to the fog on its own
     fog:
@@ -143,7 +146,7 @@ The key is the time in seconds after which the specific thickness and visibility
 the fog changes in-between for you.
 
 #### d) DCS RealWeather
-You can run DCS RealWeather from MizEdit now:
+You can run DCS RealWeather from MizEdit like so:
 ```yaml
 realweather:
     RealWeather:
@@ -153,10 +156,12 @@ realweather:
 ```
 
 #### e) Complex Modifications
-Sometimes, only changing the weather is not enough, and you want to change some parts in the mission that are deeply 
-nested or even dependent on another parts of your mission file. This is for instance true, if you want to change
-frequencies, TACAN codes or similar items.
-Therefore, I developed some SQL-like query language, where you can search and change values in your mission.
+In certain instances, modifying only the weather may not suffice, as there may be parts of the mission that are deeply 
+nested or dependent on other elements within the mission file. 
+For example, adjusting frequencies, TACAN codes, or similar items can require direct access to specific areas of the 
+mission data. 
+To address this issue, I developed a SQL-like query language capable of searching and modifying values in the mission 
+file.
 
 > [!NOTE]
 > As this is complex and very (!) powerful, I decided to move the documentation in a separate file [here](MODIFY.md).
@@ -192,6 +197,7 @@ b) Random choice of fixed settings
 c) Permutations
 ```yaml
         MizEdit:
+          timezone: UTC # optional - provide a timezone for the time values
           settings:
             00:00-12:00:  # Any permutation out of [Spring, Summer] + [Morning, Noon] + [Slight Breeze, Rainy, Heavy Storm]
             - - Spring

extensions/mizedit/extension.py

@@ -10,6 +10,7 @@
 from pathlib import Path
 from typing import cast
 from typing_extensions import override
+from zoneinfo import ZoneInfo
 
 # ruamel YAML support
 from ruamel.yaml import YAML
@@ -32,7 +33,7 @@ def __init__(self, server: Server, config: dict):
         else:
             self.presets = {}
 
-    def _init_presets(self):
+    def _init_presets(self) -> dict:
         presets_file = self.config.get('presets', os.path.join(self.node.config_dir, 'presets.yaml'))
         presets = {}
         if not isinstance(presets_file, list):
@@ -66,8 +67,10 @@ async def get_presets(self, config: dict) -> list[dict]:
         now = datetime.now()
         presets = config['settings']
         if isinstance(presets, dict):
+            tz = config.get('timezone')
+            tzinfo = ZoneInfo(tz) if tz else None
             for key, value in presets.items():
-                if utils.is_in_timeframe(now, key):
+                if utils.is_in_timeframe(now, key, tz=tzinfo):
                     presets = value
                     break
             else:

extensions/mizedit/schemas/mizedit_schema.yaml

@@ -29,6 +29,7 @@ schema;mizedit_schema:
     enabled: {type: bool, nullable: false}
     debug: {type: bool, nullable: false}
     presets: {type: any, nullable: false, func: str_or_list}
+    timezone: {type: str, nullable: false, range: {min: 1}}
     settings:
       type: any
       include: 'settings'

plugins/mission/commands.py

@@ -335,10 +335,10 @@ async def _restart(self, interaction: discord.Interaction,
                 return
             elif result == 'later':
                 server.on_empty = {
-                    "command": what,
-                    "user": interaction.user,
+                    "method": what,
                     "run_extensions": run_extensions,
-                    "use_orig": use_orig
+                    "use_orig": use_orig,
+                    "user": interaction.user
                 }
                 server.restart_pending = True
                 await interaction.followup.send(_('Mission will {}, when server is empty.').format(_(what)),
@@ -435,10 +435,10 @@ async def _load(self, interaction: discord.Interaction, server: Server, mission:
         if server.current_mission and mission == server.current_mission.filename:
             if result == 'later':
                 server.on_empty = {
-                    "command": "restart",
-                    "user": interaction.user,
+                    "method": "restart",
                     "run_extensions": run_extensions,
-                    "use_orig": use_orig
+                    "use_orig": use_orig,
+                    "user": interaction.user
                 }
                 server.restart_pending = True
                 await interaction.followup.send(_('Mission will {}, when server is empty.').format(_('restart')),
@@ -449,10 +449,10 @@ async def _load(self, interaction: discord.Interaction, server: Server, mission:
         else:
             name = os.path.basename(mission[:-4])
             if mission_id is not None and result == 'later':
-                # make sure, we load that mission, independently on what happens to the server
+                # make sure we load that mission, independently of what happens to the server
                 await server.setStartIndex(mission_id + 1)
                 server.on_empty = {
-                    "command": "load",
+                    "method": "load",
                     "mission_id": mission_id + 1,
                     "run_extensions": run_extensions,
                     "use_orig": use_orig,
@@ -623,7 +623,13 @@ async def unpause(self, interaction: discord.Interaction,
                 ephemeral=ephemeral)
 
     async def simulate(self, interaction: discord.Interaction, server: Server, use_orig: bool, presets_file: str,
-                       presets: list[str], ephemeral: bool):
+                       presets: list[str] | None, ephemeral: bool):
+
+        presets = {x: utils.get_preset(self.node, x, filename=presets_file) for x in presets} if presets else None
+        if not presets:
+            await interaction.followup.send("No presets provided for simulation.")
+            return
+
         mission_file = await server.get_current_mission_file()
         if use_orig:
             if server.is_remote:
@@ -633,11 +639,6 @@ async def simulate(self, interaction: discord.Interaction, server: Server, use_o
             mission_file = utils.get_orig_file(mission_file)
         old_mission: MizFile = await asyncio.to_thread(MizFile, mission_file)
         new_mission: MizFile = await asyncio.to_thread(MizFile, mission_file)
-        presets = {x: utils.get_preset(self.node, x, filename=presets_file) for x in presets}
-
-        if not presets:
-            await interaction.followup.send("You need to select presets.", ephemeral=True)
-            return
 
         for k, v in presets.items():
             try:
@@ -763,8 +764,9 @@ async def modify(self, interaction: discord.Interaction,
 
         if result == 'later':
             server.on_empty = {
-                "command": "preset",
-                "preset": view.result,
+                "method": "restart",
+                "presets": presets_file,
+                "settings": view.result,
                 "use_orig": use_orig,
                 "user": interaction.user
             }

plugins/mission/upload.py

@@ -122,7 +122,11 @@ async def post_upload(self, uploaded: list[discord.Attachment]):
             elif rc == 'later':
                 mission_id = (await self.server.getMissionList()).index(filename)
                 await self.server.setStartIndex(mission_id + 1)
-                self.server.on_empty = {"command": "load", "mission_id": mission_id + 1, "user": self.message.author}
+                self.server.on_empty = {
+                    "method": "load",
+                    "mission_id": mission_id + 1,
+                    "user": self.message.author
+                }
                 await self.channel.send(
                     _('Mission {} will be loaded when server is empty or on the next restart.').format(filename))
                 return

plugins/realweather/commands.py

@@ -139,7 +139,11 @@ async def realweather(self, interaction: discord.Interaction,
                 await server.restart(modify_mission=False)
                 message += '\nMission reloaded.'
             elif result == 'later':
-                server.on_empty = {"command": "load", "mission_file": new_filename, "user": interaction.user}
+                server.on_empty = {
+                    "method": "load",
+                    "mission_file": new_filename,
+                    "user": interaction.user
+                }
                 msg += 'Mission will restart, when server is empty.'
 
             await self.bot.audit("changed weather", server=server, user=interaction.user)