serverwatcher 5.19__tar.gz → 5.21__tar.gz

{serverwatcher-5.19/src/serverwatcher.egg-info → serverwatcher-5.21}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: serverwatcher
-Version: 5.19
+Version: 5.21
 Summary: A HungerLib-powered Minecraft server automation engine.
 Author: iFamished
 License: GPL-3.0

{serverwatcher-5.19 → serverwatcher-5.21}/pyproject.toml

@@ -7,7 +7,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "serverwatcher"
-version = "5.19"
+version = "5.21"
 description = "A HungerLib-powered Minecraft server automation engine."
 readme = "README.md"
 requires-python = ">=3.14"

{serverwatcher-5.19 → serverwatcher-5.21}/src/serverwatcher/configclasses/config.py

@@ -11,8 +11,6 @@ class GlobalConfig:
     panel_url: str = 'panel.url'
     panel_api_key: str = 'panel.api_key'
 
-    origin_server_id: str = 'origin.server_id'
-
     server_name: str = 'server.name'
     server_id: str = 'server.server_id'
     server_domain: str = 'server.domain'
@@ -32,6 +30,7 @@ class GlobalConfig:
     error_prefix: str = 'logger.prefixes.error'
 
     clear_terminal: bool = 'terminal.enable_clearing'
+    handle_keyboard_interrupt: bool = 'terminal.handle_keyboard_interrupt'
 
 
 class fallbacks:
@@ -41,8 +40,6 @@ class fallbacks:
     panel_url = 'https://example.com'
     panel_api_key = 'CHANGE_ME'
 
-    origin_server_id = 'CHANGE_ME'
-
     server_name = 'My SMP'
     server_id = 'CHANGE_ME'
     server_domain = 'mc.example.com'
@@ -62,3 +59,4 @@ class fallbacks:
     error_prefix = '<red>[ERROR]: '
 
     clear_terminal = True
+    handle_keyboard_interrupt = True

{serverwatcher-5.19 → serverwatcher-5.21}/src/serverwatcher/configclasses/watcher.py

@@ -7,13 +7,12 @@ class WatcherConfig:
 
     watch_interval: int = 'watch_interval'
 
-    schedule_control: bool = 'schedule_control.enabled'
-    restart_soon_id: int = 'schedule_control.restart_soon_id'
-
     threshold_ram: int = 'thresholds.ram'
     threshold_cpu: int = 'thresholds.cpu'
     threshold_uptime: int = 'thresholds.uptime'
     threshold_tps: float = 'thresholds.tps'
+    threshold_min_uptime: int = 'thresholds.min_uptime'
+    threshold_low_gap: int = 'thresholds.low_gap'
 
     weight_restart_soon: int = 'weights.restart_soon'
     weight_ram: int = 'weights.ram'
@@ -27,6 +26,8 @@ class WatcherConfig:
     low_gap_minutes: int = 'gaps.low_gap_minutes'
     high_gap_minutes: int = 'gaps.high_gap_minutes'
 
+    snap_minutes: list = 'snap_minutes'
+
     restart_wait_seconds: int = 'restart.wait_seconds'
     restart_timeout: int = 'restart.online_timeout'
     restart_online_interval: int = 'restart.online_interval'
@@ -35,13 +36,12 @@ class WatcherConfig:
 class fallbacks:
     watch_interval = 300
 
-    schedule_control = False
-    restart_soon_id = 0
-
     threshold_ram = 6
     threshold_cpu = 150
     threshold_uptime = 12
     threshold_tps = 19.5
+    threshold_min_uptime = 30
+    threshold_low_gap = 2
 
     weight_restart_soon = 3
     weight_ram = 1
@@ -55,6 +55,8 @@ class fallbacks:
     low_gap_minutes = 120
     high_gap_minutes = 60
 
+    snap_minutes = [0, 30]
+
     restart_wait_seconds = 30
     restart_timeout = 120
     restart_online_interval = 2

{serverwatcher-5.19 → serverwatcher-5.21}/src/serverwatcher/defaultconfigs/config.yaml

@@ -5,9 +5,6 @@ panel:
   url: 'https://example.com'
   api_key: 'CHANGE_ME'
 
-origin:
-  server_id: 'CHANGE_ME'
-
 server:
   name: 'My SMP'
   server_id: 'CHANGE_ME'
@@ -30,4 +27,5 @@ logger:
     error: "<red>[%hh%:%mm%:%ss%] [ERROR]: "
 
 terminal:
-  enable_clearing: True
+  enable_clearing: True
+  handle_keyboard_interrupt: True

{serverwatcher-5.19 → serverwatcher-5.21}/src/serverwatcher/defaultconfigs/watcher.yaml

@@ -1,14 +1,12 @@
-watch_interval: 300
-
-schedule_control:
-  enabled: False
-  restart_soon_id: 0     # replace this with a real schedule id
+watch_interval: 300      # in seconds
 
 thresholds:
   ram: 6
   cpu: 150
   uptime: 12
   tps: 19.5
+  min_uptime: 30         # will not restart the server if the total uptime is less than 30 minutes
+  low_gap: 2
 
 weights:
   restart_soon: 3
@@ -23,6 +21,8 @@ gaps:
   low_gap_minutes: 120
   high_gap_minutes: 60
 
+snap_minutes: [0, 30]    # will snap the scheduled time to the nearest hour or half hour
+
 restart:
   wait_seconds: 30
   online_timeout: 120

serverwatcher-5.21/src/serverwatcher/validator.py

@@ -0,0 +1,218 @@
+import sys
+from dataclasses import fields
+
+from hungerlib import utils, loadConfig
+
+from serverwatcher.configclasses.config import GlobalConfig
+from serverwatcher.configclasses.messages import MessagesConfig
+from serverwatcher.configclasses.watcher import WatcherConfig
+
+
+utils.clearTerminal()
+errors = []
+warnings = []
+defaults = []
+
+
+def validate_key_types(config_obj, schema):
+    for f in fields(schema):
+        if f.name.startswith("__"):
+            continue
+
+        expected_type = f.type
+        value = getattr(config_obj, f.name, None)
+
+        # allow None (missing + no fallback) to be handled by other validators
+        if value is None:
+            continue
+
+        if not isinstance(value, expected_type):
+            errors.append(
+                f'{schema.__name__}.{f.name}: expected {expected_type.__name__}, '
+                f'got "{type(value).__name__}" ({value!r})'
+            )
+
+
+def check_field(config_obj, name, allow_fallback=True):
+    """
+    Unified check for:
+    - missing YAML key (config.raw.<name> is None)
+    - fallback usage (config.<name> == config.fallbacks.<name>)
+    - whether fallback is allowed or not
+    """
+    raw = config_obj.raw
+    fb = config_obj.fallbacks
+
+    val = getattr(config_obj, name)
+    raw_val = getattr(raw, name)
+    fb_val = getattr(fb, name)
+
+    # 1) YAML key missing
+    if raw_val is None:
+        if allow_fallback:
+            warnings.append(f'{name}: key does not exist, using fallback "{fb_val}"')
+        else:
+            errors.append(f'{name}: key does not exist and fallback is not allowed')
+        return
+
+    # 2) YAML key exists but value equals fallback
+    if val == fb_val and not allow_fallback:
+        defaults.append(f'{name}: must not be left default or empty (got "{val}")')
+
+
+def validate_global_config(config):
+    c = config
+
+    # Fallback policy:
+    # - NOT allowed (must be set by user): panel_url, panel_api_key,
+    #   server_id, server_domain, bridge_token
+    # - Allowed: everything else
+
+    # timezone
+    check_field(c, "timezone")
+    if c.timezone == "":
+        errors.append('timezone: must not be empty')
+
+    # panel
+    check_field(c, "panel_name")
+    check_field(c, "panel_url", allow_fallback=False)
+    check_field(c, "panel_api_key", allow_fallback=False)
+
+    if c.panel_url and not (c.panel_url.startswith("http://") or c.panel_url.startswith("https://")):
+        errors.append(f'panel_url: must start with "http://" or "https://" (got "{c.panel_url}")')
+
+    if c.panel_api_key and not c.panel_api_key.startswith("ptlc_"):
+        errors.append(f'panel_api_key: must be a valid Pterodactyl client API key (got "{c.panel_api_key}")')
+    if c.panel_api_key and c.panel_api_key.startswith("plta_"):
+        errors.append(f'panel_api_key: should not be an application key (got "{c.panel_api_key}")')
+
+    # server
+    check_field(c, "server_name")
+    check_field(c, "server_id", allow_fallback=False)
+    check_field(c, "server_domain", allow_fallback=False)
+    check_field(c, "server_port")
+    if c.server_domain and (c.server_domain.startswith("http://") or c.server_domain.startswith("https://")):
+        errors.append(f'server_domain: must not contain protocol (got "{c.server_domain}")')
+    if c.server_port is not None and not (1 <= c.server_port <= 65535):
+        errors.append(f'server_port: must be 1–65535 (got "{c.server_port}")')
+
+    # tps_command
+    check_field(c, "tps_command")
+
+    # hungerbridge
+    check_field(c, "bridge_token", allow_fallback=False)
+    check_field(c, "bridge_port")
+    if c.bridge_port is not None and not (1 <= c.bridge_port <= 65535):
+        errors.append(f'bridge_port: must be 1–65535 (got "{c.bridge_port}")')
+
+    # logger
+    check_field(c, "enable_logging")
+    check_field(c, "logger_name")
+    check_field(c, "log_path")
+    check_field(c, "info_prefix")
+    check_field(c, "warn_prefix")
+    check_field(c, "error_prefix")
+
+    # terminal
+    check_field(c, "clear_terminal")
+    check_field(c, "handle_keyboard_interrupt")
+
+
+def validate_watcher_config(watcherconfig):
+    c = watcherconfig
+    raw = c.raw
+    fb = c.fallbacks
+
+    # basic numeric sanity
+    if c.restart_wait_seconds <= 0:
+        errors.append(f'restart_wait_seconds: must be > 0 (got {c.restart_wait_seconds})')
+
+    if c.threshold_cpu <= 0:
+        errors.append(f'threshold_cpu: must be > 0 (got {c.threshold_cpu})')
+
+    if c.threshold_ram <= 0:
+        errors.append(f'threshold_ram: must be > 0 (got {c.threshold_ram})')
+
+    if c.threshold_tps <= 0 or c.threshold_tps > 20:
+        errors.append(f'threshold_tps: must be 1–20 (got {c.threshold_tps})')
+
+    # snap_minutes: must be a non-empty list of ints 0–59
+    if raw.snap_minutes is None:
+        warnings.append(f'snap_minutes: key does not exist, using fallback "{fb.snap_minutes}"')
+
+    if not isinstance(c.snap_minutes, list) or not c.snap_minutes:
+        errors.append(f'snap_minutes: must be a non-empty list of minute marks (got {c.snap_minutes!r})')
+    else:
+        bad = [m for m in c.snap_minutes if not isinstance(m, int) or not (0 <= m <= 59)]
+        if bad:
+            errors.append(f'snap_minutes: all values must be integers 0–59 (bad values: {bad})')
+
+
+def validate_messages_config(messages):
+    pass
+    # m = messages
+
+    # for f in fields(MessagesConfig):
+    #     if f.name.startswith("__"):
+    #         continue
+    #     value = getattr(m, f.name)
+    #     if not isinstance(value, str) or value.strip() == "":
+    #         errors.append(f'MessagesConfig.{f.name}: must be a non-empty string')
+
+
+def validate_all():
+    config = loadConfig(GlobalConfig)
+    messages = loadConfig(MessagesConfig)
+    watcherconfig = loadConfig(WatcherConfig)
+
+    # type checks
+    validate_key_types(config, GlobalConfig)
+    validate_key_types(messages, MessagesConfig)
+    validate_key_types(watcherconfig, WatcherConfig)
+
+    # semantic checks
+    validate_global_config(config)
+    validate_watcher_config(watcherconfig)
+    validate_messages_config(messages)
+
+    # if too many critical defaults, assume "not configured at all"
+    critical_default_keys = [
+        "panel_url",
+        "panel_api_key",
+        "server_id",
+        "server_domain",
+        "bridge_token",
+    ]
+    critical_defaults_used = [
+        d for d in defaults
+        if any(d.startswith(k) for k in critical_default_keys)
+    ]
+
+    if len(critical_defaults_used) >= 3:
+        print('❌ CONFIG VALIDATION FAILED:\nIt looks like you haven\'t configured this yet! Please change these defaults:')
+        for d in critical_defaults_used:
+            print(' -', d)
+        sys.exit(1)
+
+    if errors or defaults:
+        print('❌ CONFIG VALIDATION FAILED:')
+        for e in errors:
+            print(' -', e)
+        for d in defaults:
+            print(' -', d)
+        if warnings:
+            print('\nWarnings:')
+            for w in warnings:
+                print(' -', w)
+        sys.exit(1)
+
+    if warnings:
+        print('⚠️  CONFIG VALIDATION WARNINGS:')
+        for w in warnings:
+            print(' -', w)
+
+    print('✅ All configs are valid.')
+
+
+if __name__ == '__main__':
+    validate_all()

{serverwatcher-5.19 → serverwatcher-5.21}/src/serverwatcher/watcher.py

@@ -30,12 +30,6 @@ class ServerWatcher:
             api_key=self.config.panel_api_key,
         )
 
-        self.origin = servers.Generic(
-            name="Origin",
-            panel=self.panel,
-            server_id=self.config.origin_server_id
-        )
-
         self.server = servers.Minecraft(
             name=self.config.server_name,
             panel=self.panel,
@@ -72,9 +66,6 @@ class ServerWatcher:
         raise SystemExit
 
     def restart_and_wait(self):
-        if self.watcherconfig.schedule_control:
-            self.origin.disableSchedule(self.watcherconfig.restart_soon_id)
-
         self.server.restart()
         self.router.info(self.messages.restart_action_sent)
         time.sleep(self.watcherconfig.restart_wait_seconds)
@@ -93,7 +84,7 @@ class ServerWatcher:
             self.router.error(self.messages.server_failed_restart)
 
     def schedule_restart(self, minutes):
-        info = utils.snapSchedule(minimumMinutes=minutes)
+        info = utils.snapSchedule(minimumMinutes=minutes, snapMinutes=tuple(sorted(self.watcherconfig.snap_minutes)))
         scheduled = info["scheduled"]
 
         local_time = scheduled.astimezone(self.tz)
@@ -104,7 +95,8 @@ class ServerWatcher:
         minute_callbacks = {
             int(k.split("_")[1]): (
                 lambda raw=self.messages.as_map()[k]:
-                    self.router.broadcast(mapit(raw))
+                    self.router.broadcast(mapit(raw)),
+                    self.router.origin(raw)
             )
             for k in self.messages.as_map()
             if k.startswith("minute_")
@@ -113,17 +105,14 @@ class ServerWatcher:
         second_callbacks = {
             int(k.split("_")[1]): (
                 lambda raw=self.messages.as_map()[k]:
-                    self.router.broadcast(mapit(raw))
+                    self.router.broadcast(mapit(raw)),
+                    self.router.origin(raw)
             )
             for k in self.messages.as_map()
             if k.startswith("second_")
         }
 
-        utils.runCountdownEvents(
-            target_time=scheduled,
-            minute_callbacks=minute_callbacks,
-            second_callbacks=second_callbacks,
-        )
+        utils.runCountdownEvents(target_time=scheduled, minute_callbacks=minute_callbacks, second_callbacks=second_callbacks)
 
     def evaluate(self):
         # Lets Pterodactyl know the server is online, then clears terminal and uses user-defined startup key
@@ -145,10 +134,6 @@ class ServerWatcher:
         restart_reasons = []
         no_restart_reasons = []
 
-        if self.watcherconfig.schedule_control and self.server.getSchedule(self.watcherconfig.restart_soon_id)["is_active"]:
-            restart_reasons.append(self.messages.reason_restart_soon)
-            pro += self.watcherconfig.weight_restart_soon
-
         if snap.ram >= self.watcherconfig.threshold_ram:
             restart_reasons.append(mapit(self.messages.reason_ram, ram=snap.ram, threshold=self.watcherconfig.threshold_ram))
             pro += int(round(snap.ram, 0) - (self.watcherconfig.threshold_ram - 1))
@@ -167,7 +152,7 @@ class ServerWatcher:
             restart_reasons.append(mapit(self.messages.reason_tps, tps=snap.tps, threshold=self.watcherconfig.threshold_tps))
             pro += self.watcherconfig.weight_tps
 
-        if snap.uptime // 60 < 30:
+        if snap.uptime // 60 < self.watcherconfig.threshold_min_uptime:
             no_restart_reasons.append(mapit(self.messages.reason_low_uptime, uptime=snap.uptime_formatted))
             anti += self.watcherconfig.weight_low_uptime
 
@@ -203,7 +188,7 @@ class ServerWatcher:
 
         self.router.info(self.messages.scheduled)
 
-        if gap <= 2:
+        if gap <= self.watcherconfig.threshold_low_gap:
             self.router.warn(self.messages.gap_low, gap=gap)
             self.schedule_restart(self.watcherconfig.low_gap_minutes)
         else:
@@ -213,13 +198,18 @@ class ServerWatcher:
         self.restart_and_wait()
 
     def run(self):
-        try:
-            if self.config.clear_terminal:
-                utils.clearTerminal()
+        if self.config.handle_keyboard_interrupt:
+            try:
+                while True:
+                    if self.config.clear_terminal:
+                        utils.clearTerminal()
+                    self.evaluate()
+                    time.sleep(self.watcherconfig.watch_interval)
+            except KeyboardInterrupt:
+                self.shutdown()
+        else:
             while True:
                 if self.config.clear_terminal:
                     utils.clearTerminal()
                 self.evaluate()
                 time.sleep(self.watcherconfig.watch_interval)
-        except KeyboardInterrupt:
-            self.shutdown()

{serverwatcher-5.19 → serverwatcher-5.21/src/serverwatcher.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: serverwatcher
-Version: 5.19
+Version: 5.21
 Summary: A HungerLib-powered Minecraft server automation engine.
 Author: iFamished
 License: GPL-3.0

serverwatcher-5.19/src/serverwatcher/validator.py

@@ -1,139 +0,0 @@
-import sys
-from dataclasses import fields
-from hungerlib import utils, loadConfig
-
-from serverwatcher.configclasses.config import GlobalConfig
-from serverwatcher.configclasses.messages import MessagesConfig
-from serverwatcher.configclasses.watcher import WatcherConfig
-
-utils.clearTerminal()
-
-def deep_get_attr(obj, dotted):
-    parts = dotted.split('.')
-    cur = obj
-    for p in parts:
-        if not hasattr(cur, p):
-            return None
-        cur = getattr(cur, p)
-    return cur
-
-def validate_type(name, value, expected_type, errors):
-    if not isinstance(value, expected_type):
-        errors.append(f'{name}: expected {expected_type.__name__}, got {type(value).__name__}')
-
-def validate_positive(name, value, errors):
-    if isinstance(value, (int, float)) and value < 0:
-        errors.append(f'{name}: must be >= 0 (got {value})')
-
-def validate_nonempty(name, value, errors):
-    if isinstance(value, str) and value.strip() == '':
-        errors.append(f'{name}: cannot be empty')
-
-def validate_dataclass(config_obj, schema, errors):
-    for f in fields(schema):
-        name = f.name
-        expected_type = f.type
-        value = deep_get_attr(config_obj, name)
-
-        validate_type(name, value, expected_type, errors)
-
-        if expected_type is str:
-            validate_nonempty(name, value, errors)
-
-        if expected_type in (int, float):
-            validate_positive(name, value, errors)
-
-def validate_global_config(config, errors):
-    if config.server_port <= 0 or config.server_port > 65535:
-        errors.append(f'server_port: must be 1–65535 (got {config.server_port})')
-
-    if config.bridge_port <= 0 or config.bridge_port > 65535:
-        errors.append(f'bridge_port: must be 1–65535 (got {config.bridge_port})')
-
-def validate_watcher_config(watcherconfig, errors):
-    if watcherconfig.restart_wait_seconds < 1:
-        errors.append(f'restart_wait_seconds: must be >= 1 (got {watcherconfig.restart_wait_seconds})')
-
-    if watcherconfig.threshold_cpu <= 0:
-        errors.append(f'threshold_cpu: must not be less than 1 (got {watcherconfig.threshold_cpu})')
-
-    if watcherconfig.threshold_ram <= 0:
-        errors.append(f'threshold_ram: must be > 0 (got {watcherconfig.threshold_ram})')
-
-    if watcherconfig.threshold_tps <= 0 or watcherconfig.threshold_tps > 20:
-        errors.append(f'threshold_tps: must be 1–20 (got {watcherconfig.threshold_tps})')
-
-def validate_messages_config(messages, errors):
-    for f in fields(MessagesConfig):
-        value = getattr(messages, f.name)
-        if isinstance(value, str) and '{prefix}' not in value:
-            pass
-
-
-# fallback detection
-def ensure_no_global_defaults(config, defaults):
-    fb = config.fallbacks
-
-    if config.panel_url == fb.panel_url:
-        defaults.append('panel_url')
-
-    if config.panel_api_key == fb.panel_api_key:
-        defaults.append('panel_api_key')
-
-    if config.origin_server_id == fb.origin_server_id:
-        defaults.append('origin_server_id')
-
-    if config.server_id == fb.server_id:
-        defaults.append('server_id')
-
-    if config.server_domain == fb.server_domain:
-        defaults.append('server_domain')
-
-    if config.bridge_token == fb.bridge_token:
-        defaults.append('bridge_token')
-
-def ensure_no_watcher_defaults(watcherconfig, defaults):
-    fb = watcherconfig.fallbacks
-
-    if watcherconfig.schedule_control and watcherconfig.restart_soon_id == fb.restart_soon_id:
-        defaults.append('restart_soon_id')
-
-# main validation entrypoint
-def validate_all():
-    errors = []
-    defaults = []
-
-    config = loadConfig(GlobalConfig)
-    messages = loadConfig(MessagesConfig)
-    watcher = loadConfig(WatcherConfig)
-
-    validate_dataclass(config, GlobalConfig, errors)
-    validate_dataclass(messages, MessagesConfig, errors)
-    validate_dataclass(watcher, WatcherConfig, errors)
-
-    validate_global_config(config, errors)
-    validate_messages_config(messages, errors)
-    validate_watcher_config(watcher, errors)
-
-    ensure_no_global_defaults(config, defaults)
-    ensure_no_watcher_defaults(watcher, defaults)
-
-    if len(defaults) >= 5:
-        print('❌ CONFIG VALIDATION FAILED:\nIt looks like you haven\'t configured this yet! Please change these defaults:')
-        for d in defaults:
-            print(' -', d)
-        sys.exit(1)
-
-    if errors or defaults:
-        print('❌ CONFIG VALIDATION FAILED:')
-        for e in errors:
-            print(' -', e)
-        for d in defaults:
-            print(' -', d, ': must not be left default')
-        sys.exit(1)
-
-    print('✅ All configs are valid.')
-
-
-if __name__ == '__main__':
-    validate_all()