# SPDX-FileCopyrightText: 2026 Dennis Fink # # SPDX-License-Identifier: BSD-3-Clause """Provide commands for managing application user accounts.""" import click import sqlalchemy as sa from flask.cli import AppGroup from sqlalchemy.exc import IntegrityError from .. import DATABASE USERS_CLI = AppGroup("users", help="Manage users.") def _require_user(username: str): """Return a user by username or report a CLI-friendly error.""" from ..models import User user = DATABASE.session.scalar(sa.select(User).where(User.username == username)) if user is None: raise click.ClickException(f"User {username!r} does not exist.") return user @USERS_CLI.command("create", help="Create a user.") @click.option("--username", prompt="Username", help="Username for the new user.") @click.password_option(confirmation_prompt=True) def create_user(username: str, password: str) -> None: """ Create a user with a securely hashed password. :param username: Username for the new user. :param password: Plain-text password to hash and store. :raises click.ClickException: If the credentials are invalid or the user exists. """ from ..models import User username = username.strip() if not username: raise click.ClickException("Username must not be empty.") if not password: raise click.ClickException("Password must not be empty.") if DATABASE.session.scalar(sa.select(User).where(User.username == username)): raise click.ClickException(f"User {username!r} already exists.") DATABASE.session.add(User(username=username, password=password)) try: DATABASE.session.commit() except IntegrityError as exc: DATABASE.session.rollback() raise click.ClickException(f"User {username!r} already exists.") from exc click.echo(f"Created user {username!r}.") @USERS_CLI.command("list", help="List registered users.") def list_users() -> None: """List user IDs and usernames in alphabetical order.""" from ..models import User users = DATABASE.session.scalars(sa.select(User).order_by(User.username)).all() if not users: click.echo("No users found.") return click.echo("ID\tUSERNAME") for user in users: click.echo(f"{user.id}\t{user.username}") @USERS_CLI.command("set-password", help="Reset a user's password.") @click.argument("username") @click.password_option(confirmation_prompt=True) def set_user_password(username: str, password: str) -> None: """ Change a user's password without displaying it. :param username: Username of the account to update. :param password: New plain-text password to hash and store. :raises click.ClickException: If the account is missing or the password is empty. """ if not password: raise click.ClickException("Password must not be empty.") user = _require_user(username) user.password = password DATABASE.session.commit() click.echo(f"Updated password for user {username!r}.") @USERS_CLI.command("delete", help="Delete a user.") @click.argument("username") @click.option("-y", "--yes", is_flag=True, help="Skip the deletion confirmation.") def delete_user(username: str, yes: bool) -> None: """ Permanently delete a user after confirmation, unless --yes is passed. :param username: Username of the account to remove. :param yes: Whether to skip the confirmation prompt. :raises click.ClickException: If the account does not exist. """ user = _require_user(username) if not yes: click.confirm(f"Delete user {username!r}?", abort=True) DATABASE.session.delete(user) DATABASE.session.commit() click.echo(f"Deleted user {username!r}.")