Merge branch 'development'

Author: karel26

README.md

@@ -45,7 +45,7 @@ Discord commands, like the Music service. Some services only run on the master n
 
 | Service     | Scope                                                                                                     | Plugin      | Documentation                             |
 |:------------|:----------------------------------------------------------------------------------------------------------|:------------|:------------------------------------------|
-| Backup      | Backup your bot- and DCS-configuration, your missions, database, etc.                                     | Backup      | [README](./services/backup/README.md)     |
+| Backup      | Backup and restore your bot- and DCS-configuration, your missions, database, etc.                         | Backup      | [README](./services/backup/README.md)     |
 | Bot         | The Discord bot handling all discord commands. There is a Discord-free variant available also (see blow)! |             | [README](./services/bot/README.md)        |
 | Cleanup     | Cleanup log-files, track-files, etc. from your disk.                                                      |             | [README](./services/cleanup/README.md)    |
 | Cron        | Schedule tasks based on a cron-like configuration.                                                        |             | [README](./services/cron/README.md)       |
@@ -73,7 +73,7 @@ from time to time, but you as a community member can also create your own plugin
 | Cloud         | Cloud-based statistics and connection to the [DGSA](#dgsa) global ban system.                   | yes[^1]  | Userstats                             | [README](./plugins/cloud/README.md)         |
 | MissionStats  | Detailed users statistics / mission statistics.                                                 | yes[^1]  | Userstats                             | [README](./plugins/missionstats/README.md)  |
 | Monitoring    | Monitoring and statistics for your DCS servers.                                                 | yes[^1]  | Userstats                             | [README](plugins/monitoring/README.md)      |
-| Backup        | Create a backup of your database, server or bot configurations.                                 |   yes    |                                       | [README](./plugins/backup/README.md)        |
+| Backup        | Backup or restore your database, server or bot configurations.                                  |   yes    |                                       | [README](./plugins/backup/README.md)        |
 | Battleground  | Support for [DCS Battleground](https://github.com/Frigondin/DCSBattleground)                    |   yes    |                                       | [README](./plugins/battleground/README.md)  |
 | Battleground2 | Support for the new version of [DCS Battleground](https://github.com/Frigondin/DCSBattleground) |   yes    |                                       | [README](./plugins/battleground2/README.md) |
 | Commands      | Create custom discord commands.                                                                 |   yes    |                                       | [README](./plugins/commands/README.md)      |
@@ -88,6 +88,7 @@ from time to time, but you as a community member can also create your own plugin
 | Music         | Upload and play music over SRS.                                                                 |   yes    |                                       | [README](./plugins/music/README.md)         |
 | ModManager    | Install or update mods into your DCS server.                                                    |   yes    |                                       | [README](./plugins/modmanager/README.md)    |
 | Pretense      | Commands for Pretense missions.                                                                 |   yes    |                                       | [README](./plugins/pretense/README.md)      |
+| Profiler      | Attaches LUA profilers to DCS (WIP).                                                            |   yes    |                                       | [README](./plugins/profiler/README.md)      |
 | Punishment    | Punish users for team-hits or team-kills.                                                       |   yes    | Mission                               | [README](./plugins/punishment/README.md)    |
 | RealWeather   | Apply real weather to your missions (also available as an extension).                           |   yes    |                                       | [README](./plugins/realweather/README.md)   |
 | RestAPI       | Simple REST-API to query users and statistics (WIP).                                            |   yes    | Userstats, MissionStats               | [README](./plugins/restapi/README.md)       |
@@ -152,8 +153,10 @@ You need the following software to run DCSServerBot:
 You need to have [Python](https://www.python.org/downloads/) 3.10 - 3.13 installed. 
 Please make sure that you tick "Add python.exe to PATH" during your Python installation.
 
-> [!IMPORTANT]
-> Python 3.14 does not work yet, despite listed differently in the changelog.
+> [!WARNING]
+> Pythong 3.14 is still very new and many third-party libraries are either not yet or not fully supported yet.
+> The bot should install with 3.14 though, but you can not expect the same performance as with 3.13 yet.
+> That said - use 3.14 on your own risk.
 
 #### b) PostgreSQL
 DCSServerBot needs a database to store information in. I decided to use [PostgreSQL](https://www.postgresql.org/download/), as it has great performance
@@ -200,9 +203,10 @@ you can now install DCSServerBot without the need to use Discord. Select the res
 installation, and you will install a variant that works without.
 
 > [!NOTE]
-> Please keep in mind that DCSServerBot was originally built for Discord and that there are some functionalities that
-> only work with Discord, like statistics graphs, greenieboards, and others.<br>
-> You can still use a lot without Discord as in-game chat-commands, automated restarts, etc.
+> It's important to note that DCSServerBot was initially designed for integration with Discord, and certain features 
+> only function properly within that platform, such as statistics graphs, greenieboards, and others. 
+> However, many aspects of the bot can still be used without Discord, including in-game chat commands, automated 
+> restarts, etc.
 
 ### Download
 Best is to use ```git clone https://github.com/Special-K-s-Flightsim-Bots/DCSServerBot.git``` as you then always have 
@@ -415,7 +419,6 @@ NODENAME:                       # this will usually be your hostname
           host: 127.0.0.1       # SRS servers local IP (default is 127.0.0.1)
           port: 5002            # SRS servers local port (default is 5002). The bot will change this in your SRS configuration if set here!
           autostart: true       # this will autostart your DCS server with the DCS server start (default: true)
-          autoupdate: true      # This will auto-update your SRS servers. Default is false, you need to run the bot as Administrator to make it work!
         Tacview:
           show_passwords: false # If you don't want to show the Tacview passwords (default: true)
 #    instance2:                 # you can have an unlimited number of instance configurations, but each instance has to have a physical representation on your disk.
@@ -435,10 +438,10 @@ DEFAULT:
   messages:                     # General messages for servers. You can overwrite any in any server.
     greeting_message_members: "{player.name}, welcome back to {server.name}!"
     greeting_message_unmatched: '{player.name}, please use /linkme in our Discord, if you want to see your user stats!'
-    message_player_username: Your player name contains invalid characters. # Default message for players with invalid usernames
-      Please change your name to join our server.
-    message_player_default_username: Please change your default player name at the top right  # Default message for players with default usernames
-      of the multiplayer selection list to an individual one!
+    message_player_username: Your player name contains invalid characters. 
+      Please change your name to join our server. # Default message for players with invalid usernames
+    message_player_default_username: Please change your default player name at the top right  
+      of the multiplayer selection list to an individual one! # Default message for players with default usernames
     message_player_inappropriate_username: Your username is inappropriate and needs to be changed to join this server.
     message_ban: 'You are banned from this server. Reason: {}' # default message, if a player is banned on the DCS server
     message_reserved: 'This server is locked for specific users.\nPlease contact a server admin.' # Message if server requires discord role (optional)
@@ -713,6 +716,29 @@ 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 backup and restore functionality are accessible in the Backup [service](./services/backup/README.md) 
+and [plugin](./plugins/backup/README.md).
+
+> [!NOTE]
+> The bot includes an auto-restore feature that allows you to easily transfer your data. 
+> To use this feature, copy the appropriate backup file into a folder named restore within the DCSServerBot 
+> installation directory (make sure to create it first). Upon startup, DCSServerBot will read this file and restore any 
+> saved information such as:
+> * Database backup
+> * DCSServerBot configuration backup
+> * Instance backup (including missions and configurations; for details, see the backup service)
+
+> [!TIP]
+> Utilizing the auto-restore feature can be helpful when moving your database from one computer to another. 
+> After installing DCSServerBot on the new system, place the appropriate db_*.tar file in a `restore` folder within the 
+> bot's installation directory and ensure the node's nodes.yaml file points to the newly created database. 
+> Then launch the bot and allow the restoration process to complete.
+> 
+> _Please be prepared to provide the new PostgreSQL master password when prompted._
+---
+
 ## How to use DCSServerBot in Missions?
 
 ### How to talk to the Bot from inside Missions

Scripts/net/DCSServerBot/DCSServerBot.lua

@@ -34,7 +34,7 @@ end
 
 dcsbot.sendBotTable = dcsbot.sendBotTable or function (tbl, channel)
 	tbl.server_name = cfg.name
-	tbl.channel = channel or "-1"
+	tbl.channel = tostring(channel or "-1")
 	socket.try(dcsbot.UDPSendSocket:sendto(net.lua2json(tbl), config.BOT_HOST, config.BOT_PORT))
 end
 

Scripts/net/DCSServerBot/DCSServerBotUtils.lua

@@ -33,7 +33,7 @@ function sendBotTable(tbl, channel)
 		server_name = loadSettingsRaw().name
 	end
 	tbl.server_name = server_name
-	tbl.channel = channel or "-1"
+	tbl.channel = tostring(channel or "-1")
 	socket.try(UDPSendSocket:sendto(net.lua2json(tbl), config.BOT_HOST, config.BOT_PORT))
 end
 

core/commandline.py

@@ -19,12 +19,14 @@
         parser.add_argument('-n', '--node', help='Node name', default=platform.node())
         parser.add_argument('-x', '--noupdate', action='store_true', help='Do not autoupdate')
         parser.add_argument('-s', '--secret', action='store_true', help='Reveal all stored passwords')
+        parser.add_argument('-a', '--restarted', action='store_true', help='Indicates if the bot was restarted')
     elif program == 'update.py':
         parser.add_argument('-n', '--node', help='Node name', default=platform.node())
         parser.add_argument('-r', '--no-restart', action='store_true', default=False,
                             help="don't start DCSServerBot after the update")
         parser.add_argument('-i', '--install', action='store_true', default=False,
                             help='Install requirements.txt only')
+        parser.add_argument('-a', '--restarted', action='store_true', help='Indicates if the bot was restarted')
     elif program == 'install.py':
         parser.add_argument('-n', '--node', help='Node name', default=platform.node())
         parser.add_argument('-u', '--user', help='Database username', default='dcsserverbot')
@@ -33,6 +35,8 @@
         parser.add_argument('-m', '--mizfile', help='Mission to patch', required=True)
         parser.add_argument('-p', '--preset', help='Preset to use, can be comma-separated')
         parser.add_argument('-f', '--presets-file', help='Presets file', default='presets.yaml')
+    elif program == 'recover.py':
+        parser.add_argument('-n', '--node', help='Node name', default=platform.node())
     elif program == 'testdriver.py':
         parser.add_argument('-n', '--node', help='Node name', default='TestNode')
     COMMAND_LINE_ARGS = parser.parse_args()

core/data/const.py

@@ -4,7 +4,9 @@
     "Side",
     "Status",
     "Coalition",
-    "Channel"
+    "Channel",
+    "PortType",
+    "Port",
 ]
 
 
@@ -44,3 +46,42 @@ class Channel(Enum):
     COALITION_BLUE_EVENTS = 'blue_events'
     COALITION_RED_CHAT = 'red'
     COALITION_RED_EVENTS = 'red_events'
+
+
+class PortType(Enum):
+    TCP = 'tcp'
+    UDP = 'udp'
+    BOTH = 'tcp+udp'
+
+
+class Port:
+
+    def __init__(self, port: int, typ: PortType, *, public: bool = False):
+        self.port = port
+        self.typ = typ
+        self.public = public
+
+    def __repr__(self):
+        return f'{self.port}/{self.typ.value}'
+
+    def __str__(self):
+        return str(self.port)
+
+    def __int__(self):
+        return self.port
+
+    def __index__(self):
+        return self.port
+
+    def __hash__(self):
+        return hash(self.port)
+
+    def __eq__(self, other):
+        if isinstance(other, Port):
+            return self.port == other.port
+        elif isinstance(other, int):
+            return self.port == other
+        return False
+
+    def type(self):
+        return self.typ

core/data/dataobject.py

@@ -2,6 +2,7 @@
 
 import logging
 
+from abc import ABC
 from configparser import ConfigParser
 from dataclasses import dataclass, field
 from typing import TYPE_CHECKING, Callable, Type, TypeVar, Generic, ClassVar, Any
@@ -18,7 +19,7 @@
 
 
 @dataclass
-class DataObject:
+class DataObject(ABC):
     name: str
     node: Node = field(compare=False, repr=False)
     pool: ConnectionPool = field(compare=False, repr=False, init=False)
@@ -36,6 +37,11 @@ def __post_init__(self):
     def __hash__(self):
         return hash(self.name)
 
+    def __eq__(self, other):
+        if isinstance(other, DataObject):
+            return self.name == other.name
+        return False
+
 
 T = TypeVar("T", bound=DataObject)
 

core/data/impl/instanceimpl.py

@@ -9,6 +9,7 @@
 from core.utils.helper import SettingsDict
 from dataclasses import dataclass
 from typing import TYPE_CHECKING
+from typing_extensions import override
 
 if TYPE_CHECKING:
     from core import Server
@@ -20,6 +21,7 @@
 @DataObjectFactory.register()
 class InstanceImpl(Instance):
 
+    @override
     def __post_init__(self):
         super().__post_init__()
         self.is_remote = False
@@ -57,8 +59,7 @@ def __post_init__(self):
 #            dirty |= True
         if dirty:
             autoexec.net = net
-
-        server_name = None
+        self._server_name = None
         settings_path = os.path.join(self.home, 'Config', 'serverSettings.lua')
         if os.path.exists(settings_path):
             settings = SettingsDict(self, settings_path, root='cfg')
@@ -67,25 +68,33 @@ def __post_init__(self):
                 settings['port'] = dcs_port
             else:
                 self.locals['dcs_port'] = settings.get('port', 10308)
-            server_name = settings.get('name', 'DCS Server') if settings else None
-            if server_name == 'n/a':
-                server_name = None
-        self.update_instance(server_name)
+            self._server_name = settings.get('name', 'DCS Server') if settings else None
+            if self._server_name == 'n/a':
+                self._server_name = None
+        self.update_instance()
+
+    @property
+    def server_name(self) -> str:
+        if self.server:
+            return self.server.name
+        else:
+            return self._server_name
 
-    def update_instance(self, server_name: str | None = None):
+    def update_instance(self):
         try:
             with self.pool.connection() as conn:
                 with conn.transaction():
                     conn.execute("""
-                        INSERT INTO instances (node, instance, port, server_name)
-                        VALUES (%s, %s, %s, %s) 
+                        INSERT INTO instances (node, instance, port)
+                        VALUES (%s, %s, %s) 
                         ON CONFLICT (node, instance) DO UPDATE 
-                        SET port=excluded.port, server_name=excluded.server_name 
-                    """, (self.node.name, self.name, self.locals.get('bot_port', 6666), server_name))
+                        SET port=excluded.port 
+                    """, (self.node.name, self.name, self.locals.get('bot_port', 6666)))
         except psycopg.errors.UniqueViolation:
             self.log.error(f"bot_port {self.locals.get('bot_port', 6666)} is already in use on node {self.node.name}!")
             raise
 
+    @override
     @property
     def home(self) -> str:
         return os.path.expandvars(self.locals.get('home', os.path.join(SAVED_GAMES, self.name)))
@@ -98,6 +107,7 @@ def update_server(self, server: Server | None = None):
                     WHERE node = %s AND instance = %s
                 """, (server.name if server and server.name != 'n/a' else None, self.node.name, self.name))
 
+    @override
     def set_server(self, server: Server | None):
         if self._server and self._server.status not in [Status.UNREGISTERED, Status.SHUTDOWN]:
             raise InstanceBusyError()
@@ -107,12 +117,12 @@ def set_server(self, server: Server | None):
             settings_path = os.path.join(self.home, 'Config', 'serverSettings.lua')
             if os.path.exists(settings_path):
                 os.remove(settings_path)
-        self.prepare()
+        self._prepare()
         if server and server.name:
             server.instance = self
         self.update_server(server)
 
-    def prepare(self):
+    def _prepare(self):
         if 'DCS' not in self.node.locals:
             return
         # desanitisation of Slmod (if there)