Merge branch 'development'

Author: karel26

README.md

@@ -419,6 +419,7 @@ My Fancy Server:                # Your server name, as displayed in the server l
   ping_admin_on_crash: true     # Ping DCS Admin role in discord, when the server crashed. Default: true
   autoscan: false               # Enable autoscan for new missions (and auto-add them to the mission list). Default: false
   autoadd: true                 # Enable auto-adding of uploaded missions (default: true)
+  validate_missions: true       # Check, if your missions can be loaded or not (missing maps, etc). Default: true.
   ignore_dirs:                  # Optional: ignore directories from mission upload / mission add (already ignored are .dcssb, Scripts and Saves)
     - archive
   autorole: Fancy Players       # Optional: give people this role, if they are online on this server (overwrites autorole[online] in bot.yaml!).

core/data/impl/serverimpl.py

@@ -239,7 +239,8 @@ def set_status(self, status: Union[Status, str]):
             elif self._status in [Status.UNREGISTERED, Status.LOADING] and new_status in [Status.RUNNING, Status.PAUSED]:
                 # only check the mission list, if we started that server
                 if self._status == Status.LOADING:
-                    asyncio.create_task(self._load_mission_list())
+                    if self.locals.get('validate_missions', True):
+                        asyncio.create_task(self._load_mission_list())
                 asyncio.create_task(self.init_extensions())
                 asyncio.create_task(self._startup_extensions(status))
             elif self._status in [Status.RUNNING, Status.PAUSED, Status.SHUTTING_DOWN] and new_status in [Status.STOPPED, Status.SHUTDOWN]:
@@ -432,7 +433,7 @@ def do_startup(self):
                 _mission = mission
             # check if the orig file has been updated
             orig = _mission + '.orig'
-            if os.path.exists(orig) and os.path.getmtime(orig) > os.path.getmtime(mission):
+            if os.path.exists(orig) and os.path.exists(mission) and os.path.getmtime(orig) > os.path.getmtime(mission):
                 shutil.copy2(orig, _mission)
                 missions.append(_mission)
             elif os.path.exists(mission):
@@ -617,7 +618,7 @@ async def shutdown(self, force: bool = False) -> None:
                 await self.do_shutdown()
                 # wait 30/60s for the process to terminate
                 for i in range(1, 60 if self.node.locals.get('slow_system', False) else 30):
-                    if not self.process.is_running():
+                    if not self.process or not self.process.is_running():
                         break
                     await asyncio.sleep(1)
             await self._terminate()
@@ -634,7 +635,7 @@ async def is_running(self) -> bool:
 
     async def _terminate(self) -> None:
         try:
-            if not self.process.is_running():
+            if not self.process or not self.process.is_running():
                 return
             self.process.terminate()
             # wait 30/60s for the process to terminate
@@ -681,37 +682,39 @@ async def apply_mission_changes(self, filename: Optional[str] = None) -> str:
                 if not filename:
                     self.log.warning("No mission found. Is your mission list empty?")
                     return filename
+
             new_filename = utils.get_orig_file(filename)
-            # process all mission modifications
-            dirty = False
-            for ext in self.extensions.values():
-                if type(ext).beforeMissionLoad != Extension.beforeMissionLoad:
-                    new_filename, _dirty = await ext.beforeMissionLoad(new_filename)
-                    if _dirty:
-                        self.log.info(f'  => {ext.name} applied on {new_filename}.')
-                    dirty |= _dirty
-            # we did not change anything in the mission
-            if not dirty:
+            try:
+                # process all mission modifications
+                dirty = False
+                for ext in self.extensions.values():
+                    if type(ext).beforeMissionLoad != Extension.beforeMissionLoad:
+                        new_filename, _dirty = await ext.beforeMissionLoad(new_filename)
+                        if _dirty:
+                            self.log.info(f'  => {ext.name} applied on {new_filename}.')
+                        dirty |= _dirty
+                # we did not change anything in the mission
+                if not dirty:
+                    return filename
+                # check if the original mission can be written
+                if filename != new_filename:
+                    missions: list[str] = self.settings['missionList']
+                    try:
+                        index = missions.index(filename) + 1
+                        await self.replaceMission(index, new_filename)
+                    except ValueError:
+                        # we should not be here, but just in case
+                        if new_filename not in missions:
+                            await self.addMission(new_filename)
+                return new_filename
+            except Exception as ex:
+                if isinstance(ex, UnsupportedMizFileException):
+                    self.log.error(ex)
+                else:
+                    self.log.exception(ex)
+                if filename != new_filename and os.path.exists(new_filename):
+                    os.remove(new_filename)
                 return filename
-            # check if the original mission can be written
-            if filename != new_filename:
-                missions: list[str] = self.settings['missionList']
-                try:
-                    index = missions.index(filename) + 1
-                    await self.replaceMission(index, new_filename)
-                except ValueError:
-                    # we should not be here, but just in case
-                    if new_filename not in missions:
-                        await self.addMission(new_filename)
-            return new_filename
-        except Exception as ex:
-            if isinstance(ex, UnsupportedMizFileException):
-                self.log.error(ex)
-            else:
-                self.log.exception(ex)
-            if filename != new_filename and os.path.exists(new_filename):
-                os.remove(new_filename)
-            return filename
         finally:
             # enable autoscan
             if self.locals.get('autoscan', False):

core/utils/dcs.py

@@ -1,3 +1,4 @@
+import filecmp
 import luadata
 import math
 import os
@@ -110,7 +111,10 @@ def desanitize(self, _filename: str = None) -> None:
 
 
 def is_desanitized(node: Node) -> bool:
+    alt_filename = os.path.join(node.config_dir, 'MissionScripting.lua')
     filename = os.path.join(node.installation, 'Scripts', 'MissionScripting.lua')
+    if os.path.exists(alt_filename):
+        return filecmp.cmp(filename, alt_filename, shallow=False)
     with open(filename, mode='r', encoding='utf-8') as infile:
         for line in infile.readlines():
             if line.lstrip().startswith('--'):
@@ -162,6 +166,8 @@ def create_writable_mission(filename: str) -> str:
 
 
 def get_orig_file(filename: str, *, create_file: bool = True) -> Optional[str]:
+    if filename.endswith('.orig'):
+        return filename
     if '.dcssb' in filename:
         mission_file = os.path.join(os.path.dirname(filename).replace('.dcssb', ''),
                                     os.path.basename(filename))

core/utils/helper.py

@@ -24,6 +24,7 @@
 import random
 import math
 
+from collections.abc import Mapping
 from copy import deepcopy
 from croniter import croniter
 from datetime import datetime, timedelta
@@ -68,6 +69,7 @@
     "SettingsDict",
     "RemoteSettingsDict",
     "tree_delete",
+    "deep_merge",
     "hash_password",
     "evaluate",
     "for_each",
@@ -781,6 +783,18 @@ def tree_delete(d: dict, key: str, debug: Optional[bool] = False):
         curr_element.pop(int(keys[-1]))
 
 
+def deep_merge(dict1, dict2):
+    result = dict(dict1)  # Create a shallow copy of dict1
+    for key, value in dict2.items():
+        if key in result and isinstance(result[key], Mapping) and isinstance(value, Mapping):
+            # Recursively merge dictionaries
+            result[key] = deep_merge(result[key], value)
+        else:
+            # Overwrite or add the new key-value pair
+            result[key] = value
+    return result
+
+
 def hash_password(password: str) -> str:
     # Generate an 11 character alphanumeric string
     key = ''.join(secrets.choice(string.ascii_letters + string.digits) for _ in range(11))

extensions/realweather/extension.py

@@ -39,6 +39,13 @@ def version(self) -> Optional[str]:
         return utils.get_windows_version(os.path.join(os.path.expandvars(self.config['installation']),
                                                       'realweather.exe'))
 
+    def load_config(self) -> Optional[dict]:
+        try:
+            with open(self.config_path, mode='rb') as infile:
+                return tomli.load(infile)
+        except tomli.TOMLDecodeError as ex:
+            raise RealWeatherException(f"Error while reading {self.config_path}: {ex}")
+
     def get_config(self, filename: str) -> dict:
         if 'terrains' in self.config:
             miz = MizFile(filename)
@@ -62,7 +69,7 @@ def get_icao_code(filename: str) -> Optional[str]:
         else:
             return None
 
-    async def generate_config_1_0(self, input_mission: str, output_mission: str, cwd: str):
+    async def generate_config_1_0(self, input_mission: str, output_mission: str, override: Optional[dict] = None):
         try:
             with open(self.config_path, mode='r', encoding='utf-8') as infile:
                 cfg = json.load(infile)
@@ -88,10 +95,10 @@ async def generate_config_1_0(self, input_mission: str, output_mission: str, cwd
                 }
             }
             self.config['metar'] = {"icao": icao}
-        with open(os.path.join(cwd, 'config.json'), mode='w', encoding='utf-8') as outfile:
-            json.dump(cfg, outfile, indent=2)
+        self.locals = utils.deep_merge(cfg, override or {})
+        await self.write_config()
 
-    async def generate_config_2_0(self, input_mission: str, output_mission: str, cwd: str):
+    async def generate_config_2_0(self, input_mission: str, output_mission: str, override: Optional[dict] = None):
         tmpfd, tmpname = tempfile.mkstemp()
         os.close(tmpfd)
         try:
@@ -129,18 +136,26 @@ async def generate_config_2_0(self, input_mission: str, output_mission: str, cwd
                     "icao": icao
                 }
             }
-        with open(os.path.join(cwd, 'config.toml'), mode='wb') as outfile:
-            tomli_w.dump(cfg, outfile)
+        self.locals = utils.deep_merge(cfg, override or {})
+        await self.write_config()
 
-    async def beforeMissionLoad(self, filename: str) -> tuple[str, bool]:
-        tmpfd, tmpname = tempfile.mkstemp()
-        os.close(tmpfd)
+    async def write_config(self):
         cwd = await self.server.get_missions_dir()
+        if self.version.split('.')[0] == '1':
+            with open(os.path.join(cwd, 'config.json'), mode='w', encoding='utf-8') as outfile:
+                json.dump(self.locals, outfile, indent=2)
+        else:
+            with open(os.path.join(cwd, 'config.toml'), mode='wb') as outfile:
+                tomli_w.dump(self.locals, outfile)
 
+    async def generate_config(self, filename: str, tmpname: str, config: Optional[dict] = None):
         if self.version.split('.')[0] == '1':
-            await self.generate_config_1_0(filename, tmpname, cwd)
+            await self.generate_config_1_0(filename, tmpname, config)
         else:
-            await self.generate_config_2_0(filename, tmpname, cwd)
+            await self.generate_config_2_0(filename, tmpname, config)
+
+    async def run_realweather(self, filename: str, tmpname: str) -> tuple[str, bool]:
+        cwd = await self.server.get_missions_dir()
         rw_home = os.path.expandvars(self.config['installation'])
 
         def run_subprocess():
@@ -151,7 +166,7 @@ def run_subprocess():
                 self.log.error(stderr.decode('utf-8'))
             output = stdout.decode('utf-8')
             metar = next((x for x in output.split('\n') if 'METAR:' in x), "")
-            remarks = self.config.get('realweather', {}).get('mission', {}).get('brief', {}).get('remarks', 'RMK Generated by DCS Real Weather')
+            remarks = self.locals.get('realweather', {}).get('mission', {}).get('brief', {}).get('remarks', '')
             matches = re.search(rf"(?<=METAR: )(.*)(?= {remarks})", metar)
             if matches:
                 self.metar = matches.group(0)
@@ -171,6 +186,18 @@ def run_subprocess():
         os.remove(tmpname)
         return new_filename, True
 
+    async def beforeMissionLoad(self, filename: str) -> tuple[str, bool]:
+        tmpfd, tmpname = tempfile.mkstemp()
+        os.close(tmpfd)
+        await self.generate_config(filename, tmpname)
+        return await self.run_realweather(filename, tmpname)
+
+    async def apply_realweather(self, filename: str, config: dict) -> str:
+        tmpfd, tmpname = tempfile.mkstemp()
+        os.close(tmpfd)
+        await self.generate_config(utils.get_orig_file(filename), tmpname, config)
+        return (await self.run_realweather(filename, tmpname))[0]
+
     async def render(self, param: Optional[dict] = None) -> dict:
         if self.version.split('.')[0] == '1':
             icao = self.config.get('metar', {}).get('icao')

extensions/skyeye/README.md

@@ -26,7 +26,7 @@ MyNode:
       extensions:
         SkyEye:
           debug: true                   # Replicate the SkyEye console log into the DCSSB log
-          config: '%USERPROFILE%\Saved Games\DCS.release_server\Config\SkyEye.yaml' # your SkyEye config file.
+          config: '%USERPROFILE%\Saved Games\DCS.release_server\Config\SkyEye.yaml' # your SkyEye config file (default path)
           affinity: 14,15               # Set the core affinity for SkyEye (recommended!)
           coalition: blue               # Which coalition should SkyEye be active on   
           any-other-skyeye-config: xxx  # See the SkyEye documentation. 

extensions/skyeye/schemas/skyeye_schema.yaml

@@ -8,9 +8,10 @@ schema;instance_skyeye_schema:
   type: map
   mapping:
     enabled: {type: bool}
+    affinity: {type: any}
     debug: {type: bool}
-    config: {type: str, required: true}
-    coalition: {type: str, required: true, enum: ['blue', 'red']}
+    config: {type: str}
+    coalition: {type: str, enum: ['blue', 'red']}
     recognizer: {type: str, enum: ['openai-whisper-local', 'openai-whisper-api']}
     whisper-model: {type: str}
     openai-api-key: {type: str}

plugins/funkman/README.md

@@ -1,6 +1,9 @@
 # Plugin "FunkMan"
-This plugin adds support for the Moose Funkman protocol. You need to install [FunkMan](https://github.com/funkyfranky/FunkMan) for it to work.<br/>
-And no, you don't need to run two bots, I just use some modules from FunkMan, just because they are nice :).
+This plugin adds support for the Moose Funkman protocol. You need to install [FunkMan](https://github.com/funkyfranky/FunkMan) for it to work.
+
+> [!IMPORTANT]
+> You do not need to run the FunkMan bot! 
+> I just use some modules from FunkMan, so all you need is to tell the bot where it finds the files.
 
 FunkMan supports the following Moose modules:
 * AIRBOSS
@@ -40,17 +43,16 @@ DEFAULT:
 
 If you want to use different channels for your different servers, you can add a section for each server:
 ```yaml
-DCS.release_server:
+DEFAULT:
   install: ../FunkMan
+  IMAGEPATH: ../FunkMan/funkpics/
+DCS.release_server:
   CHANNELID_MAIN: 1122334455667788
   CHANNELID_RANGE: 8877665544332211
   CHANNELID_AIRBOSS: 1188227733664455
-  IMAGEPATH: ../FunkMan/funkpics/
 DCS.release_server02:
   CHANNELID_MAIN: 1234567812345678
   CHANNELID_RANGE: 8765432187654321
-  CHANNELID_AIRBOSS: 1112223334445555
-  IMAGEPATH: ../FunkMan/funkpics/
 ```
 
 ### Rangeboards for Strafing and Bombing

plugins/gamemaster/lua/callbacks.lua

@@ -37,15 +37,4 @@ function gamemaster.onPlayerTryChangeSlot(playerID, side, slotID)
     end
 end
 
-function gamemaster.onPlayerChangeSlot(id)
-    local side = net.get_player_info(id, 'side')
-    local slot = net.get_player_info(id, 'slot')
-    local _, _slot, _ = utils.getMulticrewAllParameters(id)
-
-    -- workaround for non-working onPlayerTryChangeSlot calls on dynamic spawns
-    if _slot > 1000000 and gamemaster.onPlayerTryChangeSlot(id, side, slot) == false then
-        net.force_player_slot(id, side, 1)
-    end
-end
-
 DCS.setUserCallbacks(gamemaster)

plugins/mission/commands.py

@@ -164,7 +164,8 @@ async def info(self, interaction: Interaction, server: app_commands.Transform[Se
     @mission.command(description=_('Manage the active mission'))
     @app_commands.guild_only()
     @utils.app_has_role('DCS Admin')
-    async def manage(self, interaction: Interaction, server: app_commands.Transform[Server, utils.ServerTransformer]):
+    async def manage(self, interaction: Interaction, server: app_commands.Transform[Server, utils.ServerTransformer(
+                       status=[Status.RUNNING, Status.PAUSED, Status.STOPPED])]):
         view = ServerView(server)
         embed = await view.render(interaction)
         # noinspection PyUnresolvedReferences