mcserver-cli 4.3.0__tar.gz → 4.4.0__tar.gz

{mcserver_cli-4.3.0 → mcserver_cli-4.4.0}/CHANGELOG.md

@@ -5,6 +5,19 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+
+## [4.4.0] - 2026-11-04
+
+### Added
+
+- `op remove` to remove players based on UUIDs or names
+- Player count to `whitelist list`
+
+### Fixes
+
+- Wrong description for `whitelist remove`
+- Fixing the wrong singular text in whitelist when no whitelisted player
+
 ## [4.3.0] - 2026-11-02
 
 ### Added
@@ -234,7 +247,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Better mod conflict error
 - Faster mod resolving
 
-[unreleased]: https://github.com/Othecat35/MCServer/compare/v4.3.0...HEAD
+[unreleased]: https://github.com/Othecat35/MCServer/compare/v4.4.0...HEAD
+[4.4.0]: https://github.com/Othecat35/MCServer/compare/v4.3.0...v4.4.0
 [4.3.0]: https://github.com/Othecat35/MCServer/compare/v4.2.0...v4.3.0
 [4.2.0]: https://github.com/Othecat35/MCServer/compare/v4.1.0...v4.2.0
 [4.1.0]: https://github.com/Othecat35/MCServer/compare/v4.0.0...v4.1.0

{mcserver_cli-4.3.0 → mcserver_cli-4.4.0}/NOTES.txt

@@ -390,4 +390,5 @@ it can be the default config of all your new Minecraft server derived from
 and yea
 
 
-2026-11-01, let's start not using AI?
+Ah yes... rcon, and also swrver management protocol.
+Don't forget to add a warning fof whitelist remove if the server is running to run whitelist remove

{mcserver_cli-4.3.0 → mcserver_cli-4.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: mcserver-cli
-Version: 4.3.0
+Version: 4.4.0
 Summary: A CLI tool to manage Minecraft: Java Edition servers.
 Project-URL: Homepage, https://github.com/Othecat35/MCServer
 Project-URL: Repository, https://github.com/Othecat35/MCServer.git
@@ -25,8 +25,7 @@ Supported platforms:
 - JRE (depends on Minecraft version)
 
 ## How to install
-- Using pip:
-1. Run `pip install mcserver-cli`
+- Using pip: Run `pip install mcserver-cli`
 
 - System-wide (Requires root): 
 1. Download the `mcserver` script file from GitHub releases
@@ -44,28 +43,36 @@ Supported platforms:
 ## Usage
 - Initialize a server: `mcserver init [options]`
 - List operator players: `mcserver op list`
+- Revoke operator players: `mcserver op revoke <players>`
+- Search projects: `mcserver search [query] [options]`
 - Show information about projects: `mcserver show <projects>`
 - Start the server: `mcserver start`
-- Stop the server: `mcserver stop [--force-stop]`
+- Stop the server: `mcserver stop`
 - List whitelisted players: `mcserver whitelist list`
+- Remove whitelisted players: `mcserver whitelist remove <players>`
 
-### Example
+### Examples
 - Create and start a Fabric 1.20.1 server on current directory
 ```bash
 mcserver init --game-version=1.20.1 --loader=fabric
 mcserver start
 ```
 
+- Search top 50 Fabric mods for Minecraft 1.20.1 in modrinth
+```bash
+mcserver search --loader=fabric --game-version=1.20.1 --limit=50
+```
+
 - List all operator and whitelisted players on current directory
 ```bash
 mcserver op list
 mcserver whitelist list
 ```
 
-- Stop (sigterm) a server on current directory
+- Stop a server on current directory with sigterm
 ```bash
 mcserver stop
 ```
 
 ## Note
-This is a **Personal Project**, things may be unstable.
+This is a **Personal Project** by Othecat35, so don't expect much from me :>

{mcserver_cli-4.3.0 → mcserver_cli-4.4.0}/README.md

@@ -12,8 +12,7 @@ Supported platforms:
 - JRE (depends on Minecraft version)
 
 ## How to install
-- Using pip:
-1. Run `pip install mcserver-cli`
+- Using pip: Run `pip install mcserver-cli`
 
 - System-wide (Requires root): 
 1. Download the `mcserver` script file from GitHub releases
@@ -31,28 +30,36 @@ Supported platforms:
 ## Usage
 - Initialize a server: `mcserver init [options]`
 - List operator players: `mcserver op list`
+- Revoke operator players: `mcserver op revoke <players>`
+- Search projects: `mcserver search [query] [options]`
 - Show information about projects: `mcserver show <projects>`
 - Start the server: `mcserver start`
-- Stop the server: `mcserver stop [--force-stop]`
+- Stop the server: `mcserver stop`
 - List whitelisted players: `mcserver whitelist list`
+- Remove whitelisted players: `mcserver whitelist remove <players>`
 
-### Example
+### Examples
 - Create and start a Fabric 1.20.1 server on current directory
 ```bash
 mcserver init --game-version=1.20.1 --loader=fabric
 mcserver start
 ```
 
+- Search top 50 Fabric mods for Minecraft 1.20.1 in modrinth
+```bash
+mcserver search --loader=fabric --game-version=1.20.1 --limit=50
+```
+
 - List all operator and whitelisted players on current directory
 ```bash
 mcserver op list
 mcserver whitelist list
 ```
 
-- Stop (sigterm) a server on current directory
+- Stop a server on current directory with sigterm
 ```bash
 mcserver stop
 ```
 
 ## Note
-This is a **Personal Project**, things may be unstable.
+This is a **Personal Project** by Othecat35, so don't expect much from me :>

mcserver_cli-4.4.0/src/mcserver/__init__.py

@@ -0,0 +1 @@
+__version__ = "4.4.0"

{mcserver_cli-4.3.0 → mcserver_cli-4.4.0}/src/mcserver/cli.py

@@ -224,6 +224,18 @@ def main() -> int:
 
     op_list_command.set_defaults(command_name="op_list")
 
+    # 'op revoke'
+    op_revoke_command = op_subcommands.add_parser(
+        "revoke",
+        help="Revoke operator players permission",
+        description="Revoke operator players permission.",
+    )
+
+    op_revoke_command.set_defaults(command_name="op_revoke")
+    op_revoke_command.add_argument(
+        "players", nargs="+", type=str, help="List of player names or UUIDs"
+    )
+
     # 'search' command
     search_command = commands.add_parser(
         "search",
@@ -336,11 +348,13 @@ def main() -> int:
     whitelist_remove_command = whitelist_subcommands.add_parser(
         "remove",
         help="Remove players from the whitelist",
-        description="List all whitelisted players.",
+        description="Remove players from the whitelist.",
     )
 
     whitelist_remove_command.set_defaults(command_name="whitelist_remove")
-    whitelist_remove_command.add_argument("players", nargs="+", type=str, help="List of player names or UUIDs")
+    whitelist_remove_command.add_argument(
+        "players", nargs="+", type=str, help="List of player names or UUIDs"
+    )
 
     args = parser.parse_args()
     return args.func(args)

mcserver_cli-4.4.0/src/mcserver/commands/op_list.py

@@ -0,0 +1,35 @@
+import logging
+from argparse import Namespace
+
+from ..server_files import ops
+from ..shared import pluralize
+
+logger = logging.getLogger(__name__)
+
+
+def run(args: Namespace) -> int:
+    ops_file = ops.ops_file_path
+    if not ops_file.exists():
+        logger.error(f"Operator file '{ops.ops_file_path}' not found.")
+        return 1
+
+    operator_players = ops.list_players()
+
+    player_count = len(operator_players)
+    if player_count == 0:
+        logger.info("There's no operator player.")
+        return 0
+
+    player_list: list[str] = []
+    for player in operator_players:
+        player_list.append(
+            f"{player['player_name']} ({player['player_uuid']}) Level: {player['permission_level']}"
+        )
+
+    logger.info(
+        f"There {pluralize('is', player_count)} {player_count} {pluralize('operator', player_count)}:"
+    )
+
+    player_list.sort()
+    print("\n".join(player_list))
+    return 0

mcserver_cli-4.4.0/src/mcserver/commands/op_revoke.py

@@ -0,0 +1,43 @@
+import logging
+from argparse import Namespace
+from uuid import UUID
+
+from ..server_files import ops
+from ..shared import pluralize
+
+logger = logging.getLogger(__name__)
+
+
+def run(args: Namespace) -> int:
+    player_identifiers: list[str] = args.players
+
+    player_uuids: list[UUID] = []
+    player_names: list[str] = []
+    for player in player_identifiers:
+        if len(player) > 16:
+            logger.debug(f"{player} is probably an UUID")
+            player_uuids.append(UUID(player))
+        else:
+            logger.debug(f"{player} is probably a name")
+            player_names.append(player)
+
+    removed_players = ops.remove_players(player_uuids, player_names)
+
+    player_count: int = len(removed_players)
+    if player_count == 0:
+        logger.info("No matching player found.")
+        return 0
+
+    player_list: list[str] = []
+    for player in removed_players:
+        player_list.append(
+            f"{player['player_name']} ({player['player_uuid']}) Level: {player['permission_level']}"
+        )
+
+    logger.info(
+        f"There {pluralize('is', player_count)} {player_count} operator {pluralize('player', player_count)} that {pluralize('is', player_count)} removed:"
+    )
+
+    player_list.sort()
+    print("\n".join(player_list))
+    return 0

{mcserver_cli-4.3.0 → mcserver_cli-4.4.0}/src/mcserver/commands/whitelist_list.py

@@ -1,5 +1,5 @@
-import argparse
 import logging
+from argparse import Namespace
 
 from ..server_files import whitelist
 from ..shared import pluralize
@@ -7,26 +7,26 @@ from ..shared import pluralize
 logger = logging.getLogger(__name__)
 
 
-def run(args: argparse.Namespace) -> int:
+def run(args: Namespace) -> int:
     whitelist_file = whitelist.whitelist_file_path
     if not whitelist_file.exists():
-        logger.error(f"Whitelist file ({whitelist_file}) does not exist!")
+        logger.error(f"Whitelist file ({whitelist_file}) not found!")
         return 1
 
     whitelisted_players = whitelist.list_players()
 
+    player_count: int = len(whitelisted_players)
+    if player_count == 0:
+        logger.info("There are no whitelisted player.")
+        return 0
+
     player_list: list[str] = []
     for player in whitelisted_players:
         player_list.append(f"{player['player_name']} ({player['player_uuid']})")
 
-    player_count: int = len(player_list)
-    if player_count == 0:
-        logger.info("There are no whitelisted players.")
-        return 0
-    else:
-        logger.info(
-            f"There {pluralize('is', player_count)} whitelisted {pluralize('player', player_count)}:"
-        )
+    logger.info(
+        f"There {pluralize('is', player_count)} {player_count} whitelisted {pluralize('player', player_count)}:"
+    )
 
     player_list.sort()
     print("\n".join(player_list))

{mcserver_cli-4.3.0 → mcserver_cli-4.4.0}/src/mcserver/commands/whitelist_remove.py

@@ -1,20 +1,22 @@
-import argparse
 import logging
+from argparse import Namespace
+from uuid import UUID
 
 from ..server_files import whitelist
 from ..shared import pluralize
 
 logger = logging.getLogger(__name__)
 
-def run(args: argparse.Namespace) -> int:
+
+def run(args: Namespace) -> int:
     player_identifiers: list[str] = args.players
 
-    player_uuids: list[str] = []
+    player_uuids: list[UUID] = []
     player_names: list[str] = []
     for player in player_identifiers:
         if len(player) > 16:
             logger.debug(f"{player} is probably an UUID")
-            player_uuids.append(player)
+            player_uuids.append(UUID(player))
         else:
             logger.debug(f"{player} is probably a name")
             player_names.append(player)

mcserver_cli-4.4.0/src/mcserver/server_files/ops.py

@@ -0,0 +1,114 @@
+import json
+import logging
+from collections.abc import Sequence
+from typing import TypedDict
+from uuid import UUID
+
+from ..minecraft.player_identity import normalize_player_uuid
+from .paths import ops_file_path
+
+logger = logging.getLogger(__name__)
+
+
+class OperatorPlayer(TypedDict):
+    player_uuid: UUID
+    player_name: str
+    permission_level: int
+    bypasses_player_limit: bool
+
+
+class OperatorFilePlayer(TypedDict):
+    uuid: str
+    name: str
+    level: int
+    bypassesPlayerLimit: bool
+
+
+def remove_players(
+    player_uuids: Sequence[UUID | str] | UUID | str | None = None,
+    player_names: list[str] | str | None = None,
+) -> list[OperatorPlayer]:
+    """Remove operator players that matches either by UUIDs or names
+
+    Args:
+        player_uuids: List of player UUIDs to be removed
+        player_names: List of player names to be removed
+
+    Raises:
+        ValueError: Must provide at least a player UUID or player name
+
+    Returns:
+        List of operator players that are removed"""
+    if player_uuids is None:
+        player_uuids = []
+    elif isinstance(player_uuids, (UUID, str)):
+        player_uuids = [player_uuids]
+
+    if player_names is None:
+        player_names = []
+    elif isinstance(player_names, str):
+        player_names = [player_names]
+
+    if not player_uuids and not player_names:
+        raise ValueError("Must provide at least a player UUID or player name")
+
+    names: set[str] = set(player_names)
+
+    uuids: set[UUID] = set()
+    for player_uuid in player_uuids:
+        uuids.add(normalize_player_uuid(player_uuid))
+
+    removed_players: list[OperatorPlayer] = []
+    with open(ops_file_path, mode="r+") as ops_file:
+        ops_data: list[OperatorFilePlayer] = json.load(ops_file)
+
+        new_ops_data: list[OperatorFilePlayer] = []
+        for operator_file_player in ops_data:
+            if (
+                UUID(operator_file_player["uuid"]) in uuids
+                or operator_file_player["name"] in names
+            ):
+                logger.debug(
+                    f"Operator player {operator_file_player['name']} ({operator_file_player['uuid']}) is removed"
+                )
+                operator_player: OperatorPlayer = {
+                    "player_uuid": UUID(operator_file_player["uuid"]),
+                    "player_name": operator_file_player["name"],
+                    "permission_level": operator_file_player["level"],
+                    "bypasses_player_limit": operator_file_player[
+                        "bypassesPlayerLimit"
+                    ],
+                }
+
+                removed_players.append(operator_player)
+                continue
+
+            new_ops_data.append(operator_file_player)
+
+        ops_file.seek(0)
+        json.dump(new_ops_data, ops_file, indent=2)
+        ops_file.truncate()
+
+    return removed_players
+
+
+def list_players() -> list[OperatorPlayer]:
+    """List all operator players
+
+    Returns:
+        List of operator players"""
+    logger.debug(f"Reading {ops_file_path}")
+    ops_json: list[OperatorFilePlayer] = json.loads(ops_file_path.read_text())
+
+    operator_players: list[OperatorPlayer] = []
+    for player in ops_json:
+        operator_player: OperatorPlayer = {
+            "player_uuid": UUID(player["uuid"]),
+            "player_name": player["name"],
+            "permission_level": player["level"],
+            "bypasses_player_limit": player["bypassesPlayerLimit"],
+        }
+
+        operator_players.append(operator_player)
+
+    return operator_players

{mcserver_cli-4.3.0 → mcserver_cli-4.4.0}/src/mcserver/server_files/paths.py

@@ -1,3 +1,4 @@
 from ..paths import current_dir
 
+ops_file_path = current_dir / "ops.json"
 whitelist_file_path = current_dir / "whitelist.json"

mcserver_cli-4.4.0/src/mcserver/server_files/whitelist.py

@@ -0,0 +1,102 @@
+import json
+import logging
+from collections.abc import Sequence
+from typing import TypedDict
+from uuid import UUID
+
+from ..minecraft.player_identity import normalize_player_uuid
+from .paths import whitelist_file_path
+
+logger = logging.getLogger(__name__)
+
+
+class WhitelistedPlayer(TypedDict):
+    player_uuid: UUID
+    player_name: str
+
+
+class WhitelistedFilePlayer(TypedDict):
+    uuid: str
+    name: str
+
+
+def remove_players(
+    player_uuids: Sequence[UUID | str] | UUID | str | None = None,
+    player_names: list[str] | str | None = None,
+) -> list[WhitelistedPlayer]:
+    """Remove players from the whitelist that matches either by UUIDs or names
+
+    Args:
+        player_uuids: List of player UUIDs to be removed
+        player_names: List of player names to be removed
+
+    Raises:
+        ValueError: Must provide at least a player UUID or player name
+
+    Returns:
+        List of whitelisted players that are removed"""
+    if player_uuids is None:
+        player_uuids = []
+    elif isinstance(player_uuids, (UUID, str)):
+        player_uuids = [player_uuids]
+
+    if player_names is None:
+        player_names = []
+    elif isinstance(player_names, str):
+        player_names = [player_names]
+
+    if not player_uuids and not player_names:
+        raise ValueError("Must provide at least a player UUID or player name")
+
+    names: set[str] = set(player_names)
+
+    uuids: set[UUID] = set()
+    for player_uuid in player_uuids:
+        uuids.add(normalize_player_uuid(player_uuid))
+
+    removed_players: list[WhitelistedPlayer] = []
+    with open(whitelist_file_path, mode="r+") as whitelist_file:
+        whitelist_data: list[WhitelistedFilePlayer] = json.load(whitelist_file)
+
+        new_whitelist_data: list[WhitelistedFilePlayer] = []
+        for whitelisted_file_player in whitelist_data:
+            if (
+                UUID(whitelisted_file_player["uuid"]) in uuids
+                or whitelisted_file_player["name"] in names
+            ):
+                logger.debug(
+                    f"Whitelisted player {whitelisted_file_player['name']} ({whitelisted_file_player['uuid']}) is removed"
+                )
+                whitelisted_player: WhitelistedPlayer = {
+                    "player_uuid": UUID(whitelisted_file_player["uuid"]),
+                    "player_name": whitelisted_file_player["name"],
+                }
+
+                removed_players.append(whitelisted_player)
+                continue
+
+            new_whitelist_data.append(whitelisted_file_player)
+
+        whitelist_file.seek(0)
+        json.dump(new_whitelist_data, whitelist_file, indent=2)
+        whitelist_file.truncate()
+
+    return removed_players
+
+
+def list_players() -> list[WhitelistedPlayer]:
+    logger.debug(f"Reading whitelist file {whitelist_file_path}")
+    whitelist_data: list[WhitelistedFilePlayer] = json.loads(
+        whitelist_file_path.read_text()
+    )
+
+    whitelisted_players: list[WhitelistedPlayer] = []
+    for player in whitelist_data:
+        whitelisted_player: WhitelistedPlayer = {
+            "player_uuid": UUID(player["uuid"]),
+            "player_name": player["name"],
+        }
+
+        whitelisted_players.append(whitelisted_player)
+
+    return whitelisted_players

mcserver_cli-4.3.0/src/mcserver/__init__.py

@@ -1 +0,0 @@
-__version__ = "4.3.0"

mcserver_cli-4.3.0/src/mcserver/commands/op_list.py

@@ -1,32 +0,0 @@
-from argparse import Namespace
-
-
-def run(args: Namespace) -> int:
-    import logging as log
-
-    from ..server_files import ops
-    from ..shared import pluralize
-
-    if not ops.ops_file.exists():
-        log.error(f"File '{ops.ops_file}' not found.")
-        return 1
-
-    operator_players = ops.list_players()
-
-    players: list[str] = []
-    for player in operator_players:
-        players.append(
-            f"{player['player_name']} ({player['player_uuid']}) Level: {player['permission_level']}"
-        )
-
-    players.sort()
-    sorted_players = "\n".join(players)
-
-    player_count = len(operator_players)
-    if player_count == 0:
-        log.info("There's no operator player.")
-        return 0
-
-    log.info(f"All {player_count} operator {pluralize('player', player_count)}:")
-    print(sorted_players)
-    return 0

mcserver_cli-4.3.0/src/mcserver/commands/op_revoke.py

@@ -1,9 +0,0 @@
-from argparse import Namespace
-
-
-def run(args: Namespace) -> int:
-    players: list[str] = args.players
-    import logging as log
-
-    log.error("Command is not implemented yet.")
-    return 1

mcserver_cli-4.3.0/src/mcserver/server_files/ops.py

@@ -1,143 +0,0 @@
-# Modules
-# Standard
-import json
-from pathlib import Path
-from typing import Literal, TypedDict
-from uuid import UUID
-
-# MCServer
-from mcserver.minecraft.player_identity import (
-    PlayerID,
-    PlayerUUID,
-    normalize_player_uuid,
-)
-
-# Paths
-ops_file = Path("ops.json")
-
-
-# TypedDicts
-class OperatorEntry(TypedDict):
-    uuid: str
-    name: str
-    level: Literal[0, 1, 2, 3, 4]
-    bypassesPlayerLimit: bool
-
-
-class OperatorPlayer(TypedDict):
-    player_uuid: PlayerUUID
-    player_name: str
-    permission_level: Literal[0, 1, 2, 3, 4]
-    bypasses_player_limit: bool
-
-
-# Functions
-# Add Players
-def add_player(
-    player_uuid: PlayerUUID,
-    player_name: str,
-    permission_level: Literal[0, 1, 2, 3, 4],
-    bypasses_player_limit: bool = False,
-) -> None:
-    operator_player: OperatorPlayer = {
-        "player_uuid": player_uuid,
-        "player_name": player_name,
-        "permission_level": permission_level,
-        "bypasses_player_limit": bypasses_player_limit,
-    }
-
-    add_players(operator_player)
-
-
-def add_players(operator_players: list[OperatorPlayer] | OperatorPlayer) -> None:
-    if not isinstance(operator_players, list):
-        operator_players = [operator_players]
-
-    with open(ops_file, mode="r+") as file:
-        ops_data: list[OperatorEntry] = json.load(file)
-
-        for player in operator_players:
-            permission_level = player["permission_level"]
-            if permission_level < 0 or permission_level > 4:
-                raise ValueError("Permission level must be between 0 and 4.")
-
-            operator_entry: OperatorEntry = {
-                "uuid": str(normalize_player_uuid(player["player_uuid"])),
-                "name": player["player_name"],
-                "level": permission_level,
-                "bypassesPlayerLimit": player["bypasses_player_limit"],
-            }
-
-            ops_data.append(operator_entry)
-
-        file.seek(0)
-        json.dump(ops_data, file, indent=2)
-        file.truncate()
-
-
-# Remove Players
-def remove_player(
-    player_uuid: PlayerUUID | None = None, player_name: str | None = None
-) -> None:
-    if player_uuid is None and player_name is None:
-        raise ValueError(
-            "At least one of 'player_uuid' or 'player_name' must be provided"
-        )
-
-    player_id: PlayerID = {}
-    if player_uuid is not None:
-        player_id["player_uuid"] = normalize_player_uuid(player_uuid)
-
-    if player_name is not None:
-        player_id["player_name"] = player_name
-
-    remove_players(player_id)
-
-
-def remove_players(player_ids: list[PlayerID] | PlayerID) -> None:
-    if not isinstance(player_ids, list):
-        player_ids = [player_ids]
-
-    player_uuids: set[PlayerUUID | None] = set()
-    player_names: set[str | None] = set()
-
-    for player_id in player_ids:
-        if "player_uuid" in player_id:
-            player_uuids.add(player_id["player_uuid"])
-
-        if "player_name" in player_id:
-            player_names.add(player_id["player_name"])
-
-    with open(ops_file, mode="r+") as file:
-        ops_data: list[OperatorEntry] = json.load(file)
-
-        new_ops_data: list[OperatorEntry] = []
-        for player in ops_data:
-            if player["uuid"] in player_uuids or player["name"] in player_names:
-                continue
-
-            new_ops_data.append(player)
-
-        file.seek(0)
-        json.dump(new_ops_data, file, indent=2)
-        file.truncate()
-
-
-# TODO: add 'update_player' and 'update_players', just use plain dict.update() because it has no depth
-
-
-# List Players
-def list_players() -> list[OperatorPlayer]:
-    ops_data: list[OperatorEntry] = json.loads(ops_file.read_text())
-    operator_players: list[OperatorPlayer] = []
-    for entry in ops_data:
-        operator_player: OperatorPlayer = {
-            "player_uuid": UUID(entry["uuid"]),
-            "player_name": entry["name"],
-            "permission_level": entry["level"],
-            "bypasses_player_limit": entry["bypassesPlayerLimit"],
-        }
-
-        operator_players.append(operator_player)
-
-    return operator_players

mcserver_cli-4.3.0/src/mcserver/server_files/whitelist.py

@@ -1,138 +0,0 @@
-import json
-import logging
-from typing import TypedDict
-
-from ..minecraft.player_identity import PlayerUUID
-from .paths import whitelist_file_path
-
-logger = logging.getLogger(__name__)
-
-
-class WhitelistedPlayer(TypedDict):
-    player_uuid: PlayerUUID
-    player_name: str
-
-
-class WhitelistedFilePlayer(TypedDict):
-    uuid: str
-    name: str
-
-def remove_players(player_uuids: list[str] | str | None = None, player_names: list[str] | str | None = None) -> list[WhitelistedPlayer]:
-    """Remove players from the whitelist that matches either the UUIDs or names
-    
-    Args:
-        player_uuids: List of player UUIDs to be removed
-        player_names: List of player names to be removed
-    
-    Raises:
-        ValueError: Must provide at least a player UUID or player name
-    
-    Returns:
-        List of whitelisted players that are removed"""
-    if player_uuids is None:
-        player_uuids = []
-    
-    if player_names is None:
-        player_names = []
-
-    if isinstance(player_uuids, str):
-        player_uuids = [player_uuids]
-
-    if isinstance(player_names, str):
-        player_names = [player_names]
-
-    if not player_uuids and not player_names:
-        raise ValueError("Must provide at least a player UUID or player name")
-
-    uuids: set[str] = set(player_uuids)
-    names: set[str] = set(player_names)
-
-    removed_players: list[WhitelistedPlayer] = []
-    with open(whitelist_file_path, mode="r+") as whitelist_file:
-        whitelist_data: list[WhitelistedFilePlayer] = json.load(whitelist_file)
-
-        new_whitelist_data: list[WhitelistedFilePlayer] = []
-        for whitelisted_file_player in whitelist_data:
-            if whitelisted_file_player["uuid"] in uuids or whitelisted_file_player["name"] in names:
-                logger.debug(f"Whitelisted player {whitelisted_file_player['name']} ({whitelisted_file_player['uuid']}) is removed")
-                whitelisted_player: WhitelistedPlayer = {
-                    "player_uuid": whitelisted_file_player["uuid"],
-                    "player_name": whitelisted_file_player["name"]
-                }
-
-                removed_players.append(whitelisted_player)
-                continue
-
-            new_whitelist_data.append(whitelisted_file_player)
-        
-        whitelist_file.seek(0)
-        json.dump(new_whitelist_data, whitelist_file, indent=2)
-        whitelist_file.truncate()
-
-    return removed_players
-
-
-
-# def remove_players(player_ids: list[PlayerID] | PlayerID) -> None:
-#     """Remove player entries matching the exact UUIDs or names
-
-#     Args:
-#         player_ids: Player UUIDs and/or names object
-
-#     Returns:
-#         None: Returns nothing
-
-#     Raises:
-#         FileNotFoundError: The 'whitelist.json' file not found
-#     """
-#     if not isinstance(player_ids, list):
-#         player_ids = [player_ids]
-
-#     player_uuids: set[PlayerUUID | None] = set()
-#     player_names: set[str | None] = set()
-#     for player_id in player_ids:
-#         if "player_uuid" in player_id:
-#             player_uuids.add(player_id["player_uuid"])
-
-#         if "player_name" in player_id:
-#             player_names.add(player_id["player_name"])
-
-#     if not whitelist_file.exists():
-#         raise FileNotFoundError(f"File '{whitelist_file}' is not found.")
-
-#     with open(whitelist_file, mode="r+") as file:
-#         whitelist_data: list[WhitelistFileEntry] = json.load(file)
-#         new_whitelist_data: list[WhitelistFileEntry] = []
-#         for player in whitelist_data:
-#             player_uuid = player["uuid"]
-#             player_name = player["name"]
-
-#             if player_uuid in player_uuids or player_name in player_names:
-#                 log.debug(
-#                     f"Removed player '{player_name}' ({player_uuid}) from the whitelisted player list"
-#                 )
-#                 continue
-
-#             new_whitelist_data.append(player)
-
-#         file.seek(0)
-#         json.dump(new_whitelist_data, file, indent=2)
-#         file.truncate()
-
-
-
-def list_players() -> list[WhitelistedPlayer]:
-    logger.debug(f"Reading whitelist file {whitelist_file_path}")
-    whitelist_json = whitelist_file_path.read_text()
-    whitelist_data: list[WhitelistedFilePlayer] = json.loads(whitelist_json)
-
-    whitelisted_players: list[WhitelistedPlayer] = []
-    for player in whitelist_data:
-        whitelisted_player: WhitelistedPlayer = {
-            "player_uuid": player["uuid"],
-            "player_name": player["name"],
-        }
-
-        whitelisted_players.append(whitelisted_player)
-
-    return whitelisted_players