lupaxa-chat-server 0.1.0__tar.gz

lupaxa_chat_server-0.1.0/.gitignore

@@ -0,0 +1,30 @@
+# OS
+.DS_Store
+
+# Cursor
+.cursor/
+.superpowers/
+.worktrees/
+cursor-docs
+
+# Make
+.makefiles/
+
+# MkDocs
+site/
+
+# Players
+config/players/
+
+# Python
+.venv/
+__pycache__/
+.mypy_cache/
+.ruff_cache/
+.pytest_cache/
+dist/
+build/
+*.egg-info/
+
+# SSH
+config/ssh_host_key

lupaxa_chat_server-0.1.0/LICENCE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) The Lupaxa Project
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

lupaxa_chat_server-0.1.0/PKG-INFO

@@ -0,0 +1,120 @@
+Metadata-Version: 2.5
+Name: lupaxa-chat-server
+Version: 0.1.0
+Summary: Multi-room TCP chat server.
+Project-URL: Homepage, https://github.com/lupaxa-after-hours/chat-server
+Project-URL: Documentation, https://chat-server.thelupaxaproject.org/
+Project-URL: Repository, https://github.com/lupaxa-after-hours/chat-server
+Project-URL: Issues, https://github.com/lupaxa-after-hours/chat-server/issues
+Author: The Lupaxa Project
+License: MIT License
+        
+        Copyright (c) The Lupaxa Project
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+License-File: LICENCE
+Keywords: chat,server,tcp
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Communications :: Chat
+Requires-Python: >=3.10
+Requires-Dist: asyncssh>=2.14
+Requires-Dist: bcrypt>=4.0
+Requires-Dist: colorama>=0.4.6
+Requires-Dist: pyyaml>=6.0
+Provides-Extra: dev
+Requires-Dist: bump-my-version>=1.2.0; extra == 'dev'
+Requires-Dist: hatch>=1.12.0; extra == 'dev'
+Requires-Dist: mkdocs-material==9.7.7; extra == 'dev'
+Requires-Dist: mkdocs==1.6.1; extra == 'dev'
+Requires-Dist: mypy>=1.12.0; extra == 'dev'
+Requires-Dist: pip-audit>=2.7.0; extra == 'dev'
+Requires-Dist: pytest-cov>=5.0; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: ruff>=0.6.0; extra == 'dev'
+Provides-Extra: test
+Requires-Dist: pytest-cov>=5.0; extra == 'test'
+Requires-Dist: pytest>=8.0; extra == 'test'
+Description-Content-Type: text/markdown
+
+<p align="center">
+  <a href="https://github.com/lupaxa-after-hours">
+    <img src="https://raw.githubusercontent.com/the-lupaxa-project/brand-assets/master/logos/organisations/after-hours/readme-logo.png" alt="After Hours" />
+  </a>
+</p>
+
+<h1 align="center">Chat Server</h1>
+
+Time for a little nostalgia, from the 1980s through the 2000s. Those years were full of
+[talkers](https://en.wikipedia.org/wiki/Talker), [MUDs](https://en.wikipedia.org/wiki/Multi-user_dungeon) and
+[MUSHes](https://en.wikipedia.org/wiki/MUSH): real-time chat and games, all of it text, reached by telnet or a
+client made for the job. Most of them have long since left the internet, replaced by newer games and messaging.
+
+This server is a throwback to that. The days we grew up online and spent playing these games.
+
+It is a bare-bones chat system, and it works. Use it straight out of the box, or do what we used to do: tinker
+with it, customise it, add to it, and make it your own.
+
+A multi-room TCP chat server. Each player picks a name, starts in the
+room named by `start`, and talks to the other people in that room.
+
+## Install
+
+```bash
+pip install lupaxa-chat-server
+```
+
+Requires Python 3.10+. PyYAML, bcrypt, and AsyncSSH are the runtime
+dependencies.
+
+## Run
+
+The server will not start without a config file. There is no default path.
+From a checkout:
+
+```bash
+chat-server -c config/config.yml
+python -m lupaxa.chat_server -c config/config.yml
+```
+
+The files under `config/` are one example. After
+`pip install lupaxa-chat-server`, create the config, the rooms file, and
+the help file yourself.
+
+## Documentation
+
+The site source is in `mkdocs/`.
+
+- [Getting Started](mkdocs/getting-started.md) covers the config file and how to run.
+- [Connect](mkdocs/usage/index.md), [Players](mkdocs/usage/players.md), [Rooms](mkdocs/usage/rooms.md), and [Commands](mkdocs/usage/commands.md) are how a player uses it.
+- [Reference](mkdocs/reference.md) is the config keys, ranks, and public names.
+- [Examples](mkdocs/examples.md) is a short telnet session and the SSH command.
+
+<a href="https://github.com/the-lupaxa-project">
+    <img src="https://raw.githubusercontent.com/the-lupaxa-project/brand-assets/master/logos/components/footer-for-child-orgs.svg" alt="The Lupaxa Project Footer" width="100%" />
+</a>

lupaxa_chat_server-0.1.0/README.md

@@ -0,0 +1,56 @@
+<p align="center">
+  <a href="https://github.com/lupaxa-after-hours">
+    <img src="https://raw.githubusercontent.com/the-lupaxa-project/brand-assets/master/logos/organisations/after-hours/readme-logo.png" alt="After Hours" />
+  </a>
+</p>
+
+<h1 align="center">Chat Server</h1>
+
+Time for a little nostalgia, from the 1980s through the 2000s. Those years were full of
+[talkers](https://en.wikipedia.org/wiki/Talker), [MUDs](https://en.wikipedia.org/wiki/Multi-user_dungeon) and
+[MUSHes](https://en.wikipedia.org/wiki/MUSH): real-time chat and games, all of it text, reached by telnet or a
+client made for the job. Most of them have long since left the internet, replaced by newer games and messaging.
+
+This server is a throwback to that. The days we grew up online and spent playing these games.
+
+It is a bare-bones chat system, and it works. Use it straight out of the box, or do what we used to do: tinker
+with it, customise it, add to it, and make it your own.
+
+A multi-room TCP chat server. Each player picks a name, starts in the
+room named by `start`, and talks to the other people in that room.
+
+## Install
+
+```bash
+pip install lupaxa-chat-server
+```
+
+Requires Python 3.10+. PyYAML, bcrypt, and AsyncSSH are the runtime
+dependencies.
+
+## Run
+
+The server will not start without a config file. There is no default path.
+From a checkout:
+
+```bash
+chat-server -c config/config.yml
+python -m lupaxa.chat_server -c config/config.yml
+```
+
+The files under `config/` are one example. After
+`pip install lupaxa-chat-server`, create the config, the rooms file, and
+the help file yourself.
+
+## Documentation
+
+The site source is in `mkdocs/`.
+
+- [Getting Started](mkdocs/getting-started.md) covers the config file and how to run.
+- [Connect](mkdocs/usage/index.md), [Players](mkdocs/usage/players.md), [Rooms](mkdocs/usage/rooms.md), and [Commands](mkdocs/usage/commands.md) are how a player uses it.
+- [Reference](mkdocs/reference.md) is the config keys, ranks, and public names.
+- [Examples](mkdocs/examples.md) is a short telnet session and the SSH command.
+
+<a href="https://github.com/the-lupaxa-project">
+    <img src="https://raw.githubusercontent.com/the-lupaxa-project/brand-assets/master/logos/components/footer-for-child-orgs.svg" alt="The Lupaxa Project Footer" width="100%" />
+</a>

lupaxa_chat_server-0.1.0/docs/README.md

@@ -0,0 +1,23 @@
+<p align="center">
+    <a href="https://github.com/lupaxa-after-hours">
+        <img src="https://raw.githubusercontent.com/the-lupaxa-project/brand-assets/master/logos/organisations/after-hours/readme-logo.png" alt="Organisation Logo" />
+    </a>
+</p>
+
+<h1 align="center">Core Documentation</h1>
+
+The following documents define the standards that apply across **The Lupaxa Project**:
+
+| Document                              | Purpose                                                           |
+| :------------------------------------ | :---------------------------------------------------------------- |
+| [Code of Conduct](CODE_OF_CONDUCT.md) | Expected behaviour and reporting procedures.                      |
+| [How to Contribute](CONTRIBUTING.md)  | Development workflow, coding standards, and contribution process. |
+| [Governance](GOVERNANCE.md)           | Project governance, roles, and decision-making.                   |
+| [Maintainers](MAINTAINERS.md)         | Maintainer responsibilities and expectations.                     |
+| [Projects Overview](PROJECTS.md)      | Overview of organisations, repositories, and project structure.   |
+| [Security Policy](SECURITY.md)        | Responsible disclosure and secure development practices.          |
+| [Support Guide](SUPPORT.md)           | How to obtain help and support.                                   |
+
+<a href="https://github.com/the-lupaxa-project">
+    <img src="https://raw.githubusercontent.com/the-lupaxa-project/brand-assets/master/logos/components/footer-for-child-orgs.svg" alt="The Lupaxa Project Footer" width="100%" />
+</a>

lupaxa_chat_server-0.1.0/pyproject.toml

@@ -0,0 +1,117 @@
+[build-system]
+requires = ["hatchling>=1.18"]
+build-backend = "hatchling.build"
+
+[project]
+name = "lupaxa-chat-server"
+dynamic = ["version"]
+description = "Multi-room TCP chat server."
+readme = "README.md"
+license = { file = "LICENCE" }
+requires-python = ">=3.10"
+dependencies = [
+  "asyncssh>=2.14",
+  "bcrypt>=4.0",
+  "colorama>=0.4.6",
+  "pyyaml>=6.0",
+]
+
+authors = [
+  { name = "The Lupaxa Project" }
+]
+
+keywords = ["chat", "tcp", "server"]
+
+classifiers = [
+  "Development Status :: 3 - Alpha",
+  "Environment :: Console",
+  "Intended Audience :: Developers",
+  "License :: OSI Approved :: MIT License",
+  "Operating System :: OS Independent",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "Programming Language :: Python :: 3.14",
+  "Topic :: Communications :: Chat",
+]
+
+[project.urls]
+Homepage = "https://github.com/lupaxa-after-hours/chat-server"
+Documentation = "https://chat-server.thelupaxaproject.org/"
+Repository = "https://github.com/lupaxa-after-hours/chat-server"
+Issues = "https://github.com/lupaxa-after-hours/chat-server/issues"
+
+[project.scripts]
+chat-server = "lupaxa.chat_server.cli:main"
+
+[project.optional-dependencies]
+dev = [
+  "pytest>=8.0",
+  "pytest-cov>=5.0",
+  "ruff>=0.6.0",
+  "mypy>=1.12.0",
+  "hatch>=1.12.0",
+  "bump-my-version>=1.2.0",
+  "pip-audit>=2.7.0",
+  "mkdocs==1.6.1",
+  "mkdocs-material==9.7.7",
+]
+test = [
+  "pytest>=8.0",
+  "pytest-cov>=5.0",
+]
+
+[tool.hatch.version]
+path = "src/lupaxa/chat_server/version.py"
+
+[tool.hatch.build.targets.sdist]
+include = [
+  "src/**",
+  "README.md",
+  "LICENCE",
+]
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/lupaxa"]
+
+[tool.ruff]
+line-length = 100
+target-version = "py310"
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "B", "S", "UP", "SIM", "C4", "ISC", "D", "ANN", "PT"]
+ignore = [
+  "D200", "D201", "D202", "D203", "D204", "D205", "D206", "D207",
+  "D208", "D209", "D210", "D211", "D212",
+]
+
+[tool.ruff.lint.per-file-ignores]
+"tests/**/*.py" = ["S101", "ANN001", "ANN201"]
+"src/lupaxa/chat_server/server.py" = ["S104"]
+
+[tool.ruff.lint.pydocstyle]
+convention = "numpy"
+
+[tool.ruff.format]
+quote-style = "double"
+
+[tool.pyright]
+typeCheckingMode = "standard"
+enableTypeIgnoreComments = true
+pythonVersion = "3.10"
+
+[tool.mypy]
+python_version = "3.10"
+files = ["src", "tests"]
+mypy_path = "src"
+explicit_package_bases = true
+namespace_packages = true
+warn_unused_configs = true
+ignore_missing_imports = true
+
+[tool.pytest.ini_options]
+addopts = "-ra -q --disable-warnings"
+testpaths = ["tests"]
+pythonpath = ["src"]

lupaxa_chat_server-0.1.0/src/lupaxa/chat_server/__init__.py

@@ -0,0 +1,7 @@
+"""Multi-room TCP chat server."""
+
+from __future__ import annotations
+
+from .version import __version__, get_version
+
+__all__ = ["__version__", "get_version"]

lupaxa_chat_server-0.1.0/src/lupaxa/chat_server/__main__.py

@@ -0,0 +1,8 @@
+"""Allow ``python -m lupaxa.chat_server`` to run the CLI."""
+
+from __future__ import annotations
+
+from .cli import main
+
+if __name__ == "__main__":
+    raise SystemExit(main())

lupaxa_chat_server-0.1.0/src/lupaxa/chat_server/admin.py

@@ -0,0 +1,291 @@
+"""Commands only the admin can use."""
+
+from __future__ import annotations
+
+from dataclasses import replace
+
+from .channel import broadcast_admin, broadcast_all, broadcast_staff, paint_admin, player_named
+from .client import Client
+from .colour import red
+from .commands_list import COMMANDS, Command, Host
+from .exceptions import ConfigError
+from .globals import CANNOT_NOW
+from .saved_player import (
+    RANK_ADMIN,
+    RANK_RESIDENT,
+    RANK_SUPER,
+    SavedPlayer,
+    rank_label,
+    save_player,
+)
+from .timer import shutdown_phrase
+from .utilities import (
+    _is_admin,
+    _lookup,
+    _name_of,
+    center_block,
+    frame_width,
+    refuses_self,
+)
+
+
+def command_au(host: Host, client: Client, command: Command, text: str | None) -> None:
+    """Speak on the admin channel."""
+    del command
+    _admin_line(host, client, f"You say '{text}'", f"{_name_of(client)} says '{text}'")
+
+
+def command_ae(host: Host, client: Client, command: Command, text: str | None) -> None:
+    """Emote on the admin channel."""
+    del command
+    _admin_line(host, client, f"You emote: {text}", f"{_name_of(client)} {text}")
+
+
+def command_at(host: Host, client: Client, command: Command, text: str | None) -> None:
+    """Think on the admin channel."""
+    del command
+    _admin_line(
+        host,
+        client,
+        f"You think . o O ( {text} )",
+        f"{_name_of(client)} thinks . o O ( {text} )",
+    )
+
+
+def _admin_line(host: Host, client: Client, mine: str, theirs: str) -> None:
+    """Send the sender ``mine`` and the rest of the admins ``theirs``."""
+    if not host.send(client, paint_admin(client, f"[ Admin ] {mine}\n")):
+        return
+    broadcast_admin(host, f"[ Admin ] {theirs}\n", skip=client)
+
+
+def command_allow(host: Host, client: Client, command: Command, text: str | None) -> None:
+    """Open or close newbies or residents. The config file stays as it was."""
+    del command
+    parts = (text or "").strip().split()
+    if len(parts) != 2 or parts[0] not in ("newbies", "residents"):
+        host.send(client, "Syntax: allow newbies|residents on|off\n")
+        return
+    if parts[1] not in ("on", "off"):
+        host.send(client, "Syntax: allow newbies|residents on|off\n")
+        return
+    opened = parts[1] == "on"
+    if parts[0] == "newbies":
+        host._allow_newbies = opened
+    else:
+        host._allow_residents = opened
+    verb = "opens" if opened else "closes"
+    who = _name_of(client)
+    broadcast_staff(host, f"< SU > {who} {verb} the talker to {parts[0]}.\n")
+
+
+def command_broadcast(host: Host, client: Client, command: Command, text: str | None) -> None:
+    """Send a centred broadcast message to every player who is in a room."""
+    del command
+    message = (text or "").strip()
+    if message == "":
+        host.send(client, "Syntax: broadcast <message>\n")
+        return
+    plain = f"-=> Broadcast Messages from {client.name}: {message} <=-"
+    for person in list(host._clients.values()):
+        if person.name is None or person.room is None:
+            continue
+        shown = red(plain) if person.player is not None and person.player.colour else plain
+        width = frame_width(person.discovered_columns, person.frame_columns)
+        padded = center_block(shown + "\n", width).removesuffix("\n")
+        host.send(person, f"\n\n\n{padded}\n\n\n\n")
+
+
+def command_promote(host: Host, client: Client, command: Command, text: str | None) -> None:
+    """Make a saved resident a super user, or a super user an admin.
+
+    Any admin may promote to super user. Only the config admin may promote to admin.
+    The name must match in full.
+    """
+    del command
+    name = (text or "").strip()
+    if refuses_self(host, client, name):
+        return
+    if _is_admin(host, name):
+        host.send(client, f"{name} is the admin.\n")
+        return
+    found, saved = _lookup(host, client, name)
+    if not found:
+        return
+    if saved is None:
+        refusal = (
+            f"Player {name} not found.\n"
+            if player_named(host._clients.values(), name) is None
+            else f"{name} is not a resident.\n"
+        )
+        host.send(client, refusal)
+        return
+    if saved.rank == RANK_SUPER:
+        if not _is_admin(host, _name_of(client)):
+            host.send(
+                client,
+                f"Only the admin can promote {saved.name} to {rank_label(RANK_ADMIN)}.\n",
+            )
+            return
+        if _set_rank(host, client, saved, RANK_ADMIN):
+            label = rank_label(RANK_ADMIN)
+            broadcast_admin(
+                host,
+                f"[ Admin ] {_name_of(client)} promotes {saved.name} to {label}.\n",
+            )
+        return
+    if saved.rank == RANK_ADMIN:
+        host.send(client, f"{saved.name} is already an admin.\n")
+        return
+    if saved.rank != RANK_RESIDENT:
+        host.send(client, f"{name} is not a resident.\n")
+        return
+    if _set_rank(host, client, saved, RANK_SUPER):
+        broadcast_staff(
+            host,
+            f"< SU > {_name_of(client)} promotes {saved.name} to {rank_label(RANK_SUPER)}.\n",
+        )
+
+
+def command_demote(host: Host, client: Client, command: Command, text: str | None) -> None:
+    """Move an admin or super user down one rank. ``force`` drops them to resident.
+
+    Any admin may demote a super user. Only the config admin may demote an admin.
+    """
+    parsed = _demote_args(text)
+    if parsed is None:
+        host.send(client, f"Syntax: {command.syntax}\n")
+        return
+    name, force = parsed
+    if refuses_self(host, client, name):
+        return
+    if _is_admin(host, name):
+        host.send(client, "The admin cannot be demoted.\n")
+        return
+    found, saved = _lookup(host, client, name)
+    if not found:
+        return
+    connected = player_named(host._clients.values(), name)
+    if saved is None and connected is None:
+        host.send(client, f"Player {name} not found.\n")
+        return
+    if saved is None or saved.rank not in (RANK_SUPER, RANK_ADMIN):
+        if saved is not None and saved.rank == RANK_RESIDENT:
+            host.send(client, f"{saved.name} is a resident.\n")
+            return
+        shown = connected.player.name if connected is not None and connected.player else name
+        host.send(client, f"{shown} cannot be demoted.\n")
+        return
+    if saved.rank == RANK_ADMIN and not _is_admin(host, _name_of(client)):
+        host.send(
+            client,
+            f"Only the admin can demote {saved.name} from {rank_label(RANK_ADMIN)}.\n",
+        )
+        return
+    if saved.rank == RANK_ADMIN and not force:
+        if _set_rank(host, client, saved, RANK_SUPER):
+            label = rank_label(RANK_ADMIN)
+            broadcast_admin(
+                host,
+                f"[ Admin ] {_name_of(client)} demotes {saved.name} from {label}.\n",
+            )
+        return
+    if not _set_rank(host, client, saved, RANK_RESIDENT):
+        return
+    if saved.rank == RANK_ADMIN:
+        line = f"{_name_of(client)} demotes {saved.name} from {rank_label(RANK_ADMIN)}.\n"
+        broadcast_admin(host, f"[ Admin ] {line}")
+        broadcast_staff(host, f"< SU > {line}")
+        return
+    broadcast_staff(
+        host,
+        f"< SU > {_name_of(client)} demotes {saved.name} from {rank_label(RANK_SUPER)}.\n",
+    )
+
+
+def _demote_args(text: str | None) -> tuple[str, bool] | None:
+    """Return the name and whether ``force`` was set, or ``None`` when the words are wrong."""
+    parts = (text or "").strip().split()
+    if len(parts) == 1:
+        return parts[0], False
+    if len(parts) == 2 and parts[1].lower() == "force":
+        return parts[0], True
+    return None
+
+
+def command_shutdown(host: Host, client: Client, command: Command, text: str | None) -> None:
+    """Start, replace, cancel, or finish the one server countdown."""
+    parts = (text or "").strip().split(None, 1)
+    if len(parts) < 2 or parts[1].strip() == "":
+        host.send(client, f"Syntax: {command.syntax}\n")
+        return
+    word, reason = parts[0], parts[1].strip()
+    if word == "now":
+        host._shutdown_seconds = None
+        host._shutdown_reason = ""
+        broadcast_all(host, f"Shutting down now for '{reason}'.\n", skip=None)
+        host.shutdown()
+        return
+    if word == "cancel":
+        if host._shutdown_seconds is None:
+            host.send(client, "No shutdown is running.\n")
+            return
+        host._shutdown_seconds = None
+        host._shutdown_reason = ""
+        broadcast_all(host, f"Shutdown cancelled for '{reason}'.\n", skip=None)
+        return
+    if not word.isascii() or not word.isdigit() or int(word) < 1:
+        host.send(client, f"Syntax: {command.syntax}\n")
+        return
+    seconds = int(word)
+    host._shutdown_seconds = seconds
+    host._shutdown_reason = reason
+    broadcast_all(host, shutdown_phrase(seconds, reason), skip=None)
+    if seconds == 1:
+        broadcast_all(host, "Shutting down now!\n", skip=None)
+
+
+def _set_rank(host: Host, client: Client, saved: SavedPlayer, rank: str) -> bool:
+    """Write ``rank`` to the file of ``saved`` and to the live user, when connected."""
+    try:
+        save_player(host._roster_dir, replace(saved, rank=rank))
+    except (ConfigError, OSError) as exc:
+        print(exc)
+        host.send(client, CANNOT_NOW)
+        return False
+    target = player_named(host._clients.values(), saved.name)
+    if target is not None and target.player is not None:
+        target.player.rank = rank
+    return True
+
+
+COMMANDS.extend(
+    (
+        Command(
+            "allow",
+            command_allow,
+            False,
+            "allow newbies|residents on|off",
+            rank=RANK_ADMIN,
+        ),
+        Command("broadcast", command_broadcast, False, "broadcast <message>", rank=RANK_ADMIN),
+        Command("promote", command_promote, False, "promote <name>", rank=RANK_ADMIN),
+        Command(
+            "demote",
+            command_demote,
+            False,
+            "demote <name>|demote <name> force",
+            rank=RANK_ADMIN,
+        ),
+        Command("ae", command_ae, False, "ae <message>", rank=RANK_ADMIN),
+        Command("at", command_at, False, "at <message>", rank=RANK_ADMIN),
+        Command("au", command_au, False, "au <message>", rank=RANK_ADMIN),
+        Command(
+            "shutdown",
+            command_shutdown,
+            False,
+            "shutdown <seconds> <reason>",
+            rank=RANK_ADMIN,
+        ),
+    )
+)