lockbot 2.7.1__tar.gz → 2.9.0__tar.gz

{lockbot-2.7.1/python/lockbot.egg-info → lockbot-2.9.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: lockbot
-Version: 2.7.1
+Version: 2.9.0
 Summary: Cluster resource management bot for IM platforms
 Author-email: Jianbang Yang <yangjianbang112@gmail.com>
 License: MIT

{lockbot-2.7.1 → lockbot-2.9.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "lockbot"
-version = "2.7.1"
+version = "2.9.0"
 description = "Cluster resource management bot for IM platforms"
 readme = "README.md"
 license = {text = "MIT"}

{lockbot-2.7.1 → lockbot-2.9.0}/python/lockbot/backend/app/bots/router.py

@@ -127,6 +127,33 @@ def _normalize_cluster_configs(cc):
     return cc
 
 
+def _get_node_keys(cc) -> set:
+    """Extract node key set from cluster_configs (any format)."""
+    if _is_device_array_format(cc):
+        return {item["node_key"] for item in cc}
+    if isinstance(cc, dict):
+        return set(cc.keys())
+    if isinstance(cc, list):
+        return set(cc)
+    return set()
+
+
+def _validate_node_aliases(config_overrides, cluster_configs):
+    """Raise HTTPException if NODE_ALIASES contains keys not in cluster_configs."""
+    if not config_overrides:
+        return
+    aliases = config_overrides.get("NODE_ALIASES")
+    if not aliases:
+        return
+    valid_keys = _get_node_keys(cluster_configs)
+    invalid = set(aliases.keys()) - valid_keys
+    if invalid:
+        raise HTTPException(
+            status_code=422,
+            detail=f"NODE_ALIASES contains keys not in cluster_configs: {sorted(invalid)}",
+        )
+
+
 def _device_dict_to_array(d: dict) -> list:
     """Convert DEVICE cluster_configs from dict to ordered array for API response.
 
@@ -214,6 +241,8 @@ def create_bot(
     if body.bot_type.upper() not in VALID_BOT_TYPES:
         raise HTTPException(status_code=422, detail=f"Invalid bot_type, must be one of {VALID_BOT_TYPES}")
 
+    _validate_node_aliases(body.config_overrides, body.cluster_configs)
+
     exists = (
         db.query(Bot)
         .filter(
@@ -349,6 +378,11 @@ def update_bot(
     if user.role != "super_admin" and bot.user_id != user.id:
         raise HTTPException(status_code=403, detail="Cannot edit another user's bot")
 
+    # Validate NODE_ALIASES keys against cluster_configs
+    if body.config_overrides and body.config_overrides.get("NODE_ALIASES"):
+        cc = body.cluster_configs if body.cluster_configs is not None else json.loads(bot.cluster_configs)
+        _validate_node_aliases(body.config_overrides, cc)
+
     changes = {}
     if body.name is not None:
         # Check for duplicate name (excluding current bot and deleted bots)

{lockbot-2.7.1 → lockbot-2.9.0}/python/lockbot/backend/app/bots/schemas.py

@@ -53,6 +53,21 @@ def _validate_config_overrides(v: dict | None) -> dict | None:
             if not (lo <= val <= hi):
                 errors.append(f"{key} must be between {lo} and {hi}")
 
+    whitelist = v.get("DURATION_WHITELIST")
+    if whitelist is not None and (not isinstance(whitelist, list) or not all(isinstance(u, str) for u in whitelist)):
+        errors.append("DURATION_WHITELIST must be a list of strings")
+
+    node_aliases = v.get("NODE_ALIASES")
+    if node_aliases is not None and (
+        not isinstance(node_aliases, dict)
+        or not all(isinstance(k, str) and isinstance(a, str) and len(a) <= 15 for k, a in node_aliases.items())
+    ):
+        errors.append("NODE_ALIASES must be a dict of {string: string} with alias length <= 15")
+
+    show_alias = v.get("SHOW_NODE_ALIAS")
+    if show_alias is not None and not isinstance(show_alias, bool):
+        errors.append("SHOW_NODE_ALIAS must be a boolean")
+
     max_dur = v.get("MAX_LOCK_DURATION")
     default_dur = v.get("DEFAULT_DURATION")
     if isinstance(max_dur, int) and isinstance(default_dur, int) and max_dur != -1 and default_dur > max_dur:

{lockbot-2.7.1 → lockbot-2.9.0}/python/lockbot/core/base_bot.py

@@ -121,6 +121,25 @@ class BaseLockBot:
         """
         return self.adapter.build_reply("\u274c" + error_msg, [user_id])
 
+    @property
+    def _duration_whitelist(self):
+        return self.config.get_val("DURATION_WHITELIST") or []
+
+    def _display_node(self, node_key):
+        """Return node_key with alias suffix if SHOW_NODE_ALIAS is enabled."""
+        if not self.config.get_val("SHOW_NODE_ALIAS"):
+            return node_key
+        aliases = self.config.get_val("NODE_ALIASES") or {}
+        alias = aliases.get(node_key)
+        return f"{node_key}「{alias}」" if alias else node_key
+
+    def _whitelist_hint(self):
+        """Return whitelist hint string if BOT_OWNER is configured, else empty string."""
+        owner = self.config.get_val("BOT_OWNER")
+        if not owner:
+            return ""
+        return t("error.whitelist_hint", config=self.config, owner=owner)
+
     # ------------------------------------------------------ _msg_with_usage
     def _msg_with_usage(self, msg_key, *, node_key=None, sep="", **kwargs):
         """Return ``t(msg_key, ...) + sep + self._current_usage(node_key)``."""

{lockbot-2.7.1 → lockbot-2.9.0}/python/lockbot/core/device_bot.py

@@ -177,6 +177,7 @@ class DeviceBot(BaseLockBot):
             return error_reply
 
         max_dur = self.config.get_val("MAX_LOCK_DURATION")
+        whitelist = self._duration_whitelist
         with self._lock:
             timestamp = int(time.time())
 
@@ -193,7 +194,7 @@ class DeviceBot(BaseLockBot):
                         user_id, self._msg_with_usage("error.device_in_use_or_shared", node_key=node_key)
                     )
 
-                if max_dur > 0:
+                if max_dur > 0 and user_id not in whitelist:
                     for device in devices:
                         total_duration = duration
                         user_info = find_user_info(device["current_users"], user_id)
@@ -209,6 +210,7 @@ class DeviceBot(BaseLockBot):
                                     "error.lock_max_duration_exceeded",
                                     config=self.config,
                                     max_duration=format_duration(max_dur, config=self.config),
+                                    whitelist_hint=self._whitelist_hint(),
                                 ),
                             )
 
@@ -249,6 +251,7 @@ class DeviceBot(BaseLockBot):
             return error_reply
 
         max_dur = self.config.get_val("MAX_LOCK_DURATION")
+        whitelist = self._duration_whitelist
         with self._lock:
             timestamp = int(time.time())
             for node_key, dev_ids in zip(node_key_list, dev_ids_list, strict=True):
@@ -260,7 +263,7 @@ class DeviceBot(BaseLockBot):
                         user_id, self._msg_with_usage("error.device_exclusive_mode", node_key=node_key)
                     )
 
-                if max_dur > 0:
+                if max_dur > 0 and user_id not in whitelist:
                     for device in devices:
                         user_info = find_user_info(device["current_users"], user_id)
                         if user_info:
@@ -276,6 +279,7 @@ class DeviceBot(BaseLockBot):
                                     "error.slock_max_duration_exceeded",
                                     config=self.config,
                                     max_duration=format_duration(max_dur, config=self.config),
+                                    whitelist_hint=self._whitelist_hint(),
                                 ),
                             )
 
@@ -593,4 +597,6 @@ class DeviceBot(BaseLockBot):
         """
         Get a text description of the current cluster device usage (supports merged display and heterogeneous hints).
         """
-        return get_current_usage(node_filter, self.state.bot_state, {}, config=self.config)
+        return get_current_usage(
+            node_filter, self.state.bot_state, {}, config=self.config, display_node=self._display_node
+        )

{lockbot-2.7.1 → lockbot-2.9.0}/python/lockbot/core/device_usage_utils.py

@@ -157,7 +157,7 @@ def render_device_lines(node_status, grouped_usage, idle_groups, config=None):
     return lines
 
 
-def get_current_usage(node_filter, bot_state, monitor_status, config=None):
+def get_current_usage(node_filter, bot_state, monitor_status, config=None, display_node=None):
     """
     Get current device usage info including idle, locked, and in-use devices.
     """
@@ -169,7 +169,8 @@ def get_current_usage(node_filter, bot_state, monitor_status, config=None):
             or node_key == node_filter
             or (isinstance(node_filter, list) and node_key in node_filter)
         ):
-            usage_info += t("device_usage.node_header", config=config, node_key=node_key)
+            shown_name = display_node(node_key) if display_node else node_key
+            usage_info += t("device_usage.node_header", config=config, node_key=shown_name)
 
             grouped_usage = group_locked_devices(node_status)
             shown_indices = set()

{lockbot-2.7.1 → lockbot-2.9.0}/python/lockbot/core/i18n/en.py

@@ -27,8 +27,9 @@ MESSAGES = {
     "error.duration_must_be_positive": "Duration must be greater than 0\n",
     "error.node_in_use_or_shared": "Node is in use by others or in shared mode\n\n",
     "error.node_exclusive_mode": "Node is in exclusive mode\n\n",
-    "error.lock_max_duration_exceeded": "Note: consecutive lock cannot exceed {max_duration}\n\n",
-    "error.slock_max_duration_exceeded": "Note: consecutive slock cannot exceed {max_duration}\n\n",
+    "error.lock_max_duration_exceeded": "Note: consecutive lock cannot exceed {max_duration}\n\n{whitelist_hint}",
+    "error.slock_max_duration_exceeded": "Note: consecutive slock cannot exceed {max_duration}\n\n{whitelist_hint}",
+    "error.whitelist_hint": "To lock longer, contact @{owner} to be added to the whitelist\n\n",
     "error.node_not_requested": "You have not requested this node\n",
     "error.unrecognized_command": "❌ Unrecognized command: {command}",
     "error.unknown_error": "❌ Unknown error: {command}",
@@ -139,9 +140,9 @@ MESSAGES = {
     "notify.booking_expired_header": "⚠️ The following bookings have expired:\n",
     "notify.pending_bookings_header": "🗓️ Pending bookings:\n",
     "notify.duration_clamped": (
-        "⚠️ [Lock Duration Adjusted]\n"
+        "⚠️ [Lock Duration Adjusted]\n\n"
         "The admin has set max lock duration to {max_duration}. "
-        "Your remaining lock time has been automatically shortened.\n"
+        "Your remaining lock time has been automatically shortened.\n\n"
     ),
     # ── Help: news (inline) ──
     "help.news_header": "📢 Announcement:\n",

{lockbot-2.7.1 → lockbot-2.9.0}/python/lockbot/core/i18n/zh.py

@@ -27,8 +27,9 @@ MESSAGES = {
     "error.duration_must_be_positive": "【申请资源时间应大于0】\n",
     "error.node_in_use_or_shared": "【节点正在被他人使用或处于共享状态】\n\n",
     "error.node_exclusive_mode": "【节点正处于独占状态】\n\n",
-    "error.lock_max_duration_exceeded": "【注意: 目前禁止连续lock超过{max_duration}】\n\n",
-    "error.slock_max_duration_exceeded": "【注意: 目前禁止连续slock超过{max_duration}】\n\n",
+    "error.lock_max_duration_exceeded": "【注意: 目前禁止连续lock超过{max_duration}】\n\n{whitelist_hint}",
+    "error.slock_max_duration_exceeded": "【注意: 目前禁止连续slock超过{max_duration}】\n\n{whitelist_hint}",
+    "error.whitelist_hint": "如需长期lock，请联系管理员 @{owner} 申请加入白名单\n\n",
     "error.node_not_requested": "【你并未申请过该节点资源】\n",
     "error.unrecognized_command": "❌【未识别的命令】{command}",
     "error.unknown_error": "❌【未知错误】{command}",
@@ -133,7 +134,8 @@ MESSAGES = {
     "notify.booking_expired_header": "⚠️ 以下预约已失效，请重新预约：\n",
     "notify.pending_bookings_header": "🗓️ 目前待抢锁的预约：\n",
     "notify.duration_clamped": (
-        "⚠️【锁定时长调整通知】\n管理员已将最大锁定时长调整为 {max_duration}，您的锁定剩余时长已被自动缩短，请知悉。\n"
+        "⚠️【锁定时长调整通知】\n\n"
+        "管理员已将最大锁定时长调整为 {max_duration}，您的锁定剩余时长已被自动缩短，请知悉。\n\n"
     ),
     # ── Help: news (inline) ──
     "help.news_header": "📢 公告:\n",

{lockbot-2.7.1 → lockbot-2.9.0}/python/lockbot/core/io.py

@@ -114,6 +114,7 @@ def create_or_load_device_state(config=None):
     state_filename = os.path.join(_bot_dir(config), "bot_state.json")
     cluster_configs = _cfg_get(config, "CLUSTER_CONFIGS")
     max_duration = _cfg_get(config, "MAX_LOCK_DURATION", -1)
+    duration_whitelist = _cfg_get(config, "DURATION_WHITELIST", [])
 
     default_state = {
         node_key: [
@@ -150,7 +151,7 @@ def create_or_load_device_state(config=None):
                     device_status = old_by_id[dev_id]
                     _migrate_status_fields(device_status)
                     _migrate_user_info_fields(device_status["current_users"])
-                    clamped = apply_max_duration_limit(device_status["current_users"], max_duration)
+                    clamped = apply_max_duration_limit(device_status["current_users"], max_duration, duration_whitelist)
                     clamped_user_ids.update(clamped)
                     default_device.update(**device_status)
 
@@ -175,6 +176,7 @@ def create_or_load_node_state(config=None):
     state_filename = os.path.join(_bot_dir(config), "bot_state.json")
     cluster_configs = _cfg_get(config, "CLUSTER_CONFIGS")
     max_duration = _cfg_get(config, "MAX_LOCK_DURATION", -1)
+    duration_whitelist = _cfg_get(config, "DURATION_WHITELIST", [])
 
     default_state = {
         shortname: {
@@ -202,7 +204,7 @@ def create_or_load_node_state(config=None):
             node_status.pop("fullname", None)
             _migrate_user_info_fields(node_status.get("current_users", []))
             _migrate_user_info_fields(node_status.get("booking_list", []))
-            clamped = apply_max_duration_limit(node_status.get("current_users", []), max_duration)
+            clamped = apply_max_duration_limit(node_status.get("current_users", []), max_duration, duration_whitelist)
             clamped_user_ids.update(clamped)
             default_state[node_key].update(**node_status)
 

{lockbot-2.7.1 → lockbot-2.9.0}/python/lockbot/core/node_bot.py

@@ -111,6 +111,7 @@ class NodeBot(BaseLockBot):
             return error_reply
 
         max_dur = self.config.get_val("MAX_LOCK_DURATION")
+        whitelist = self._duration_whitelist
         with self._lock:
             nodes = [self.state.bot_state[node_key] for node_key in node_keys]
             if not all(
@@ -122,7 +123,7 @@ class NodeBot(BaseLockBot):
 
             timestamp = int(time.time())
 
-            if max_dur > 0:
+            if max_dur > 0 and user_id not in whitelist:
                 for node in nodes:
                     total_duration = duration
                     user_info = find_user_info(node["current_users"], user_id)
@@ -138,6 +139,7 @@ class NodeBot(BaseLockBot):
                                 "error.lock_max_duration_exceeded",
                                 config=self.config,
                                 max_duration=format_duration(max_dur, config=self.config),
+                                whitelist_hint=self._whitelist_hint(),
                             ),
                         )
 
@@ -169,6 +171,7 @@ class NodeBot(BaseLockBot):
             return error_reply
 
         max_dur = self.config.get_val("MAX_LOCK_DURATION")
+        whitelist = self._duration_whitelist
         with self._lock:
             nodes = [self.state.bot_state[node_key] for node_key in node_keys]
             if not all(node["status"] != "exclusive" for node in nodes):
@@ -176,7 +179,7 @@ class NodeBot(BaseLockBot):
 
             timestamp = int(time.time())
 
-            if max_dur > 0:
+            if max_dur > 0 and user_id not in whitelist:
                 for node in nodes:
                     user_info = find_user_info(node["current_users"], user_id)
                     if user_info:
@@ -190,6 +193,7 @@ class NodeBot(BaseLockBot):
                             "error.slock_max_duration_exceeded",
                             config=self.config,
                             max_duration=format_duration(max_dur, config=self.config),
+                            whitelist_hint=self._whitelist_hint(),
                         )
                         return self.show_error(user_id, msg)
 
@@ -393,7 +397,7 @@ class NodeBot(BaseLockBot):
 
                                 uid = user_info["user_id"] + format_access_mode(node["status"], config=self.config)
                                 duration = format_duration(remaining_time, config=self.config)
-                                alert_info += f"{node_key} {uid}  {duration}\n"
+                                alert_info += f"{self._display_node(node_key)} {uid}  {duration}\n"
 
                         if EARLY_NOTIFY and not user_info["is_notified"] and 0 < remaining_time <= TIME_ALERT:
                             trigger_time_alert = True
@@ -403,7 +407,7 @@ class NodeBot(BaseLockBot):
 
                             uid = user_info["user_id"] + format_access_mode(node["status"], config=self.config)
                             duration = format_duration(remaining_time, config=self.config)
-                            alert_info += f"{node_key} {uid}  {duration}\n"
+                            alert_info += f"{self._display_node(node_key)} {uid}  {duration}\n"
 
                     for user_id in removed_users_id:
                         remove_user_info(node["current_users"], user_id)
@@ -449,11 +453,12 @@ class NodeBot(BaseLockBot):
             usage_info = ""
             for node_key, node_status in nodes.items():
                 if node_filter is None or node_key == node_filter:
+                    display_name = self._display_node(node_key)
                     if node_status["status"] == "idle":
-                        usage_info += "{:} {}\n".format(node_key, t("status.idle", config=self.config))
+                        usage_info += "{:} {}\n".format(display_name, t("status.idle", config=self.config))
                     else:
                         for user_idx, user_info in enumerate(node_status["current_users"]):
-                            node_name = f"{node_key}" if user_idx == 0 else ""
+                            node_name = f"{display_name}" if user_idx == 0 else ""
                             uid = user_info["user_id"] + format_access_mode(node_status["status"], config=self.config)
                             duration = format_duration(
                                 remaining_duration(user_info["start_time"], user_info["duration"]), config=self.config

{lockbot-2.7.1 → lockbot-2.9.0}/python/lockbot/core/queue_bot.py

@@ -38,6 +38,7 @@ class QueueBot(NodeBot):
             return error_reply
 
         max_dur = self.config.get_val("MAX_LOCK_DURATION")
+        whitelist = self._duration_whitelist
         with self._lock:
             nodes = [self.state.bot_state[node_key] for node_key in node_keys]
             if not all(
@@ -61,7 +62,7 @@ class QueueBot(NodeBot):
             users_to_notify = set()
             users_to_notify.add(user_id)
 
-            if max_dur > 0:
+            if max_dur > 0 and user_id not in whitelist:
                 for node in nodes:
                     booking_info = find_user_info(node["booking_list"], user_id)
                     if not command_has_duration and booking_info:
@@ -81,6 +82,7 @@ class QueueBot(NodeBot):
                                 "error.lock_max_duration_exceeded",
                                 config=self.config,
                                 max_duration=format_duration(max_dur, config=self.config),
+                                whitelist_hint=self._whitelist_hint(),
                             ),
                         )
 
@@ -130,6 +132,7 @@ class QueueBot(NodeBot):
             return error_reply
 
         max_dur = self.config.get_val("MAX_LOCK_DURATION")
+        whitelist = self._duration_whitelist
         with self._lock:
             nodes = [self.state.bot_state[node_key] for node_key in node_keys]
             if any(
@@ -140,13 +143,14 @@ class QueueBot(NodeBot):
 
             timestamp = int(time.time())
 
-            if max_dur > 0 and duration > max_dur:
+            if max_dur > 0 and user_id not in whitelist and duration > max_dur:
                 return self.show_error(
                     user_id,
                     t(
                         "error.lock_max_duration_exceeded",
                         config=self.config,
                         max_duration=format_duration(max_dur, config=self.config),
+                        whitelist_hint=self._whitelist_hint(),
                     ),
                 )
 
@@ -170,6 +174,7 @@ class QueueBot(NodeBot):
         content = t("success.take_success_by", config=self.config, user_id=user_id)
         content += self._msg_with_usage("label.before_take")
         max_dur = self.config.get_val("MAX_LOCK_DURATION")
+        whitelist = self._duration_whitelist
         with self._lock:
             nodes = [self.state.bot_state[node_key] for node_key in node_keys]
             if any(find_user_info(node["current_users"], user_id) for node in nodes):
@@ -180,13 +185,14 @@ class QueueBot(NodeBot):
             users_to_notify.add(user_id)
             nodes = [self.state.bot_state[node_key] for node_key in node_keys]
 
-            if max_dur > 0 and remaining_duration(timestamp, duration) > max_dur:
+            if max_dur > 0 and user_id not in whitelist and remaining_duration(timestamp, duration) > max_dur:
                 return self.show_error(
                     user_id,
                     t(
                         "error.lock_max_duration_exceeded",
                         config=self.config,
                         max_duration=format_duration(max_dur, config=self.config),
+                        whitelist_hint=self._whitelist_hint(),
                     ),
                 )
 

{lockbot-2.7.1 → lockbot-2.9.0}/python/lockbot/core/utils.py

@@ -71,13 +71,18 @@ def remaining_duration(start_time, duration):
     return max(duration - elapsed_duration, 0)
 
 
-def apply_max_duration_limit(user_list, max_duration):
+def apply_max_duration_limit(user_list, max_duration, whitelist=None):
     """Clamp each user's remaining duration to max_duration in place.
 
     Returns a list of user_ids whose durations were clamped.
+    Whitelist users are skipped.
     """
+    if whitelist is None:
+        whitelist = []
     clamped_users = []
     for user_info in user_list:
+        if user_info["user_id"] in whitelist:
+            continue
         final_duration = remaining_duration(user_info["start_time"], user_info["duration"])
         if max_duration > 0 and final_duration > max_duration:
             user_info["duration"] = user_info["duration"] - final_duration + max_duration

{lockbot-2.7.1 → lockbot-2.9.0/python/lockbot.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: lockbot
-Version: 2.7.1
+Version: 2.9.0
 Summary: Cluster resource management bot for IM platforms
 Author-email: Jianbang Yang <yangjianbang112@gmail.com>
 License: MIT