Files
tjhlp-gitea/scripts/src/tjhlp/commands/users.py
T
jkljkluiouio b8220a97c4 feat(users): 为用户创建命令添加随机密码生成和凭据导出功能
- 将初始密码从固定用户名改为随机生成
- 添加 CredentialRecord 数据结构记录创建结果
- 实现凭据 CSV 自动导出功能
- 更新相关文档说明
2026-04-29 13:44:00 +08:00

268 lines
9.2 KiB
Python

"""users 命令: 用户管理(批量创建/列出/删除)"""
import csv
import secrets
import string
from dataclasses import dataclass
from datetime import datetime
from pathlib import Path
import typer
from rich.console import Console
from rich.table import Table
from tjhlp.client import GiteaClient, GiteaClientError
from tjhlp.config import get_gitea_config
from tjhlp.models import MemberRecord, MemberRole
app = typer.Typer(no_args_is_help=True)
console = Console()
@dataclass
class CredentialRecord:
id: str
name: str
role: str
email: str
status: str
password: str
message: str
def _read_members_csv(filepath: Path) -> list[MemberRecord]:
"""读取 members CSV 文件"""
records: list[MemberRecord] = []
with open(filepath, encoding="utf-8-sig") as f:
reader = csv.DictReader(f)
for row in reader:
records.append(MemberRecord.model_validate(row))
return records
def _generate_password(length: int = 12) -> str:
"""
生成随机密码 \\
仅包含字母和数字
"""
alphabet = string.ascii_letters + string.digits
return "".join(secrets.choice(alphabet) for _ in range(length))
def _write_credentials_csv(records: list[CredentialRecord]) -> Path:
output_path = Path(f"credentials_{datetime.now():%Y%m%d_%H%M%S}.csv")
with output_path.open("w", encoding="utf-8-sig", newline="") as f:
writer = csv.DictWriter(
f,
fieldnames=["id", "name", "role", "email", "status", "password", "message"],
)
writer.writeheader()
for record in records:
writer.writerow(
{
"id": record.id,
"name": record.name,
"role": record.role,
"email": record.email,
"status": record.status,
"password": record.password,
"message": record.message,
}
)
return output_path
@app.command("create")
def create_users(
file: Path = typer.Option(..., "--file", "-f", help="成员名单 CSV 文件路径"),
org: str = typer.Option("", "--org", help="自动添加到指定组织的对应团队"),
dry_run: bool = typer.Option(False, "--dry-run", help="仅预览, 不实际创建"),
) -> None:
"""从 CSV 批量创建用户账号(随机初始密码, 自动导出凭据 CSV)"""
if not file.exists():
console.print(f"[red]文件不存在: {file}[/red]")
raise typer.Exit(code=1)
cfg = get_gitea_config()
members = _read_members_csv(file)
console.print(
f"读取到 {len(members)} 条记录 "
f"(学生: {sum(1 for m in members if m.role == MemberRole.STUDENT)}, "
f"助教: {sum(1 for m in members if m.role == MemberRole.TA)})"
)
if dry_run:
table = Table(title="预览(dry-run)")
table.add_column("ID")
table.add_column("姓名")
table.add_column("角色")
table.add_column("邮箱")
for m in members:
table.add_row(m.id, m.name, m.role, m.email)
console.print(table)
return
stats = {"created": 0, "skipped": 0, "failed": 0}
# 用于记录创建结果
credential_records: list[CredentialRecord] = []
with GiteaClient(cfg) as client:
# 获取团队 ID(如果指定了组织)
ta_team = None
students_team = None
if org:
ta_team = client.get_team_by_name(org, "ta")
students_team = client.get_team_by_name(org, "students")
for member in members:
# 检查用户是否已存在,仅校验用户名是否存在
existing = client.get_user(member.username)
if existing:
console.print(f" [yellow]跳过[/yellow] {member.username}({member.name})- 已存在")
stats["skipped"] += 1
credential_records.append(
CredentialRecord(
id=member.id,
name=member.name,
role=member.role,
email=member.email,
status="skipped",
password="",
message="user already exists",
)
)
continue
try:
password = _generate_password()
client.create_user(
username=member.username,
password=password,
email=member.email,
full_name=member.name,
must_change_password=True,
)
console.print(f" [green]创建[/green] {member.username}({member.name})")
stats["created"] += 1
message = "created"
# 添加到团队
if org:
team = ta_team if member.role == MemberRole.TA else students_team
if team:
try:
client.add_team_member(team.id, member.username)
except GiteaClientError as e:
console.print(f" [yellow]添加到团队失败: {e.message}[/yellow]")
message = f"created; team assignment failed: {e.message}"
credential_records.append(
CredentialRecord(
id=member.id,
name=member.name,
role=member.role,
email=member.email,
status="created",
password=password,
message=message,
)
)
except GiteaClientError as e:
console.print(f" [red]失败[/red] {member.username}({member.name}): {e.message}")
stats["failed"] += 1
credential_records.append(
CredentialRecord(
id=member.id,
name=member.name,
role=member.role,
email=member.email,
status="failed",
password="",
message=e.message,
)
)
try:
output_path = _write_credentials_csv(credential_records)
except OSError as e:
console.print(f"[red]凭据导出失败: {e}[/red]")
console.print("[yellow]用户创建结果可能已部分生效, 请先检查 Gitea 中的实际状态, 不要直接重试整批导入。[/yellow]")
raise typer.Exit(code=1) from e
console.print(
f"\n完成: 创建 {stats['created']}, 跳过 {stats['skipped']}, 失败 {stats['failed']}"
)
console.print(f"凭据已导出: {output_path}")
@app.command("list")
def list_users() -> None:
"""列出 Gitea 上的所有用户"""
cfg = get_gitea_config()
with GiteaClient(cfg) as client:
users = client.list_users()
table = Table(title=f"用户列表(共 {len(users)} 个)")
table.add_column("ID", style="dim")
table.add_column("用户名")
table.add_column("姓名")
table.add_column("邮箱")
table.add_column("管理员")
table.add_column("活跃")
for u in users:
table.add_row(
str(u.id),
u.login,
u.full_name,
u.email,
"[green]是[/green]" if u.is_admin else "",
"[green]是[/green]" if u.active else "[red]否[/red]",
)
console.print(table)
@app.command("delete")
def delete_users(
file: Path = typer.Option(..., "--file", "-f", help="成员名单 CSV 文件路径"),
confirm: bool = typer.Option(False, "--yes", "-y", help="跳过确认提示"),
) -> None:
"""根据 CSV 名单批量删除用户(危险操作)"""
if not file.exists():
console.print(f"[red]文件不存在: {file}[/red]")
raise typer.Exit(code=1)
members = _read_members_csv(file)
console.print(f"[red bold]即将删除 {len(members)} 个用户![/red bold]")
if not confirm:
typer.confirm("确认删除?此操作不可恢复", abort=True)
cfg = get_gitea_config()
stats = {"deleted": 0, "skipped": 0, "failed": 0}
with GiteaClient(cfg) as client:
for member in members:
existing = client.get_user(member.username)
if not existing:
console.print(f" [yellow]跳过[/yellow] {member.username} - 不存在")
stats["skipped"] += 1
continue
if existing.is_admin:
console.print(f" [yellow]跳过[/yellow] {member.username} - 管理员账号")
stats["skipped"] += 1
continue
try:
client.delete_user(member.username)
console.print(f" [red]已删除[/red] {member.username}({member.name})")
stats["deleted"] += 1
except GiteaClientError as e:
console.print(f" [red]失败[/red] {member.username}: {e.message}")
stats["failed"] += 1
console.print(
f"\n完成: 删除 {stats['deleted']}, 跳过 {stats['skipped']}, 失败 {stats['failed']}"
)