ENHANCEMENTS:

- Scheduler: countdown added

Author: karel26

plugins/scheduler/README.md

@@ -20,11 +20,14 @@ The main structure of the scheduler.yaml consists out of these blocks:
 
 a) DEFAULT Section
 ```yaml
-DEFAULT:                                          # the DEFAULT block is valid for ALL your servers
-  startup_delay: 10                               # delay in seconds between the startup of each DCS instance (default: 10)
-  warn:                                           # warn times before a restart / shutdown (see an alternative format below)
-    text: '!!! {item} will {what} in {when} !!!'  # Message to be displayed as a popup in DCS. These variables can be used in your own message. 
-    times:                                        # List of times when a message will be displayed
+DEFAULT:                                              # the DEFAULT block is valid for ALL your servers
+  startup_delay: 10                                   # delay in seconds between the startup of each DCS instance (default: 10)
+  warn:                                               # warn times before a restart / shutdown (see an alternative format below)
+    message: '!!! {item} will {what} in {when} !!!'   # Message to be displayed as a popup in DCS. These variables can be used in your own message. 
+    countdown:                                        # Optional: Send a countdown
+      time: 10                                        # ... 10 seconds before shutdown
+      message: '!!! {item} will {what} in {when} !!!' # Optional: Message to be sent (default: warn/message)
+    times:                                            # List of times when a message will be displayed
     - 600
     - 300
     - 60

plugins/scheduler/commands.py

@@ -90,12 +90,18 @@ def change_instance_3_3(instance: dict):
                     instance['timezone'] = 'UTC'
                     action['times'] = action.pop('utc_times')
 
+        def change_instance_3_4(instance: dict):
+            if 'warn' in instance and 'text' in instance['warn']:
+                instance['warn']['message'] = instance['warn'].pop('text')
+
         if new_version == '3.1':
             change_instance = change_instance_3_1
         elif new_version == '3.2':
             change_instance = change_instance_3_2
         elif new_version == '3.3':
             change_instance = change_instance_3_3
+        elif new_version == '3.4':
+            change_instance = change_instance_3_4
         else:
             return
 
@@ -245,7 +251,7 @@ async def warn_users(self, server: Server, config: dict, rconf: dict, max_warn_t
         times: list | dict = warn.get('times', [0])
         if isinstance(times, list):
             warn_times = sorted(times, reverse=True)
-            warn_text = warn.get('text', '!!! {item} will {what} in {when} !!!')
+            warn_text = warn.get('message', '!!! {item} will {what} in {when} !!!')
         elif isinstance(times, dict):
             warn_times = sorted(times.keys(), reverse=True)
         else:
@@ -292,8 +298,26 @@ async def do_warn(warn_time: int):
             if math.ceil(i/(60 if i >= 60 else 1)) <= math.ceil(restart_in/(60 if i >= 60 else 1))
         ]
         await utils.run_parallel_nofail(*tasks)
-        # sleep until the restart should happen
-        await asyncio.sleep(min(restart_in, min(warn_times)))
+
+        if warn.get('countdown'):
+            timer = min(restart_in, min(warn_times))
+            countdown = warn['countdown'].get('time', 10)
+            warn_text = warn.get('message', warn['countdown'].get('message', 0))
+            while timer > countdown:
+                await asyncio.sleep(1)
+                timer -= 1
+            while timer != 0:
+                message = warn_text.format(item=item, what=action, when=utils.format_time(timer))
+                await server.sendPopupMessage(Coalition.ALL, message, 1)
+                await server.sendChatMessage(Coalition.ALL, message)
+                await asyncio.sleep(1)
+                timer -= 1
+
+            # sleep until the countdown should happen
+            await asyncio.sleep(min(restart_in, min(warn_times)))
+        else:
+            # sleep until the restart should happen
+            await asyncio.sleep(min(restart_in, min(warn_times)))
 
     async def teardown_dcs(self, server: Server, member: discord.Member | None = None):
         await self.bot.bus.send_to_node({"command": "onShutdown", "server_name": server.name})

plugins/scheduler/schemas/scheduler_schema.yaml

@@ -70,13 +70,18 @@ schema;element_schema:
       type: map
       nullable: false
       mapping:
-        text: {type: str, nullable: false}
+        message: {type: str, nullable: false}
         sound: {type: str, nullable: false}
         times:
           type: any
           nullable: false
           func: seq_or_map
           enum: ['warn_seq', 'warn_map']
+        countdown:
+          type: map
+          mapping:
+            time: {type: int, range: {min: 0}, nullable: false}
+            message: {type: str, nullable: false}
     schedule:
       type: map
       nullable: false

plugins/scheduler/version.py

@@ -1 +1 @@
-__version__ = "3.3"
+__version__ = "3.4"

samples/plugins/scheduler.yaml

@@ -1,8 +1,8 @@
 DEFAULT:
-  startup_delay: 10                               # delay in seconds between the startup of each DCS instance (default: 10)
-  warn:                                           # warn times before a restart / shutdown
-    text: '!!! {item} will {what} in {when} !!!'  # Message to be displayed as a popup in DCS. These variables can be used in your own message.
-    times:                                        # List of times when a message will be displayed
+  startup_delay: 10                                 # delay in seconds between the startup of each DCS instance (default: 10)
+  warn:                                             # warn times before a restart / shutdown
+    message: '!!! {item} will {what} in {when} !!!' # Message to be displayed as a popup in DCS. These variables can be used in your own message.
+    times:                                          # List of times when a message will be displayed
     - 600
     - 300
     - 60
@@ -18,7 +18,7 @@ instance2:
     00-12: YYYYYYY
     12-24: NNNNNNN
   action:                                        # at 04:00 and 08:00 LT ...
-    local_times:
+    times:
     - 04:00
     - 08:00
     method: rotate                                # .. it will rotate ..