Merge branch 'development'

Author: karel26

README.md

@@ -261,7 +261,7 @@ and database names if you want to install multiple bots for multiple Discord gro
 > If you need to rename a node, just launch `install.cmd` again with the --node parameter and give it the new name.
 > You will then get a list of existing nodes and will be asked to either add a new node or rename an existing one.
 > Select rename an `existing` one and select the node to be renamed.<br>
-> This might be necessary, if your hostname changes or you move a bot from one PC to another.
+> This might be necessary, if your hostname changes, or you move a bot from one PC to another.
 
 ### Desanitization
 DCSServerBot desanitizes your MissionScripting environment. That means it changes entries in Scripts\MissionScripting.lua
@@ -459,6 +459,13 @@ DEFAULT:
     4) ...
   accept_rules_on_join: true    # True, if rules have to be acknowledged (players will be moved to spectators otherwise, default: false)
 My Fancy Server:                # Your server name, as displayed in the server list and listed in serverSettings.lua
+  channels:
+    status: 1122334455667788    # The Discord channel to display the server status embed and players embed into. Right-click on your channel and select "Copy Channel ID". You can disable it with -1
+    chat: 8877665544332211      # The Discord channel for the in-game chat replication. You can disable it by setting it to -1.
+    events: 1928374619283746    # Optional: if you want to split game events from chat messages, you can enable an optional events channel.
+    admin: 1188227733664455     # Optional: The channel where you can fire admin commands to this server. You can decide if you want to have a central admin channel or server-specific ones. See bot.yaml for more.
+    voice: 1827364518273645     # Optional: The voice channel, where people need to connect to (mandatory if force_voice is true). 
+    audit: 9182736459182736     # Optional: a server-specific audit channel (for those of you who like channels, all others can use the global one)
   server_user: Admin            # Name of the server user #1 (technical user), default is "Admin".
   show_passwords: true          # Do you want the password to be displayed in the server status embed? (default: true)
   smooth_pause: 5               # Servers that are configured to PAUSE on startup will run for this number of seconds until they are paused again (default 0 = off)
@@ -468,19 +475,13 @@ My Fancy Server:                # Your server name, as displayed in the server l
   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!).
+  autorole: Fancy Players       # Optional: give people this role if they are online on this server (overwrites autorole/online in bot.yaml!).
+  show_atis: true               # Optional: show ATIS information on BIRTH
   force_voice: false            # Optional: enforce the usage of a voice channel (users need to be linked!) - default: false
   discord:                      # Optional: specify discord roles that are allowed to use this server
     - '@everyone'               # Attention: people cannot self-link on these servers and have to be liked properly already!
   managed_by:
     - Special Admin             # Optional: a list of Discord roles that can manage this server (default: DCS Admin)
-  channels:
-    status: 1122334455667788    # The Discord channel to display the server status embed and players embed into. Right-click on your channel and select "Copy Channel ID". You can disable it with -1
-    chat: 8877665544332211      # The Discord channel for the in-game chat replication. You can disable it by setting it to -1.
-    events: 1928374619283746    # Optional: if you want to split game events from chat messages, you can enable an optional events channel.
-    admin: 1188227733664455     # Optional: The channel where you can fire admin commands to this server. You can decide if you want to have a central admin channel or server-specific ones. See bot.yaml for more.
-    voice: 1827364518273645     # Optional: The voice channel, where people need to connect to (mandatory if force_voice is true). 
-    audit: 9182736459182736     # Optional: a server-specific audit channel (for those of you who like channels, all others can use the global one)
   chat_log:
     count: 10                   # A log file that holds the in-game chat to check for abuse. Tells how many files will be kept, default is 10.
     size: 1048576               # Max logfile size, default is 1 MB. 
@@ -717,7 +718,7 @@ In these cases, you can run the `repair.cmd` script in the DCSServerBot installa
 ---
 
 ## Backup and Restore
-The platform allows you to backup and restore your database, server configurations, or bot settings. 
+The platform allows you to back up and restore your database, server configurations, or bot settings. 
 The backup and restore functionality are accessible in the Backup [service](./services/backup/README.md) 
 and [plugin](./plugins/backup/README.md).
 

Scripts/net/DCSServerBot/DCSServerBotUtils.lua

@@ -57,6 +57,9 @@ end
 
 function saveSettings(settings)
     mergedSettings = mergeGuiSettings(settings)
+    if mergedSettings.name ~= server_name then
+        server_name = mergedSettings.name
+    end
     U.saveInFile(mergedSettings, "cfg", lfs.writedir() .. "Config/serverSettings.lua")
     return true
 end

core/const.py

@@ -10,6 +10,7 @@
     "MMHG_IN_HPA",
     "QFE_TO_QNH_INHG",
     "QFE_TO_QNH_MB",
+    "MAX_SAFE_INTEGER",
     "WEEKDAYS",
     "MONTH",
     "TRAFFIC_LIGHTS",
@@ -24,7 +25,7 @@
 MMHG_IN_HPA = 1.333224
 QFE_TO_QNH_INHG = 0.00107777777777778
 QFE_TO_QNH_MB = 0.03662667
-
+MAX_SAFE_INTEGER = 9007199254740991 # Lua 5.1 max integer representation, 2^253 - 1
 
 WEEKDAYS = {
     0: 'Mon',

core/data/const.py

@@ -12,10 +12,9 @@
 
 class Side(Enum):
     UNKNOWN = -1
-    SPECTATOR = 0
+    NEUTRAL = 0
     RED = 1
     BLUE = 2
-    NEUTRAL = 3
 
 
 class Status(Enum):
@@ -57,9 +56,9 @@ class PortType(Enum):
 class Port:
 
     def __init__(self, port: int, typ: PortType, *, public: bool = False):
-        self.port = port
-        self.typ = typ
-        self.public = public
+        self.port: int = port
+        self.typ: PortType = typ
+        self.public: bool = public
 
     def __repr__(self):
         return f'{self.port}/{self.typ.value}'
@@ -83,5 +82,5 @@ def __eq__(self, other):
             return self.port == other
         return False
 
-    def type(self):
+    def type(self) -> PortType:
         return self.typ

core/data/impl/nodeimpl.py

@@ -33,21 +33,21 @@
 from psycopg.errors import UndefinedTable, InFailedSqlTransaction, ConnectionTimeout, UniqueViolation
 from psycopg.types.json import Json
 from psycopg_pool import ConnectionPool, AsyncConnectionPool
-from typing import Awaitable, Callable, Any, cast
+from typing import Awaitable, Callable, Any
 from typing_extensions import override
 from urllib.parse import urlparse, quote
 from version import __version__
 from zoneinfo import ZoneInfo
 
 from core.autoexec import Autoexec
-from core.data.dataobject import DataObjectFactory, DataObject
+from core.data.dataobject import DataObjectFactory
 from core.data.node import Node, UploadStatus, SortOrder, FatalException
 from core.data.instance import Instance
 from core.data.impl.instanceimpl import InstanceImpl
 from core.data.server import Server
 from core.data.impl.serverimpl import ServerImpl
 from core.services.registry import ServiceRegistry
-from core.utils.helper import SettingsDict, YAMLError, cache_with_expiration
+from core.utils.helper import YAMLError, cache_with_expiration
 
 # ruamel YAML support
 from ruamel.yaml import YAML
@@ -1067,7 +1067,7 @@ async def check_nodes():
                         # The master is not alive, take over
                         elif not master or not await is_node_alive(master, config.get('heartbeat', 30)):
                             if master is not None:
-                                self.log.warning(f"The master node {master} is not responding, taking over ...")
+                                self.log.warning(f"The master node {master} is not alive, taking over ...")
                             await take_over()
                             return True
                         # Master is alive, but we are the preferred one

core/data/impl/serverimpl.py

@@ -20,6 +20,7 @@
 from contextlib import suppress
 from copy import deepcopy
 from core import utils, Server
+from core.const import MAX_SAFE_INTEGER
 from core.data.dataobject import DataObjectFactory
 from core.data.const import Status, Channel, Coalition
 from core.extension import Extension, InstallException, UninstallException
@@ -399,7 +400,7 @@ def _serialize_value(value: Any) -> Any:
             if isinstance(value, bool):
                 return value
             elif isinstance(value, int):
-                return str(value)
+                return value if value < MAX_SAFE_INTEGER else str(value)
             elif isinstance(value, Enum):
                 return value.value
             elif isinstance(value, dict):

core/data/server.py

@@ -58,6 +58,7 @@ class Server(DataObject, ABC):
     last_seen: datetime = field(compare=False, default=datetime.now(timezone.utc))
     restart_time: datetime = field(compare=False, default=None)
     idle_since: datetime | None = field(compare=False, default=None)
+    resources: dict = field(repr=False, default_factory=dict)
 
     def __post_init__(self):
         super().__post_init__()

core/pubsub.py

@@ -1,7 +1,8 @@
 import asyncio
+import zlib
 
 from contextlib import suppress
-from psycopg import sql, Connection, OperationalError, AsyncConnection
+from psycopg import sql, Connection, OperationalError, AsyncConnection, InternalError
 from typing import Callable
 
 from core.data.impl.nodeimpl import NodeImpl
@@ -23,58 +24,60 @@ def __init__(self, node: NodeImpl, name: str, url: str, handler: Callable):
         self.write_worker = asyncio.create_task(self._process_write())
 
     def create_table(self):
+        lock_key = zlib.crc32(f"PubSubDDL:{self.name}".encode("utf-8"))
+
         with Connection.connect(self.url, autocommit=True) as conn:
-            query = sql.SQL("""
-                CREATE TABLE IF NOT EXISTS {table} (
-                    id SERIAL PRIMARY KEY, 
-                    guild_id BIGINT NOT NULL, 
-                    node TEXT NOT NULL, 
-                    time TIMESTAMP NOT NULL DEFAULT (now() AT TIME ZONE 'utc'), 
-                    data JSON
-                )
-            """).format(table=sql.Identifier(self.name))
-            conn.execute(query)
-            query = sql.SQL("""
-                CREATE TABLE IF NOT EXISTS {table} (
-                    id SERIAL PRIMARY KEY, 
-                    guild_id BIGINT NOT NULL, 
-                    node TEXT NOT NULL, 
-                    time TIMESTAMP NOT NULL DEFAULT (now() AT TIME ZONE 'utc'), 
-                    data JSON
-                )
-            """).format(table=sql.Identifier(self.name))
-            conn.execute(query)
-            query = sql.SQL("""
-                CREATE OR REPLACE FUNCTION {func}()
-                RETURNS trigger
-                    AS $$
-                BEGIN
-                    PERFORM pg_notify({name}, NEW.node);
-                    RETURN NEW;
-                END;
-                $$ LANGUAGE plpgsql;
-            """).format(func=sql.Identifier(self.name + '_notify'), name=sql.Literal(self.name))
-            conn.execute(query)
-            query = sql.SQL("""
-                DO $$
-                BEGIN
-                    IF NOT EXISTS (
-                        SELECT 1
-                        FROM pg_trigger
-                        WHERE tgname = {trigger_name}
-                        AND tgrelid = {name}::regclass
-                    ) THEN
-                        CREATE TRIGGER {trigger}
-                        AFTER INSERT OR UPDATE ON {table}
-                        FOR EACH ROW
-                        EXECUTE PROCEDURE {func}();
-                    END IF;
-                END;
-                $$;
-            """).format(table=sql.Identifier(self.name), trigger=sql.Identifier(self.name + '_trigger'),
-                        func=sql.Identifier(self.name + '_notify'), name=sql.Literal(self.name),
-                        trigger_name=sql.Literal(self.name + '_trigger'))
-            conn.execute(query)
+            try:
+                conn.execute("SELECT pg_advisory_lock(%s)", (lock_key,))
+
+                query = sql.SQL("""
+                    CREATE TABLE IF NOT EXISTS {table} (
+                        id SERIAL PRIMARY KEY, 
+                        guild_id BIGINT NOT NULL, 
+                        node TEXT NOT NULL, 
+                        time TIMESTAMP NOT NULL DEFAULT (now() AT TIME ZONE 'utc'), 
+                        data JSONB
+                    )
+                """).format(table=sql.Identifier(self.name))
+                conn.execute(query)
+                query = sql.SQL("""
+                    CREATE OR REPLACE FUNCTION {func}()
+                    RETURNS trigger
+                        AS $$
+                    BEGIN
+                        PERFORM pg_notify({name}, NEW.node);
+                        RETURN NEW;
+                    END;
+                    $$ LANGUAGE plpgsql;
+                """).format(func=sql.Identifier(self.name + '_notify'), name=sql.Literal(self.name))
+                conn.execute(query)
+                query = sql.SQL("""
+                    DO $$
+                    BEGIN
+                        IF NOT EXISTS (
+                            SELECT 1
+                            FROM pg_trigger
+                            WHERE tgname = {trigger_name}
+                            AND tgrelid = {name}::regclass
+                        ) THEN
+                            CREATE TRIGGER {trigger}
+                            AFTER INSERT OR UPDATE ON {table}
+                            FOR EACH ROW
+                            EXECUTE PROCEDURE {func}();
+                        END IF;
+                    END;
+                    $$;
+                """).format(table=sql.Identifier(self.name), trigger=sql.Identifier(self.name + '_trigger'),
+                            func=sql.Identifier(self.name + '_notify'), name=sql.Literal(self.name),
+                            trigger_name=sql.Literal(self.name + '_trigger'))
+                conn.execute(query)
+
+            except InternalError as ex:
+                self.log.exception(ex)
+                raise
+            finally:
+                with suppress(Exception):
+                    conn.execute("SELECT pg_advisory_unlock(%s)", (lock_key,))
 
     async def _process_write(self):
         await asyncio.sleep(1)  # Ensure the rest of __init__ has finished
@@ -181,4 +184,4 @@ async def close(self):
         self.write_queue.put_nowait(None)
         await self.write_worker
         self.read_queue.put_nowait(None)
-        await self.read_worker
+        await self.read_worker

core/report/base.py

@@ -80,7 +80,8 @@ async def render(self, *args, **kwargs) -> ReportEnv:
         env.params['bot'] = self.bot
 
         # Create an embed with optional color
-        embed_color = getattr(discord.Color, report_def.get('color', 'blue'), discord.Color.blue)()
+        embed_color = getattr(discord.Color, utils.format_string(report_def.get('color', 'blue'), **env.params),
+                              discord.Color.blue)()
         env.embed = discord.Embed(color=embed_color)
 
         # Predefine keys that need formatting and apply transformations

core/utils/dcs.py

@@ -28,6 +28,7 @@
     "dms_to_dd",
     "dd_to_mgrs",
     "mgrs_to_dd",
+    "rad_to_heading",
     "get_active_runways",
     "create_writable_mission",
     "get_orig_file",
@@ -310,7 +311,12 @@ def mgrs_to_dd(value: str) -> tuple[float, float]:
         return ll_coords['lat'], ll_coords['lon']
 
 
-def get_active_runways(runways, wind):
+def rad_to_heading(rad: float) -> float:
+    """Return a heading in [0, 360) degrees for a radian value."""
+    return (360.0 - (rad * 180.0 / math.pi)) % 360.0
+
+
+def get_active_runways(runways: list, wind: dict):
     retval = []
     for runway in runways:
         heading = int(runway[:2]) * 10